fs/eventfd.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  fs/eventfd.c
   4  *
   5  *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
   6  *
   7  */
   8
   9 #include <linux/file.h>
  10 #include <linux/poll.h>
  11 #include <linux/init.h>
  12 #include <linux/fs.h>
  13 #include <linux/sched/signal.h>
  14 #include <linux/kernel.h>
  15 #include <linux/slab.h>
  16 #include <linux/list.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/anon_inodes.h>
  19 #include <linux/syscalls.h>
  20 #include <linux/export.h>
  21 #include <linux/kref.h>
  22 #include <linux/eventfd.h>
  23 #include <linux/proc_fs.h>
  24 #include <linux/seq_file.h>
  25 #include <linux/idr.h>
  26 #include <linux/uio.h>
  27
  28 DEFINE_PER_CPU(int, eventfd_wake_count);
  29
  30 static DEFINE_IDA(eventfd_ida);
  31
  32 struct eventfd_ctx {
  33         struct kref kref;
  34         wait_queue_head_t wqh;
  35         /*
  36          * Every time that a write(2) is performed on an eventfd, the
  37          * value of the __u64 being written is added to "count" and a
  38          * wakeup is performed on "wqh". A read(2) will return the "count"
  39          * value to userspace, and will reset "count" to zero. The kernel
  40          * side eventfd_signal() also, adds to the "count" counter and
  41          * issue a wakeup.
  42          */
  43         __u64 count;
  44         unsigned int flags;
  45         int id;
  46 };
  47
  48 __u64 eventfd_signal_mask(struct eventfd_ctx *ctx, __u64 n, unsigned mask)
  49 {
  50         unsigned long flags;
  51
  52         /*
  53          * Deadlock or stack overflow issues can happen if we recurse here
  54          * through waitqueue wakeup handlers. If the caller users potentially
  55          * nested waitqueues with custom wakeup handlers, then it should
  56          * check eventfd_signal_count() before calling this function. If
  57          * it returns true, the eventfd_signal() call should be deferred to a
  58          * safe context.
  59          */
  60         if (WARN_ON_ONCE(this_cpu_read(eventfd_wake_count)))
  61                 return 0;
  62
  63         spin_lock_irqsave(&ctx->wqh.lock, flags);
  64         this_cpu_inc(eventfd_wake_count);
  65         if (ULLONG_MAX - ctx->count < n)
  66                 n = ULLONG_MAX - ctx->count;
  67         ctx->count += n;
  68         if (waitqueue_active(&ctx->wqh))
  69                 wake_up_locked_poll(&ctx->wqh, EPOLLIN | mask);
  70         this_cpu_dec(eventfd_wake_count);
  71         spin_unlock_irqrestore(&ctx->wqh.lock, flags);
  72
  73         return n;
  74 }
  75
  76 /**
  77  * eventfd_signal - Adds @n to the eventfd counter.
  78  * @ctx: [in] Pointer to the eventfd context.
  79  * @n: [in] Value of the counter to be added to the eventfd internal counter.
  80  *          The value cannot be negative.
  81  *
  82  * This function is supposed to be called by the kernel in paths that do not
  83  * allow sleeping. In this function we allow the counter to reach the ULLONG_MAX
  84  * value, and we signal this as overflow condition by returning a EPOLLERR
  85  * to poll(2).
  86  *
  87  * Returns the amount by which the counter was incremented.  This will be less
  88  * than @n if the counter has overflowed.
  89  */
  90 __u64 eventfd_signal(struct eventfd_ctx *ctx, __u64 n)
  91 {
  92         return eventfd_signal_mask(ctx, n, 0);
  93 }
  94 EXPORT_SYMBOL_GPL(eventfd_signal);
  95
  96 static void eventfd_free_ctx(struct eventfd_ctx *ctx)
  97 {
  98         if (ctx->id >= 0)
  99                 ida_simple_remove(&eventfd_ida, ctx->id);
 100         kfree(ctx);
 101 }
 102
 103 static void eventfd_free(struct kref *kref)
 104 {
 105         struct eventfd_ctx *ctx = container_of(kref, struct eventfd_ctx, kref);
 106
 107         eventfd_free_ctx(ctx);
 108 }
 109
 110 /**
 111  * eventfd_ctx_put - Releases a reference to the internal eventfd context.
 112  * @ctx: [in] Pointer to eventfd context.
 113  *
 114  * The eventfd context reference must have been previously acquired either
 115  * with eventfd_ctx_fdget() or eventfd_ctx_fileget().
 116  */
 117 void eventfd_ctx_put(struct eventfd_ctx *ctx)
 118 {
 119         kref_put(&ctx->kref, eventfd_free);
 120 }
 121 EXPORT_SYMBOL_GPL(eventfd_ctx_put);
 122
 123 static int eventfd_release(struct inode *inode, struct file *file)
 124 {
 125         struct eventfd_ctx *ctx = file->private_data;
 126
 127         wake_up_poll(&ctx->wqh, EPOLLHUP);
 128         eventfd_ctx_put(ctx);
 129         return 0;
 130 }
 131
 132 static __poll_t eventfd_poll(struct file *file, poll_table *wait)
 133 {
 134         struct eventfd_ctx *ctx = file->private_data;
 135         __poll_t events = 0;
 136         u64 count;
 137
 138         poll_wait(file, &ctx->wqh, wait);
 139
 140         /*
 141          * All writes to ctx->count occur within ctx->wqh.lock.  This read
 142          * can be done outside ctx->wqh.lock because we know that poll_wait
 143          * takes that lock (through add_wait_queue) if our caller will sleep.
 144          *
 145          * The read _can_ therefore seep into add_wait_queue's critical
 146          * section, but cannot move above it!  add_wait_queue's spin_lock acts
 147          * as an acquire barrier and ensures that the read be ordered properly
 148          * against the writes.  The following CAN happen and is safe:
 149          *
 150          *     poll                               write
 151          *     -----------------                  ------------
 152          *     lock ctx->wqh.lock (in poll_wait)
 153          *     count = ctx->count
 154          *     __add_wait_queue
 155          *     unlock ctx->wqh.lock
 156          *                                        lock ctx->qwh.lock
 157          *                                        ctx->count += n
 158          *                                        if (waitqueue_active)
 159          *                                          wake_up_locked_poll
 160          *                                        unlock ctx->qwh.lock
 161          *     eventfd_poll returns 0
 162          *
 163          * but the following, which would miss a wakeup, cannot happen:
 164          *
 165          *     poll                               write
 166          *     -----------------                  ------------
 167          *     count = ctx->count (INVALID!)
 168          *                                        lock ctx->qwh.lock
 169          *                                        ctx->count += n
 170          *                                        **waitqueue_active is false**
 171          *                                        **no wake_up_locked_poll!**
 172          *                                        unlock ctx->qwh.lock
 173          *     lock ctx->wqh.lock (in poll_wait)
 174          *     __add_wait_queue
 175          *     unlock ctx->wqh.lock
 176          *     eventfd_poll returns 0
 177          */
 178         count = READ_ONCE(ctx->count);
 179
 180         if (count > 0)
 181                 events |= EPOLLIN;
 182         if (count == ULLONG_MAX)
 183                 events |= EPOLLERR;
 184         if (ULLONG_MAX - 1 > count)
 185                 events |= EPOLLOUT;
 186
 187         return events;
 188 }
 189
 190 void eventfd_ctx_do_read(struct eventfd_ctx *ctx, __u64 *cnt)
 191 {
 192         lockdep_assert_held(&ctx->wqh.lock);
 193
 194         *cnt = ((ctx->flags & EFD_SEMAPHORE) && ctx->count) ? 1 : ctx->count;
 195         ctx->count -= *cnt;
 196 }
 197 EXPORT_SYMBOL_GPL(eventfd_ctx_do_read);
 198
 199 /**
 200  * eventfd_ctx_remove_wait_queue - Read the current counter and removes wait queue.
 201  * @ctx: [in] Pointer to eventfd context.
 202  * @wait: [in] Wait queue to be removed.
 203  * @cnt: [out] Pointer to the 64-bit counter value.
 204  *
 205  * Returns %0 if successful, or the following error codes:
 206  *
 207  * -EAGAIN      : The operation would have blocked.
 208  *
 209  * This is used to atomically remove a wait queue entry from the eventfd wait
 210  * queue head, and read/reset the counter value.
 211  */
 212 int eventfd_ctx_remove_wait_queue(struct eventfd_ctx *ctx, wait_queue_entry_t *wait,
 213                                   __u64 *cnt)
 214 {
 215         unsigned long flags;
 216
 217         spin_lock_irqsave(&ctx->wqh.lock, flags);
 218         eventfd_ctx_do_read(ctx, cnt);
 219         __remove_wait_queue(&ctx->wqh, wait);
 220         if (*cnt != 0 && waitqueue_active(&ctx->wqh))
 221                 wake_up_locked_poll(&ctx->wqh, EPOLLOUT);
 222         spin_unlock_irqrestore(&ctx->wqh.lock, flags);
 223
 224         return *cnt != 0 ? 0 : -EAGAIN;
 225 }
 226 EXPORT_SYMBOL_GPL(eventfd_ctx_remove_wait_queue);
 227
 228 static ssize_t eventfd_read(struct kiocb *iocb, struct iov_iter *to)
 229 {
 230         struct file *file = iocb->ki_filp;
 231         struct eventfd_ctx *ctx = file->private_data;
 232         __u64 ucnt = 0;
 233         DECLARE_WAITQUEUE(wait, current);
 234
 235         if (iov_iter_count(to) < sizeof(ucnt))
 236                 return -EINVAL;
 237         spin_lock_irq(&ctx->wqh.lock);
 238         if (!ctx->count) {
 239                 if ((file->f_flags & O_NONBLOCK) ||
 240                     (iocb->ki_flags & IOCB_NOWAIT)) {
 241                         spin_unlock_irq(&ctx->wqh.lock);
 242                         return -EAGAIN;
 243                 }
 244                 __add_wait_queue(&ctx->wqh, &wait);
 245                 for (;;) {
 246                         set_current_state(TASK_INTERRUPTIBLE);
 247                         if (ctx->count)
 248                                 break;
 249                         if (signal_pending(current)) {
 250                                 __remove_wait_queue(&ctx->wqh, &wait);
 251                                 __set_current_state(TASK_RUNNING);
 252                                 spin_unlock_irq(&ctx->wqh.lock);
 253                                 return -ERESTARTSYS;
 254                         }
 255                         spin_unlock_irq(&ctx->wqh.lock);
 256                         schedule();
 257                         spin_lock_irq(&ctx->wqh.lock);
 258                 }
 259                 __remove_wait_queue(&ctx->wqh, &wait);
 260                 __set_current_state(TASK_RUNNING);
 261         }
 262         eventfd_ctx_do_read(ctx, &ucnt);
 263         if (waitqueue_active(&ctx->wqh))
 264                 wake_up_locked_poll(&ctx->wqh, EPOLLOUT);
 265         spin_unlock_irq(&ctx->wqh.lock);
 266         if (unlikely(copy_to_iter(&ucnt, sizeof(ucnt), to) != sizeof(ucnt)))
 267                 return -EFAULT;
 268
 269         return sizeof(ucnt);
 270 }
 271
 272 static ssize_t eventfd_write(struct file *file, const char __user *buf, size_t count,
 273                              loff_t *ppos)
 274 {
 275         struct eventfd_ctx *ctx = file->private_data;
 276         ssize_t res;
 277         __u64 ucnt;
 278         DECLARE_WAITQUEUE(wait, current);
 279
 280         if (count < sizeof(ucnt))
 281                 return -EINVAL;
 282         if (copy_from_user(&ucnt, buf, sizeof(ucnt)))
 283                 return -EFAULT;
 284         if (ucnt == ULLONG_MAX)
 285                 return -EINVAL;
 286         spin_lock_irq(&ctx->wqh.lock);
 287         res = -EAGAIN;
 288         if (ULLONG_MAX - ctx->count > ucnt)
 289                 res = sizeof(ucnt);
 290         else if (!(file->f_flags & O_NONBLOCK)) {
 291                 __add_wait_queue(&ctx->wqh, &wait);
 292                 for (res = 0;;) {
 293                         set_current_state(TASK_INTERRUPTIBLE);
 294                         if (ULLONG_MAX - ctx->count > ucnt) {
 295                                 res = sizeof(ucnt);
 296                                 break;
 297                         }
 298                         if (signal_pending(current)) {
 299                                 res = -ERESTARTSYS;
 300                                 break;
 301                         }
 302                         spin_unlock_irq(&ctx->wqh.lock);
 303                         schedule();
 304                         spin_lock_irq(&ctx->wqh.lock);
 305                 }
 306                 __remove_wait_queue(&ctx->wqh, &wait);
 307                 __set_current_state(TASK_RUNNING);
 308         }
 309         if (likely(res > 0)) {
 310                 ctx->count += ucnt;
 311                 if (waitqueue_active(&ctx->wqh))
 312                         wake_up_locked_poll(&ctx->wqh, EPOLLIN);
 313         }
 314         spin_unlock_irq(&ctx->wqh.lock);
 315
 316         return res;
 317 }
 318
 319 #ifdef CONFIG_PROC_FS
 320 static void eventfd_show_fdinfo(struct seq_file *m, struct file *f)
 321 {
 322         struct eventfd_ctx *ctx = f->private_data;
 323
 324         spin_lock_irq(&ctx->wqh.lock);
 325         seq_printf(m, "eventfd-count: %16llx\n",
 326                    (unsigned long long)ctx->count);
 327         spin_unlock_irq(&ctx->wqh.lock);
 328         seq_printf(m, "eventfd-id: %d\n", ctx->id);
 329 }
 330 #endif
 331
 332 static const struct file_operations eventfd_fops = {
 333 #ifdef CONFIG_PROC_FS
 334         .show_fdinfo    = eventfd_show_fdinfo,
 335 #endif
 336         .release        = eventfd_release,
 337         .poll           = eventfd_poll,
 338         .read_iter      = eventfd_read,
 339         .write          = eventfd_write,
 340         .llseek         = noop_llseek,
 341 };
 342
 343 /**
 344  * eventfd_fget - Acquire a reference of an eventfd file descriptor.
 345  * @fd: [in] Eventfd file descriptor.
 346  *
 347  * Returns a pointer to the eventfd file structure in case of success, or the
 348  * following error pointer:
 349  *
 350  * -EBADF    : Invalid @fd file descriptor.
 351  * -EINVAL   : The @fd file descriptor is not an eventfd file.
 352  */
 353 struct file *eventfd_fget(int fd)
 354 {
 355         struct file *file;
 356
 357         file = fget(fd);
 358         if (!file)
 359                 return ERR_PTR(-EBADF);
 360         if (file->f_op != &eventfd_fops) {
 361                 fput(file);
 362                 return ERR_PTR(-EINVAL);
 363         }
 364
 365         return file;
 366 }
 367 EXPORT_SYMBOL_GPL(eventfd_fget);
 368
 369 /**
 370  * eventfd_ctx_fdget - Acquires a reference to the internal eventfd context.
 371  * @fd: [in] Eventfd file descriptor.
 372  *
 373  * Returns a pointer to the internal eventfd context, otherwise the error
 374  * pointers returned by the following functions:
 375  *
 376  * eventfd_fget
 377  */
 378 struct eventfd_ctx *eventfd_ctx_fdget(int fd)
 379 {
 380         struct eventfd_ctx *ctx;
 381         struct fd f = fdget(fd);
 382         if (!f.file)
 383                 return ERR_PTR(-EBADF);
 384         ctx = eventfd_ctx_fileget(f.file);
 385         fdput(f);
 386         return ctx;
 387 }
 388 EXPORT_SYMBOL_GPL(eventfd_ctx_fdget);
 389
 390 /**
 391  * eventfd_ctx_fileget - Acquires a reference to the internal eventfd context.
 392  * @file: [in] Eventfd file pointer.
 393  *
 394  * Returns a pointer to the internal eventfd context, otherwise the error
 395  * pointer:
 396  *
 397  * -EINVAL   : The @fd file descriptor is not an eventfd file.
 398  */
 399 struct eventfd_ctx *eventfd_ctx_fileget(struct file *file)
 400 {
 401         struct eventfd_ctx *ctx;
 402
 403         if (file->f_op != &eventfd_fops)
 404                 return ERR_PTR(-EINVAL);
 405
 406         ctx = file->private_data;
 407         kref_get(&ctx->kref);
 408         return ctx;
 409 }
 410 EXPORT_SYMBOL_GPL(eventfd_ctx_fileget);
 411
 412 static int do_eventfd(unsigned int count, int flags)
 413 {
 414         struct eventfd_ctx *ctx;
 415         struct file *file;
 416         int fd;
 417
 418         /* Check the EFD_* constants for consistency.  */
 419         BUILD_BUG_ON(EFD_CLOEXEC != O_CLOEXEC);
 420         BUILD_BUG_ON(EFD_NONBLOCK != O_NONBLOCK);
 421
 422         if (flags & ~EFD_FLAGS_SET)
 423                 return -EINVAL;
 424
 425         ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
 426         if (!ctx)
 427                 return -ENOMEM;
 428
 429         kref_init(&ctx->kref);
 430         init_waitqueue_head(&ctx->wqh);
 431         ctx->count = count;
 432         ctx->flags = flags;
 433         ctx->id = ida_simple_get(&eventfd_ida, 0, 0, GFP_KERNEL);
 434
 435         flags &= EFD_SHARED_FCNTL_FLAGS;
 436         flags |= O_RDWR;
 437         fd = get_unused_fd_flags(flags);
 438         if (fd < 0)
 439                 goto err;
 440
 441         file = anon_inode_getfile("[eventfd]", &eventfd_fops, ctx, flags);
 442         if (IS_ERR(file)) {
 443                 put_unused_fd(fd);
 444                 fd = PTR_ERR(file);
 445                 goto err;
 446         }
 447
 448         file->f_mode |= FMODE_NOWAIT;
 449         fd_install(fd, file);
 450         return fd;
 451 err:
 452         eventfd_free_ctx(ctx);
 453         return fd;
 454 }
 455
 456 SYSCALL_DEFINE2(eventfd2, unsigned int, count, int, flags)
 457 {
 458         return do_eventfd(count, flags);
 459 }
 460
 461 SYSCALL_DEFINE1(eventfd, unsigned int, count)
 462 {
 463         return do_eventfd(count, 0);
 464 }
 465