4 * Copyright (C) 2007 Davide Libenzi <davidel@xmailserver.org>
8 #include <linux/file.h>
9 #include <linux/poll.h>
10 #include <linux/init.h>
12 #include <linux/sched/signal.h>
13 #include <linux/kernel.h>
14 #include <linux/slab.h>
15 #include <linux/list.h>
16 #include <linux/spinlock.h>
17 #include <linux/anon_inodes.h>
18 #include <linux/syscalls.h>
19 #include <linux/export.h>
20 #include <linux/kref.h>
21 #include <linux/eventfd.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
25 DEFINE_PER_CPU(int, eventfd_wake_count
);
29 wait_queue_head_t wqh
;
31 * Every time that a write(2) is performed on an eventfd, the
32 * value of the __u64 being written is added to "count" and a
33 * wakeup is performed on "wqh". A read(2) will return the "count"
34 * value to userspace, and will reset "count" to zero. The kernel
35 * side eventfd_signal() also, adds to the "count" counter and
43 * eventfd_signal - Adds @n to the eventfd counter.
44 * @ctx: [in] Pointer to the eventfd context.
45 * @n: [in] Value of the counter to be added to the eventfd internal counter.
46 * The value cannot be negative.
48 * This function is supposed to be called by the kernel in paths that do not
49 * allow sleeping. In this function we allow the counter to reach the ULLONG_MAX
50 * value, and we signal this as overflow condition by returning a EPOLLERR
53 * Returns the amount by which the counter was incremented. This will be less
54 * than @n if the counter has overflowed.
56 __u64
eventfd_signal(struct eventfd_ctx
*ctx
, __u64 n
)
61 * Deadlock or stack overflow issues can happen if we recurse here
62 * through waitqueue wakeup handlers. If the caller users potentially
63 * nested waitqueues with custom wakeup handlers, then it should
64 * check eventfd_signal_count() before calling this function. If
65 * it returns true, the eventfd_signal() call should be deferred to a
68 if (WARN_ON_ONCE(this_cpu_read(eventfd_wake_count
)))
71 spin_lock_irqsave(&ctx
->wqh
.lock
, flags
);
72 this_cpu_inc(eventfd_wake_count
);
73 if (ULLONG_MAX
- ctx
->count
< n
)
74 n
= ULLONG_MAX
- ctx
->count
;
76 if (waitqueue_active(&ctx
->wqh
))
77 wake_up_locked_poll(&ctx
->wqh
, EPOLLIN
);
78 this_cpu_dec(eventfd_wake_count
);
79 spin_unlock_irqrestore(&ctx
->wqh
.lock
, flags
);
83 EXPORT_SYMBOL_GPL(eventfd_signal
);
85 static void eventfd_free_ctx(struct eventfd_ctx
*ctx
)
90 static void eventfd_free(struct kref
*kref
)
92 struct eventfd_ctx
*ctx
= container_of(kref
, struct eventfd_ctx
, kref
);
94 eventfd_free_ctx(ctx
);
98 * eventfd_ctx_put - Releases a reference to the internal eventfd context.
99 * @ctx: [in] Pointer to eventfd context.
101 * The eventfd context reference must have been previously acquired either
102 * with eventfd_ctx_fdget() or eventfd_ctx_fileget().
104 void eventfd_ctx_put(struct eventfd_ctx
*ctx
)
106 kref_put(&ctx
->kref
, eventfd_free
);
108 EXPORT_SYMBOL_GPL(eventfd_ctx_put
);
110 static int eventfd_release(struct inode
*inode
, struct file
*file
)
112 struct eventfd_ctx
*ctx
= file
->private_data
;
114 wake_up_poll(&ctx
->wqh
, EPOLLHUP
);
115 eventfd_ctx_put(ctx
);
119 static __poll_t
eventfd_poll(struct file
*file
, poll_table
*wait
)
121 struct eventfd_ctx
*ctx
= file
->private_data
;
125 poll_wait(file
, &ctx
->wqh
, wait
);
128 * All writes to ctx->count occur within ctx->wqh.lock. This read
129 * can be done outside ctx->wqh.lock because we know that poll_wait
130 * takes that lock (through add_wait_queue) if our caller will sleep.
132 * The read _can_ therefore seep into add_wait_queue's critical
133 * section, but cannot move above it! add_wait_queue's spin_lock acts
134 * as an acquire barrier and ensures that the read be ordered properly
135 * against the writes. The following CAN happen and is safe:
138 * ----------------- ------------
139 * lock ctx->wqh.lock (in poll_wait)
142 * unlock ctx->wqh.lock
145 * if (waitqueue_active)
146 * wake_up_locked_poll
147 * unlock ctx->qwh.lock
148 * eventfd_poll returns 0
150 * but the following, which would miss a wakeup, cannot happen:
153 * ----------------- ------------
154 * count = ctx->count (INVALID!)
157 * **waitqueue_active is false**
158 * **no wake_up_locked_poll!**
159 * unlock ctx->qwh.lock
160 * lock ctx->wqh.lock (in poll_wait)
162 * unlock ctx->wqh.lock
163 * eventfd_poll returns 0
165 count
= READ_ONCE(ctx
->count
);
169 if (count
== ULLONG_MAX
)
171 if (ULLONG_MAX
- 1 > count
)
177 static void eventfd_ctx_do_read(struct eventfd_ctx
*ctx
, __u64
*cnt
)
179 *cnt
= (ctx
->flags
& EFD_SEMAPHORE
) ? 1 : ctx
->count
;
184 * eventfd_ctx_remove_wait_queue - Read the current counter and removes wait queue.
185 * @ctx: [in] Pointer to eventfd context.
186 * @wait: [in] Wait queue to be removed.
187 * @cnt: [out] Pointer to the 64-bit counter value.
189 * Returns %0 if successful, or the following error codes:
191 * -EAGAIN : The operation would have blocked.
193 * This is used to atomically remove a wait queue entry from the eventfd wait
194 * queue head, and read/reset the counter value.
196 int eventfd_ctx_remove_wait_queue(struct eventfd_ctx
*ctx
, wait_queue_entry_t
*wait
,
201 spin_lock_irqsave(&ctx
->wqh
.lock
, flags
);
202 eventfd_ctx_do_read(ctx
, cnt
);
203 __remove_wait_queue(&ctx
->wqh
, wait
);
204 if (*cnt
!= 0 && waitqueue_active(&ctx
->wqh
))
205 wake_up_locked_poll(&ctx
->wqh
, EPOLLOUT
);
206 spin_unlock_irqrestore(&ctx
->wqh
.lock
, flags
);
208 return *cnt
!= 0 ? 0 : -EAGAIN
;
210 EXPORT_SYMBOL_GPL(eventfd_ctx_remove_wait_queue
);
212 static ssize_t
eventfd_read(struct file
*file
, char __user
*buf
, size_t count
,
215 struct eventfd_ctx
*ctx
= file
->private_data
;
218 DECLARE_WAITQUEUE(wait
, current
);
220 if (count
< sizeof(ucnt
))
223 spin_lock_irq(&ctx
->wqh
.lock
);
227 else if (!(file
->f_flags
& O_NONBLOCK
)) {
228 __add_wait_queue(&ctx
->wqh
, &wait
);
230 set_current_state(TASK_INTERRUPTIBLE
);
231 if (ctx
->count
> 0) {
235 if (signal_pending(current
)) {
239 spin_unlock_irq(&ctx
->wqh
.lock
);
241 spin_lock_irq(&ctx
->wqh
.lock
);
243 __remove_wait_queue(&ctx
->wqh
, &wait
);
244 __set_current_state(TASK_RUNNING
);
246 if (likely(res
> 0)) {
247 eventfd_ctx_do_read(ctx
, &ucnt
);
248 if (waitqueue_active(&ctx
->wqh
))
249 wake_up_locked_poll(&ctx
->wqh
, EPOLLOUT
);
251 spin_unlock_irq(&ctx
->wqh
.lock
);
253 if (res
> 0 && put_user(ucnt
, (__u64 __user
*)buf
))
259 static ssize_t
eventfd_write(struct file
*file
, const char __user
*buf
, size_t count
,
262 struct eventfd_ctx
*ctx
= file
->private_data
;
265 DECLARE_WAITQUEUE(wait
, current
);
267 if (count
< sizeof(ucnt
))
269 if (copy_from_user(&ucnt
, buf
, sizeof(ucnt
)))
271 if (ucnt
== ULLONG_MAX
)
273 spin_lock_irq(&ctx
->wqh
.lock
);
275 if (ULLONG_MAX
- ctx
->count
> ucnt
)
277 else if (!(file
->f_flags
& O_NONBLOCK
)) {
278 __add_wait_queue(&ctx
->wqh
, &wait
);
280 set_current_state(TASK_INTERRUPTIBLE
);
281 if (ULLONG_MAX
- ctx
->count
> ucnt
) {
285 if (signal_pending(current
)) {
289 spin_unlock_irq(&ctx
->wqh
.lock
);
291 spin_lock_irq(&ctx
->wqh
.lock
);
293 __remove_wait_queue(&ctx
->wqh
, &wait
);
294 __set_current_state(TASK_RUNNING
);
296 if (likely(res
> 0)) {
298 if (waitqueue_active(&ctx
->wqh
))
299 wake_up_locked_poll(&ctx
->wqh
, EPOLLIN
);
301 spin_unlock_irq(&ctx
->wqh
.lock
);
306 #ifdef CONFIG_PROC_FS
307 static void eventfd_show_fdinfo(struct seq_file
*m
, struct file
*f
)
309 struct eventfd_ctx
*ctx
= f
->private_data
;
311 spin_lock_irq(&ctx
->wqh
.lock
);
312 seq_printf(m
, "eventfd-count: %16llx\n",
313 (unsigned long long)ctx
->count
);
314 spin_unlock_irq(&ctx
->wqh
.lock
);
318 static const struct file_operations eventfd_fops
= {
319 #ifdef CONFIG_PROC_FS
320 .show_fdinfo
= eventfd_show_fdinfo
,
322 .release
= eventfd_release
,
323 .poll
= eventfd_poll
,
324 .read
= eventfd_read
,
325 .write
= eventfd_write
,
326 .llseek
= noop_llseek
,
330 * eventfd_fget - Acquire a reference of an eventfd file descriptor.
331 * @fd: [in] Eventfd file descriptor.
333 * Returns a pointer to the eventfd file structure in case of success, or the
334 * following error pointer:
336 * -EBADF : Invalid @fd file descriptor.
337 * -EINVAL : The @fd file descriptor is not an eventfd file.
339 struct file
*eventfd_fget(int fd
)
345 return ERR_PTR(-EBADF
);
346 if (file
->f_op
!= &eventfd_fops
) {
348 return ERR_PTR(-EINVAL
);
353 EXPORT_SYMBOL_GPL(eventfd_fget
);
356 * eventfd_ctx_fdget - Acquires a reference to the internal eventfd context.
357 * @fd: [in] Eventfd file descriptor.
359 * Returns a pointer to the internal eventfd context, otherwise the error
360 * pointers returned by the following functions:
364 struct eventfd_ctx
*eventfd_ctx_fdget(int fd
)
366 struct eventfd_ctx
*ctx
;
367 struct fd f
= fdget(fd
);
369 return ERR_PTR(-EBADF
);
370 ctx
= eventfd_ctx_fileget(f
.file
);
374 EXPORT_SYMBOL_GPL(eventfd_ctx_fdget
);
377 * eventfd_ctx_fileget - Acquires a reference to the internal eventfd context.
378 * @file: [in] Eventfd file pointer.
380 * Returns a pointer to the internal eventfd context, otherwise the error
383 * -EINVAL : The @fd file descriptor is not an eventfd file.
385 struct eventfd_ctx
*eventfd_ctx_fileget(struct file
*file
)
387 struct eventfd_ctx
*ctx
;
389 if (file
->f_op
!= &eventfd_fops
)
390 return ERR_PTR(-EINVAL
);
392 ctx
= file
->private_data
;
393 kref_get(&ctx
->kref
);
396 EXPORT_SYMBOL_GPL(eventfd_ctx_fileget
);
398 static int do_eventfd(unsigned int count
, int flags
)
400 struct eventfd_ctx
*ctx
;
403 /* Check the EFD_* constants for consistency. */
404 BUILD_BUG_ON(EFD_CLOEXEC
!= O_CLOEXEC
);
405 BUILD_BUG_ON(EFD_NONBLOCK
!= O_NONBLOCK
);
407 if (flags
& ~EFD_FLAGS_SET
)
410 ctx
= kmalloc(sizeof(*ctx
), GFP_KERNEL
);
414 kref_init(&ctx
->kref
);
415 init_waitqueue_head(&ctx
->wqh
);
419 fd
= anon_inode_getfd("[eventfd]", &eventfd_fops
, ctx
,
420 O_RDWR
| (flags
& EFD_SHARED_FCNTL_FLAGS
));
422 eventfd_free_ctx(ctx
);
427 SYSCALL_DEFINE2(eventfd2
, unsigned int, count
, int, flags
)
429 return do_eventfd(count
, flags
);
432 SYSCALL_DEFINE1(eventfd
, unsigned int, count
)
434 return do_eventfd(count
, 0);