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