2 * This file contains the procedures for the handling of select and poll
4 * Created for Linux based loosely upon Mathius Lattner's minix
5 * patches by Peter MacDonald. Heavily edited by Linus.
8 * COFF/ELF binary emulation. If the process has the STICKY_TIMEOUTS
9 * flag set in its personality we do *not* modify the given timeout
10 * parameter to reflect time remaining.
13 * Changed sys_poll()/do_poll() to use PAGE_SIZE chunk-based allocation
14 * of fds to overcome nfds < 16390 descriptors limit (Tigran Aivazian).
17 #include <linux/kernel.h>
18 #include <linux/syscalls.h>
19 #include <linux/module.h>
20 #include <linux/slab.h>
21 #include <linux/poll.h>
22 #include <linux/personality.h> /* for STICKY_TIMEOUTS */
23 #include <linux/file.h>
24 #include <linux/fdtable.h>
26 #include <linux/rcupdate.h>
27 #include <linux/hrtimer.h>
29 #include <asm/uaccess.h>
33 * Estimate expected accuracy in ns from a timeval.
35 * After quite a bit of churning around, we've settled on
36 * a simple thing of taking 0.1% of the timeout as the
37 * slack, with a cap of 100 msec.
38 * "nice" tasks get a 0.5% slack instead.
40 * Consider this comment an open invitation to come up with even
44 static long __estimate_accuracy(struct timespec *tv)
49 if (task_nice(current) > 0)
50 divfactor = divfactor / 5;
52 slack = tv->tv_nsec / divfactor;
53 slack += tv->tv_sec * (NSEC_PER_SEC/divfactor);
55 if (slack > 100 * NSEC_PER_MSEC)
56 slack = 100 * NSEC_PER_MSEC;
63 static long estimate_accuracy(struct timespec *tv)
69 * Realtime tasks get a slack of 0 for obvious reasons.
76 now = timespec_sub(*tv, now);
77 ret = __estimate_accuracy(&now);
78 if (ret < current->timer_slack_ns)
79 return current->timer_slack_ns;
85 struct poll_table_page {
86 struct poll_table_page * next;
87 struct poll_table_entry * entry;
88 struct poll_table_entry entries[0];
91 #define POLL_TABLE_FULL(table) \
92 ((unsigned long)((table)->entry+1) > PAGE_SIZE + (unsigned long)(table))
95 * Ok, Peter made a complicated, but straightforward multiple_wait() function.
96 * I have rewritten this, taking some shortcuts: This code may not be easy to
97 * follow, but it should be free of race-conditions, and it's practical. If you
98 * understand what I'm doing here, then you understand how the linux
99 * sleep/wakeup mechanism works.
101 * Two very simple procedures, poll_wait() and poll_freewait() make all the
102 * work. poll_wait() is an inline-function defined in <linux/poll.h>,
103 * as all select/poll functions have to call it to add an entry to the
106 static void __pollwait(struct file *filp, wait_queue_head_t *wait_address,
109 void poll_initwait(struct poll_wqueues *pwq)
111 init_poll_funcptr(&pwq->pt, __pollwait);
112 pwq->polling_task = current;
115 pwq->inline_index = 0;
117 EXPORT_SYMBOL(poll_initwait);
119 static void free_poll_entry(struct poll_table_entry *entry)
121 remove_wait_queue(entry->wait_address, &entry->wait);
125 void poll_freewait(struct poll_wqueues *pwq)
127 struct poll_table_page * p = pwq->table;
129 for (i = 0; i < pwq->inline_index; i++)
130 free_poll_entry(pwq->inline_entries + i);
132 struct poll_table_entry * entry;
133 struct poll_table_page *old;
138 free_poll_entry(entry);
139 } while (entry > p->entries);
142 free_page((unsigned long) old);
145 EXPORT_SYMBOL(poll_freewait);
147 static struct poll_table_entry *poll_get_entry(struct poll_wqueues *p)
149 struct poll_table_page *table = p->table;
151 if (p->inline_index < N_INLINE_POLL_ENTRIES)
152 return p->inline_entries + p->inline_index++;
154 if (!table || POLL_TABLE_FULL(table)) {
155 struct poll_table_page *new_table;
157 new_table = (struct poll_table_page *) __get_free_page(GFP_KERNEL);
162 new_table->entry = new_table->entries;
163 new_table->next = table;
164 p->table = new_table;
168 return table->entry++;
171 static int __pollwake(wait_queue_t *wait, unsigned mode, int sync, void *key)
173 struct poll_wqueues *pwq = wait->private;
174 DECLARE_WAITQUEUE(dummy_wait, pwq->polling_task);
177 * Although this function is called under waitqueue lock, LOCK
178 * doesn't imply write barrier and the users expect write
179 * barrier semantics on wakeup functions. The following
180 * smp_wmb() is equivalent to smp_wmb() in try_to_wake_up()
181 * and is paired with set_mb() in poll_schedule_timeout.
187 * Perform the default wake up operation using a dummy
190 * TODO: This is hacky but there currently is no interface to
191 * pass in @sync. @sync is scheduled to be removed and once
192 * that happens, wake_up_process() can be used directly.
194 return default_wake_function(&dummy_wait, mode, sync, key);
197 static int pollwake(wait_queue_t *wait, unsigned mode, int sync, void *key)
199 struct poll_table_entry *entry;
201 entry = container_of(wait, struct poll_table_entry, wait);
202 if (key && !((unsigned long)key & entry->key))
204 return __pollwake(wait, mode, sync, key);
207 /* Add a new entry */
208 static void __pollwait(struct file *filp, wait_queue_head_t *wait_address,
211 struct poll_wqueues *pwq = container_of(p, struct poll_wqueues, pt);
212 struct poll_table_entry *entry = poll_get_entry(pwq);
217 entry->wait_address = wait_address;
219 init_waitqueue_func_entry(&entry->wait, pollwake);
220 entry->wait.private = pwq;
221 add_wait_queue(wait_address, &entry->wait);
224 int poll_schedule_timeout(struct poll_wqueues *pwq, int state,
225 ktime_t *expires, unsigned long slack)
229 set_current_state(state);
231 rc = schedule_hrtimeout_range(expires, slack, HRTIMER_MODE_ABS);
232 __set_current_state(TASK_RUNNING);
235 * Prepare for the next iteration.
237 * The following set_mb() serves two purposes. First, it's
238 * the counterpart rmb of the wmb in pollwake() such that data
239 * written before wake up is always visible after wake up.
240 * Second, the full barrier guarantees that triggered clearing
241 * doesn't pass event check of the next iteration. Note that
242 * this problem doesn't exist for the first iteration as
243 * add_wait_queue() has full barrier semantics.
245 set_mb(pwq->triggered, 0);
249 EXPORT_SYMBOL(poll_schedule_timeout);
252 * poll_select_set_timeout - helper function to setup the timeout value
253 * @to: pointer to timespec variable for the final timeout
254 * @sec: seconds (from user space)
255 * @nsec: nanoseconds (from user space)
257 * Note, we do not use a timespec for the user space value here, That
258 * way we can use the function for timeval and compat interfaces as well.
260 * Returns -EINVAL if sec/nsec are not normalized. Otherwise 0.
262 int poll_select_set_timeout(struct timespec *to, long sec, long nsec)
264 struct timespec ts = {.tv_sec = sec, .tv_nsec = nsec};
266 if (!timespec_valid(&ts))
269 /* Optimize for the zero timeout value here */
271 to->tv_sec = to->tv_nsec = 0;
274 *to = timespec_add_safe(*to, ts);
279 static int poll_select_copy_remaining(struct timespec *end_time, void __user *p,
280 int timeval, int ret)
288 if (current->personality & STICKY_TIMEOUTS)
291 /* No update for zero timeout */
292 if (!end_time->tv_sec && !end_time->tv_nsec)
296 rts = timespec_sub(*end_time, rts);
298 rts.tv_sec = rts.tv_nsec = 0;
301 rtv.tv_sec = rts.tv_sec;
302 rtv.tv_usec = rts.tv_nsec / NSEC_PER_USEC;
304 if (!copy_to_user(p, &rtv, sizeof(rtv)))
307 } else if (!copy_to_user(p, &rts, sizeof(rts)))
311 * If an application puts its timeval in read-only memory, we
312 * don't want the Linux-specific update to the timeval to
313 * cause a fault after the select has completed
314 * successfully. However, because we're not updating the
315 * timeval, we can't restart the system call.
319 if (ret == -ERESTARTNOHAND)
324 #define FDS_IN(fds, n) (fds->in + n)
325 #define FDS_OUT(fds, n) (fds->out + n)
326 #define FDS_EX(fds, n) (fds->ex + n)
328 #define BITS(fds, n) (*FDS_IN(fds, n)|*FDS_OUT(fds, n)|*FDS_EX(fds, n))
330 static int max_select_fd(unsigned long n, fd_set_bits *fds)
332 unsigned long *open_fds;
337 /* handle last in-complete long-word first */
338 set = ~(~0UL << (n & (__NFDBITS-1)));
340 fdt = files_fdtable(current->files);
341 open_fds = fdt->open_fds->fds_bits+n;
346 if (!(set & ~*open_fds))
357 if (set & ~*open_fds)
366 max += n * __NFDBITS;
372 #define POLLIN_SET (POLLRDNORM | POLLRDBAND | POLLIN | POLLHUP | POLLERR)
373 #define POLLOUT_SET (POLLWRBAND | POLLWRNORM | POLLOUT | POLLERR)
374 #define POLLEX_SET (POLLPRI)
376 static inline void wait_key_set(poll_table *wait, unsigned long in,
377 unsigned long out, unsigned long bit)
380 wait->key = POLLEX_SET;
382 wait->key |= POLLIN_SET;
384 wait->key |= POLLOUT_SET;
388 int do_select(int n, fd_set_bits *fds, struct timespec *end_time)
390 ktime_t expire, *to = NULL;
391 struct poll_wqueues table;
393 int retval, i, timed_out = 0;
394 unsigned long slack = 0;
397 retval = max_select_fd(n, fds);
404 poll_initwait(&table);
406 if (end_time && !end_time->tv_sec && !end_time->tv_nsec) {
411 if (end_time && !timed_out)
412 slack = estimate_accuracy(end_time);
416 unsigned long *rinp, *routp, *rexp, *inp, *outp, *exp;
418 inp = fds->in; outp = fds->out; exp = fds->ex;
419 rinp = fds->res_in; routp = fds->res_out; rexp = fds->res_ex;
421 for (i = 0; i < n; ++rinp, ++routp, ++rexp) {
422 unsigned long in, out, ex, all_bits, bit = 1, mask, j;
423 unsigned long res_in = 0, res_out = 0, res_ex = 0;
424 const struct file_operations *f_op = NULL;
425 struct file *file = NULL;
427 in = *inp++; out = *outp++; ex = *exp++;
428 all_bits = in | out | ex;
434 for (j = 0; j < __NFDBITS; ++j, ++i, bit <<= 1) {
438 if (!(bit & all_bits))
440 file = fget_light(i, &fput_needed);
443 mask = DEFAULT_POLLMASK;
444 if (f_op && f_op->poll) {
445 wait_key_set(wait, in, out, bit);
446 mask = (*f_op->poll)(file, wait);
448 fput_light(file, fput_needed);
449 if ((mask & POLLIN_SET) && (in & bit)) {
454 if ((mask & POLLOUT_SET) && (out & bit)) {
459 if ((mask & POLLEX_SET) && (ex & bit)) {
475 if (retval || timed_out || signal_pending(current))
478 retval = table.error;
483 * If this is the first loop and we have a timeout
484 * given, then we convert to ktime_t and set the to
485 * pointer to the expiry value.
487 if (end_time && !to) {
488 expire = timespec_to_ktime(*end_time);
492 if (!poll_schedule_timeout(&table, TASK_INTERRUPTIBLE,
497 poll_freewait(&table);
503 * We can actually return ERESTARTSYS instead of EINTR, but I'd
504 * like to be certain this leads to no problems. So I return
505 * EINTR just for safety.
507 * Update: ERESTARTSYS breaks at least the xview clock binary, so
508 * I'm trying ERESTARTNOHAND which restart only when you want to.
510 #define MAX_SELECT_SECONDS \
511 ((unsigned long) (MAX_SCHEDULE_TIMEOUT / HZ)-1)
513 int core_sys_select(int n, fd_set __user *inp, fd_set __user *outp,
514 fd_set __user *exp, struct timespec *end_time)
521 /* Allocate small arguments on the stack to save memory and be faster */
522 long stack_fds[SELECT_STACK_ALLOC/sizeof(long)];
528 /* max_fds can increase, so grab it once to avoid race */
530 fdt = files_fdtable(current->files);
531 max_fds = fdt->max_fds;
537 * We need 6 bitmaps (in/out/ex for both incoming and outgoing),
538 * since we used fdset we need to allocate memory in units of
543 if (size > sizeof(stack_fds) / 6) {
544 /* Not enough space in on-stack array; must use kmalloc */
546 bits = kmalloc(6 * size, GFP_KERNEL);
551 fds.out = bits + size;
552 fds.ex = bits + 2*size;
553 fds.res_in = bits + 3*size;
554 fds.res_out = bits + 4*size;
555 fds.res_ex = bits + 5*size;
557 if ((ret = get_fd_set(n, inp, fds.in)) ||
558 (ret = get_fd_set(n, outp, fds.out)) ||
559 (ret = get_fd_set(n, exp, fds.ex)))
561 zero_fd_set(n, fds.res_in);
562 zero_fd_set(n, fds.res_out);
563 zero_fd_set(n, fds.res_ex);
565 ret = do_select(n, &fds, end_time);
570 ret = -ERESTARTNOHAND;
571 if (signal_pending(current))
576 if (set_fd_set(n, inp, fds.res_in) ||
577 set_fd_set(n, outp, fds.res_out) ||
578 set_fd_set(n, exp, fds.res_ex))
582 if (bits != stack_fds)
588 SYSCALL_DEFINE5(select, int, n, fd_set __user *, inp, fd_set __user *, outp,
589 fd_set __user *, exp, struct timeval __user *, tvp)
591 struct timespec end_time, *to = NULL;
596 if (copy_from_user(&tv, tvp, sizeof(tv)))
600 if (poll_select_set_timeout(to,
601 tv.tv_sec + (tv.tv_usec / USEC_PER_SEC),
602 (tv.tv_usec % USEC_PER_SEC) * NSEC_PER_USEC))
606 ret = core_sys_select(n, inp, outp, exp, to);
607 ret = poll_select_copy_remaining(&end_time, tvp, 1, ret);
612 #ifdef HAVE_SET_RESTORE_SIGMASK
613 static long do_pselect(int n, fd_set __user *inp, fd_set __user *outp,
614 fd_set __user *exp, struct timespec __user *tsp,
615 const sigset_t __user *sigmask, size_t sigsetsize)
617 sigset_t ksigmask, sigsaved;
618 struct timespec ts, end_time, *to = NULL;
622 if (copy_from_user(&ts, tsp, sizeof(ts)))
626 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
631 /* XXX: Don't preclude handling different sized sigset_t's. */
632 if (sigsetsize != sizeof(sigset_t))
634 if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
637 sigdelsetmask(&ksigmask, sigmask(SIGKILL)|sigmask(SIGSTOP));
638 sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
641 ret = core_sys_select(n, inp, outp, exp, to);
642 ret = poll_select_copy_remaining(&end_time, tsp, 0, ret);
644 if (ret == -ERESTARTNOHAND) {
646 * Don't restore the signal mask yet. Let do_signal() deliver
647 * the signal on the way back to userspace, before the signal
651 memcpy(¤t->saved_sigmask, &sigsaved,
653 set_restore_sigmask();
656 sigprocmask(SIG_SETMASK, &sigsaved, NULL);
662 * Most architectures can't handle 7-argument syscalls. So we provide a
663 * 6-argument version where the sixth argument is a pointer to a structure
664 * which has a pointer to the sigset_t itself followed by a size_t containing
667 SYSCALL_DEFINE6(pselect6, int, n, fd_set __user *, inp, fd_set __user *, outp,
668 fd_set __user *, exp, struct timespec __user *, tsp,
671 size_t sigsetsize = 0;
672 sigset_t __user *up = NULL;
675 if (!access_ok(VERIFY_READ, sig, sizeof(void *)+sizeof(size_t))
676 || __get_user(up, (sigset_t __user * __user *)sig)
677 || __get_user(sigsetsize,
678 (size_t __user *)(sig+sizeof(void *))))
682 return do_pselect(n, inp, outp, exp, tsp, up, sigsetsize);
684 #endif /* HAVE_SET_RESTORE_SIGMASK */
687 struct poll_list *next;
689 struct pollfd entries[0];
692 #define POLLFD_PER_PAGE ((PAGE_SIZE-sizeof(struct poll_list)) / sizeof(struct pollfd))
695 * Fish for pollable events on the pollfd->fd file descriptor. We're only
696 * interested in events matching the pollfd->events mask, and the result
697 * matching that mask is both recorded in pollfd->revents and returned. The
698 * pwait poll_table will be used by the fd-provided poll handler for waiting,
701 static inline unsigned int do_pollfd(struct pollfd *pollfd, poll_table *pwait)
712 file = fget_light(fd, &fput_needed);
715 mask = DEFAULT_POLLMASK;
716 if (file->f_op && file->f_op->poll) {
718 pwait->key = pollfd->events |
720 mask = file->f_op->poll(file, pwait);
722 /* Mask out unneeded events. */
723 mask &= pollfd->events | POLLERR | POLLHUP;
724 fput_light(file, fput_needed);
727 pollfd->revents = mask;
732 static int do_poll(unsigned int nfds, struct poll_list *list,
733 struct poll_wqueues *wait, struct timespec *end_time)
735 poll_table* pt = &wait->pt;
736 ktime_t expire, *to = NULL;
737 int timed_out = 0, count = 0;
738 unsigned long slack = 0;
740 /* Optimise the no-wait case */
741 if (end_time && !end_time->tv_sec && !end_time->tv_nsec) {
746 if (end_time && !timed_out)
747 slack = estimate_accuracy(end_time);
750 struct poll_list *walk;
752 for (walk = list; walk != NULL; walk = walk->next) {
753 struct pollfd * pfd, * pfd_end;
756 pfd_end = pfd + walk->len;
757 for (; pfd != pfd_end; pfd++) {
759 * Fish for events. If we found one, record it
760 * and kill the poll_table, so we don't
761 * needlessly register any other waiters after
762 * this. They'll get immediately deregistered
763 * when we break out and return.
765 if (do_pollfd(pfd, pt)) {
772 * All waiters have already been registered, so don't provide
773 * a poll_table to them on the next loop iteration.
778 if (signal_pending(current))
781 if (count || timed_out)
785 * If this is the first loop and we have a timeout
786 * given, then we convert to ktime_t and set the to
787 * pointer to the expiry value.
789 if (end_time && !to) {
790 expire = timespec_to_ktime(*end_time);
794 if (!poll_schedule_timeout(wait, TASK_INTERRUPTIBLE, to, slack))
800 #define N_STACK_PPS ((sizeof(stack_pps) - sizeof(struct poll_list)) / \
801 sizeof(struct pollfd))
803 int do_sys_poll(struct pollfd __user *ufds, unsigned int nfds,
804 struct timespec *end_time)
806 struct poll_wqueues table;
807 int err = -EFAULT, fdcount, len, size;
808 /* Allocate small arguments on the stack to save memory and be
809 faster - use long to make sure the buffer is aligned properly
810 on 64 bit archs to avoid unaligned access */
811 long stack_pps[POLL_STACK_ALLOC/sizeof(long)];
812 struct poll_list *const head = (struct poll_list *)stack_pps;
813 struct poll_list *walk = head;
814 unsigned long todo = nfds;
816 if (nfds > current->signal->rlim[RLIMIT_NOFILE].rlim_cur)
819 len = min_t(unsigned int, nfds, N_STACK_PPS);
826 if (copy_from_user(walk->entries, ufds + nfds-todo,
827 sizeof(struct pollfd) * walk->len))
834 len = min(todo, POLLFD_PER_PAGE);
835 size = sizeof(struct poll_list) + sizeof(struct pollfd) * len;
836 walk = walk->next = kmalloc(size, GFP_KERNEL);
843 poll_initwait(&table);
844 fdcount = do_poll(nfds, head, &table, end_time);
845 poll_freewait(&table);
847 for (walk = head; walk; walk = walk->next) {
848 struct pollfd *fds = walk->entries;
851 for (j = 0; j < walk->len; j++, ufds++)
852 if (__put_user(fds[j].revents, &ufds->revents))
860 struct poll_list *pos = walk;
868 static long do_restart_poll(struct restart_block *restart_block)
870 struct pollfd __user *ufds = restart_block->poll.ufds;
871 int nfds = restart_block->poll.nfds;
872 struct timespec *to = NULL, end_time;
875 if (restart_block->poll.has_timeout) {
876 end_time.tv_sec = restart_block->poll.tv_sec;
877 end_time.tv_nsec = restart_block->poll.tv_nsec;
881 ret = do_sys_poll(ufds, nfds, to);
884 restart_block->fn = do_restart_poll;
885 ret = -ERESTART_RESTARTBLOCK;
890 SYSCALL_DEFINE3(poll, struct pollfd __user *, ufds, unsigned int, nfds,
893 struct timespec end_time, *to = NULL;
896 if (timeout_msecs >= 0) {
898 poll_select_set_timeout(to, timeout_msecs / MSEC_PER_SEC,
899 NSEC_PER_MSEC * (timeout_msecs % MSEC_PER_SEC));
902 ret = do_sys_poll(ufds, nfds, to);
905 struct restart_block *restart_block;
907 restart_block = ¤t_thread_info()->restart_block;
908 restart_block->fn = do_restart_poll;
909 restart_block->poll.ufds = ufds;
910 restart_block->poll.nfds = nfds;
912 if (timeout_msecs >= 0) {
913 restart_block->poll.tv_sec = end_time.tv_sec;
914 restart_block->poll.tv_nsec = end_time.tv_nsec;
915 restart_block->poll.has_timeout = 1;
917 restart_block->poll.has_timeout = 0;
919 ret = -ERESTART_RESTARTBLOCK;
924 #ifdef HAVE_SET_RESTORE_SIGMASK
925 SYSCALL_DEFINE5(ppoll, struct pollfd __user *, ufds, unsigned int, nfds,
926 struct timespec __user *, tsp, const sigset_t __user *, sigmask,
929 sigset_t ksigmask, sigsaved;
930 struct timespec ts, end_time, *to = NULL;
934 if (copy_from_user(&ts, tsp, sizeof(ts)))
938 if (poll_select_set_timeout(to, ts.tv_sec, ts.tv_nsec))
943 /* XXX: Don't preclude handling different sized sigset_t's. */
944 if (sigsetsize != sizeof(sigset_t))
946 if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
949 sigdelsetmask(&ksigmask, sigmask(SIGKILL)|sigmask(SIGSTOP));
950 sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
953 ret = do_sys_poll(ufds, nfds, to);
955 /* We can restart this syscall, usually */
958 * Don't restore the signal mask yet. Let do_signal() deliver
959 * the signal on the way back to userspace, before the signal
963 memcpy(¤t->saved_sigmask, &sigsaved,
965 set_restore_sigmask();
967 ret = -ERESTARTNOHAND;
969 sigprocmask(SIG_SETMASK, &sigsaved, NULL);
971 ret = poll_select_copy_remaining(&end_time, tsp, 0, ret);
975 #endif /* HAVE_SET_RESTORE_SIGMASK */