xref: /openbmc/linux/fs/eventfd.c (revision d4e82042)
1e1ad7468SDavide Libenzi /*
2e1ad7468SDavide Libenzi  *  fs/eventfd.c
3e1ad7468SDavide Libenzi  *
4e1ad7468SDavide Libenzi  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
5e1ad7468SDavide Libenzi  *
6e1ad7468SDavide Libenzi  */
7e1ad7468SDavide Libenzi 
8e1ad7468SDavide Libenzi #include <linux/file.h>
9e1ad7468SDavide Libenzi #include <linux/poll.h>
10e1ad7468SDavide Libenzi #include <linux/init.h>
11e1ad7468SDavide Libenzi #include <linux/fs.h>
12e1ad7468SDavide Libenzi #include <linux/sched.h>
13e1ad7468SDavide Libenzi #include <linux/kernel.h>
14e1ad7468SDavide Libenzi #include <linux/list.h>
15e1ad7468SDavide Libenzi #include <linux/spinlock.h>
16e1ad7468SDavide Libenzi #include <linux/anon_inodes.h>
17e1ad7468SDavide Libenzi #include <linux/eventfd.h>
187747cdb2SAdrian Bunk #include <linux/syscalls.h>
19e1ad7468SDavide Libenzi 
20e1ad7468SDavide Libenzi struct eventfd_ctx {
21e1ad7468SDavide Libenzi 	wait_queue_head_t wqh;
22e1ad7468SDavide Libenzi 	/*
23e1ad7468SDavide Libenzi 	 * Every time that a write(2) is performed on an eventfd, the
24e1ad7468SDavide Libenzi 	 * value of the __u64 being written is added to "count" and a
25e1ad7468SDavide Libenzi 	 * wakeup is performed on "wqh". A read(2) will return the "count"
26e1ad7468SDavide Libenzi 	 * value to userspace, and will reset "count" to zero. The kernel
27e1ad7468SDavide Libenzi 	 * size eventfd_signal() also, adds to the "count" counter and
28e1ad7468SDavide Libenzi 	 * issue a wakeup.
29e1ad7468SDavide Libenzi 	 */
30e1ad7468SDavide Libenzi 	__u64 count;
31e1ad7468SDavide Libenzi };
32e1ad7468SDavide Libenzi 
33e1ad7468SDavide Libenzi /*
34e1ad7468SDavide Libenzi  * Adds "n" to the eventfd counter "count". Returns "n" in case of
35e1ad7468SDavide Libenzi  * success, or a value lower then "n" in case of coutner overflow.
36e1ad7468SDavide Libenzi  * This function is supposed to be called by the kernel in paths
37e1ad7468SDavide Libenzi  * that do not allow sleeping. In this function we allow the counter
38e1ad7468SDavide Libenzi  * to reach the ULLONG_MAX value, and we signal this as overflow
39e1ad7468SDavide Libenzi  * condition by returining a POLLERR to poll(2).
40e1ad7468SDavide Libenzi  */
41e1ad7468SDavide Libenzi int eventfd_signal(struct file *file, int n)
42e1ad7468SDavide Libenzi {
43e1ad7468SDavide Libenzi 	struct eventfd_ctx *ctx = file->private_data;
44e1ad7468SDavide Libenzi 	unsigned long flags;
45e1ad7468SDavide Libenzi 
46e1ad7468SDavide Libenzi 	if (n < 0)
47e1ad7468SDavide Libenzi 		return -EINVAL;
48d48eb233SDavide Libenzi 	spin_lock_irqsave(&ctx->wqh.lock, flags);
49e1ad7468SDavide Libenzi 	if (ULLONG_MAX - ctx->count < n)
50e1ad7468SDavide Libenzi 		n = (int) (ULLONG_MAX - ctx->count);
51e1ad7468SDavide Libenzi 	ctx->count += n;
52e1ad7468SDavide Libenzi 	if (waitqueue_active(&ctx->wqh))
53e1ad7468SDavide Libenzi 		wake_up_locked(&ctx->wqh);
54d48eb233SDavide Libenzi 	spin_unlock_irqrestore(&ctx->wqh.lock, flags);
55e1ad7468SDavide Libenzi 
56e1ad7468SDavide Libenzi 	return n;
57e1ad7468SDavide Libenzi }
58e1ad7468SDavide Libenzi 
59e1ad7468SDavide Libenzi static int eventfd_release(struct inode *inode, struct file *file)
60e1ad7468SDavide Libenzi {
61e1ad7468SDavide Libenzi 	kfree(file->private_data);
62e1ad7468SDavide Libenzi 	return 0;
63e1ad7468SDavide Libenzi }
64e1ad7468SDavide Libenzi 
65e1ad7468SDavide Libenzi static unsigned int eventfd_poll(struct file *file, poll_table *wait)
66e1ad7468SDavide Libenzi {
67e1ad7468SDavide Libenzi 	struct eventfd_ctx *ctx = file->private_data;
68e1ad7468SDavide Libenzi 	unsigned int events = 0;
69e1ad7468SDavide Libenzi 	unsigned long flags;
70e1ad7468SDavide Libenzi 
71e1ad7468SDavide Libenzi 	poll_wait(file, &ctx->wqh, wait);
72e1ad7468SDavide Libenzi 
73d48eb233SDavide Libenzi 	spin_lock_irqsave(&ctx->wqh.lock, flags);
74e1ad7468SDavide Libenzi 	if (ctx->count > 0)
75e1ad7468SDavide Libenzi 		events |= POLLIN;
76e1ad7468SDavide Libenzi 	if (ctx->count == ULLONG_MAX)
77e1ad7468SDavide Libenzi 		events |= POLLERR;
78e1ad7468SDavide Libenzi 	if (ULLONG_MAX - 1 > ctx->count)
79e1ad7468SDavide Libenzi 		events |= POLLOUT;
80d48eb233SDavide Libenzi 	spin_unlock_irqrestore(&ctx->wqh.lock, flags);
81e1ad7468SDavide Libenzi 
82e1ad7468SDavide Libenzi 	return events;
83e1ad7468SDavide Libenzi }
84e1ad7468SDavide Libenzi 
85e1ad7468SDavide Libenzi static ssize_t eventfd_read(struct file *file, char __user *buf, size_t count,
86e1ad7468SDavide Libenzi 			    loff_t *ppos)
87e1ad7468SDavide Libenzi {
88e1ad7468SDavide Libenzi 	struct eventfd_ctx *ctx = file->private_data;
89e1ad7468SDavide Libenzi 	ssize_t res;
90e1ad7468SDavide Libenzi 	__u64 ucnt;
91e1ad7468SDavide Libenzi 	DECLARE_WAITQUEUE(wait, current);
92e1ad7468SDavide Libenzi 
93e1ad7468SDavide Libenzi 	if (count < sizeof(ucnt))
94e1ad7468SDavide Libenzi 		return -EINVAL;
95d48eb233SDavide Libenzi 	spin_lock_irq(&ctx->wqh.lock);
96e1ad7468SDavide Libenzi 	res = -EAGAIN;
97e1ad7468SDavide Libenzi 	ucnt = ctx->count;
98e1ad7468SDavide Libenzi 	if (ucnt > 0)
99e1ad7468SDavide Libenzi 		res = sizeof(ucnt);
100e1ad7468SDavide Libenzi 	else if (!(file->f_flags & O_NONBLOCK)) {
101e1ad7468SDavide Libenzi 		__add_wait_queue(&ctx->wqh, &wait);
102e1ad7468SDavide Libenzi 		for (res = 0;;) {
103e1ad7468SDavide Libenzi 			set_current_state(TASK_INTERRUPTIBLE);
104e1ad7468SDavide Libenzi 			if (ctx->count > 0) {
105e1ad7468SDavide Libenzi 				ucnt = ctx->count;
106e1ad7468SDavide Libenzi 				res = sizeof(ucnt);
107e1ad7468SDavide Libenzi 				break;
108e1ad7468SDavide Libenzi 			}
109e1ad7468SDavide Libenzi 			if (signal_pending(current)) {
110e1ad7468SDavide Libenzi 				res = -ERESTARTSYS;
111e1ad7468SDavide Libenzi 				break;
112e1ad7468SDavide Libenzi 			}
113d48eb233SDavide Libenzi 			spin_unlock_irq(&ctx->wqh.lock);
114e1ad7468SDavide Libenzi 			schedule();
115d48eb233SDavide Libenzi 			spin_lock_irq(&ctx->wqh.lock);
116e1ad7468SDavide Libenzi 		}
117e1ad7468SDavide Libenzi 		__remove_wait_queue(&ctx->wqh, &wait);
118e1ad7468SDavide Libenzi 		__set_current_state(TASK_RUNNING);
119e1ad7468SDavide Libenzi 	}
120e1ad7468SDavide Libenzi 	if (res > 0) {
121e1ad7468SDavide Libenzi 		ctx->count = 0;
122e1ad7468SDavide Libenzi 		if (waitqueue_active(&ctx->wqh))
123e1ad7468SDavide Libenzi 			wake_up_locked(&ctx->wqh);
124e1ad7468SDavide Libenzi 	}
125d48eb233SDavide Libenzi 	spin_unlock_irq(&ctx->wqh.lock);
126e1ad7468SDavide Libenzi 	if (res > 0 && put_user(ucnt, (__u64 __user *) buf))
127e1ad7468SDavide Libenzi 		return -EFAULT;
128e1ad7468SDavide Libenzi 
129e1ad7468SDavide Libenzi 	return res;
130e1ad7468SDavide Libenzi }
131e1ad7468SDavide Libenzi 
132e1ad7468SDavide Libenzi static ssize_t eventfd_write(struct file *file, const char __user *buf, size_t count,
133e1ad7468SDavide Libenzi 			     loff_t *ppos)
134e1ad7468SDavide Libenzi {
135e1ad7468SDavide Libenzi 	struct eventfd_ctx *ctx = file->private_data;
136e1ad7468SDavide Libenzi 	ssize_t res;
137e1ad7468SDavide Libenzi 	__u64 ucnt;
138e1ad7468SDavide Libenzi 	DECLARE_WAITQUEUE(wait, current);
139e1ad7468SDavide Libenzi 
140e1ad7468SDavide Libenzi 	if (count < sizeof(ucnt))
141e1ad7468SDavide Libenzi 		return -EINVAL;
142e1ad7468SDavide Libenzi 	if (copy_from_user(&ucnt, buf, sizeof(ucnt)))
143e1ad7468SDavide Libenzi 		return -EFAULT;
144e1ad7468SDavide Libenzi 	if (ucnt == ULLONG_MAX)
145e1ad7468SDavide Libenzi 		return -EINVAL;
146d48eb233SDavide Libenzi 	spin_lock_irq(&ctx->wqh.lock);
147e1ad7468SDavide Libenzi 	res = -EAGAIN;
148e1ad7468SDavide Libenzi 	if (ULLONG_MAX - ctx->count > ucnt)
149e1ad7468SDavide Libenzi 		res = sizeof(ucnt);
150e1ad7468SDavide Libenzi 	else if (!(file->f_flags & O_NONBLOCK)) {
151e1ad7468SDavide Libenzi 		__add_wait_queue(&ctx->wqh, &wait);
152e1ad7468SDavide Libenzi 		for (res = 0;;) {
153e1ad7468SDavide Libenzi 			set_current_state(TASK_INTERRUPTIBLE);
154e1ad7468SDavide Libenzi 			if (ULLONG_MAX - ctx->count > ucnt) {
155e1ad7468SDavide Libenzi 				res = sizeof(ucnt);
156e1ad7468SDavide Libenzi 				break;
157e1ad7468SDavide Libenzi 			}
158e1ad7468SDavide Libenzi 			if (signal_pending(current)) {
159e1ad7468SDavide Libenzi 				res = -ERESTARTSYS;
160e1ad7468SDavide Libenzi 				break;
161e1ad7468SDavide Libenzi 			}
162d48eb233SDavide Libenzi 			spin_unlock_irq(&ctx->wqh.lock);
163e1ad7468SDavide Libenzi 			schedule();
164d48eb233SDavide Libenzi 			spin_lock_irq(&ctx->wqh.lock);
165e1ad7468SDavide Libenzi 		}
166e1ad7468SDavide Libenzi 		__remove_wait_queue(&ctx->wqh, &wait);
167e1ad7468SDavide Libenzi 		__set_current_state(TASK_RUNNING);
168e1ad7468SDavide Libenzi 	}
169e1ad7468SDavide Libenzi 	if (res > 0) {
170e1ad7468SDavide Libenzi 		ctx->count += ucnt;
171e1ad7468SDavide Libenzi 		if (waitqueue_active(&ctx->wqh))
172e1ad7468SDavide Libenzi 			wake_up_locked(&ctx->wqh);
173e1ad7468SDavide Libenzi 	}
174d48eb233SDavide Libenzi 	spin_unlock_irq(&ctx->wqh.lock);
175e1ad7468SDavide Libenzi 
176e1ad7468SDavide Libenzi 	return res;
177e1ad7468SDavide Libenzi }
178e1ad7468SDavide Libenzi 
179e1ad7468SDavide Libenzi static const struct file_operations eventfd_fops = {
180e1ad7468SDavide Libenzi 	.release	= eventfd_release,
181e1ad7468SDavide Libenzi 	.poll		= eventfd_poll,
182e1ad7468SDavide Libenzi 	.read		= eventfd_read,
183e1ad7468SDavide Libenzi 	.write		= eventfd_write,
184e1ad7468SDavide Libenzi };
185e1ad7468SDavide Libenzi 
186e1ad7468SDavide Libenzi struct file *eventfd_fget(int fd)
187e1ad7468SDavide Libenzi {
188e1ad7468SDavide Libenzi 	struct file *file;
189e1ad7468SDavide Libenzi 
190e1ad7468SDavide Libenzi 	file = fget(fd);
191e1ad7468SDavide Libenzi 	if (!file)
192e1ad7468SDavide Libenzi 		return ERR_PTR(-EBADF);
193e1ad7468SDavide Libenzi 	if (file->f_op != &eventfd_fops) {
194e1ad7468SDavide Libenzi 		fput(file);
195e1ad7468SDavide Libenzi 		return ERR_PTR(-EINVAL);
196e1ad7468SDavide Libenzi 	}
197e1ad7468SDavide Libenzi 
198e1ad7468SDavide Libenzi 	return file;
199e1ad7468SDavide Libenzi }
200e1ad7468SDavide Libenzi 
201d4e82042SHeiko Carstens SYSCALL_DEFINE2(eventfd2, unsigned int, count, int, flags)
202e1ad7468SDavide Libenzi {
2032030a42cSAl Viro 	int fd;
204e1ad7468SDavide Libenzi 	struct eventfd_ctx *ctx;
205e1ad7468SDavide Libenzi 
206e38b36f3SUlrich Drepper 	/* Check the EFD_* constants for consistency.  */
207e38b36f3SUlrich Drepper 	BUILD_BUG_ON(EFD_CLOEXEC != O_CLOEXEC);
208e38b36f3SUlrich Drepper 	BUILD_BUG_ON(EFD_NONBLOCK != O_NONBLOCK);
209e38b36f3SUlrich Drepper 
210e7d476dfSUlrich Drepper 	if (flags & ~(EFD_CLOEXEC | EFD_NONBLOCK))
211b087498eSUlrich Drepper 		return -EINVAL;
212b087498eSUlrich Drepper 
213e1ad7468SDavide Libenzi 	ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
214e1ad7468SDavide Libenzi 	if (!ctx)
215e1ad7468SDavide Libenzi 		return -ENOMEM;
216e1ad7468SDavide Libenzi 
217e1ad7468SDavide Libenzi 	init_waitqueue_head(&ctx->wqh);
218e1ad7468SDavide Libenzi 	ctx->count = count;
219e1ad7468SDavide Libenzi 
220e1ad7468SDavide Libenzi 	/*
221e1ad7468SDavide Libenzi 	 * When we call this, the initialization must be complete, since
222e1ad7468SDavide Libenzi 	 * anon_inode_getfd() will install the fd.
223e1ad7468SDavide Libenzi 	 */
224b087498eSUlrich Drepper 	fd = anon_inode_getfd("[eventfd]", &eventfd_fops, ctx,
225e7d476dfSUlrich Drepper 			      flags & (O_CLOEXEC | O_NONBLOCK));
2262030a42cSAl Viro 	if (fd < 0)
227e1ad7468SDavide Libenzi 		kfree(ctx);
2282030a42cSAl Viro 	return fd;
229e1ad7468SDavide Libenzi }
230e1ad7468SDavide Libenzi 
231d4e82042SHeiko Carstens SYSCALL_DEFINE1(eventfd, unsigned int, count)
232b087498eSUlrich Drepper {
233b087498eSUlrich Drepper 	return sys_eventfd2(count, 0);
234b087498eSUlrich Drepper }
235