mirror of
https://github.com/torvalds/linux.git
synced 2024-12-15 15:41:58 +00:00
6038f373a3
All file_operations should get a .llseek operation so we can make nonseekable_open the default for future file operations without a .llseek pointer. The three cases that we can automatically detect are no_llseek, seq_lseek and default_llseek. For cases where we can we can automatically prove that the file offset is always ignored, we use noop_llseek, which maintains the current behavior of not returning an error from a seek. New drivers should normally not use noop_llseek but instead use no_llseek and call nonseekable_open at open time. Existing drivers can be converted to do the same when the maintainer knows for certain that no user code relies on calling seek on the device file. The generated code is often incorrectly indented and right now contains comments that clarify for each added line why a specific variant was chosen. In the version that gets submitted upstream, the comments will be gone and I will manually fix the indentation, because there does not seem to be a way to do that using coccinelle. Some amount of new code is currently sitting in linux-next that should get the same modifications, which I will do at the end of the merge window. Many thanks to Julia Lawall for helping me learn to write a semantic patch that does all this. ===== begin semantic patch ===== // This adds an llseek= method to all file operations, // as a preparation for making no_llseek the default. // // The rules are // - use no_llseek explicitly if we do nonseekable_open // - use seq_lseek for sequential files // - use default_llseek if we know we access f_pos // - use noop_llseek if we know we don't access f_pos, // but we still want to allow users to call lseek // @ open1 exists @ identifier nested_open; @@ nested_open(...) { <+... nonseekable_open(...) ...+> } @ open exists@ identifier open_f; identifier i, f; identifier open1.nested_open; @@ int open_f(struct inode *i, struct file *f) { <+... ( nonseekable_open(...) | nested_open(...) ) ...+> } @ read disable optional_qualifier exists @ identifier read_f; identifier f, p, s, off; type ssize_t, size_t, loff_t; expression E; identifier func; @@ ssize_t read_f(struct file *f, char *p, size_t s, loff_t *off) { <+... ( *off = E | *off += E | func(..., off, ...) | E = *off ) ...+> } @ read_no_fpos disable optional_qualifier exists @ identifier read_f; identifier f, p, s, off; type ssize_t, size_t, loff_t; @@ ssize_t read_f(struct file *f, char *p, size_t s, loff_t *off) { ... when != off } @ write @ identifier write_f; identifier f, p, s, off; type ssize_t, size_t, loff_t; expression E; identifier func; @@ ssize_t write_f(struct file *f, const char *p, size_t s, loff_t *off) { <+... ( *off = E | *off += E | func(..., off, ...) | E = *off ) ...+> } @ write_no_fpos @ identifier write_f; identifier f, p, s, off; type ssize_t, size_t, loff_t; @@ ssize_t write_f(struct file *f, const char *p, size_t s, loff_t *off) { ... when != off } @ fops0 @ identifier fops; @@ struct file_operations fops = { ... }; @ has_llseek depends on fops0 @ identifier fops0.fops; identifier llseek_f; @@ struct file_operations fops = { ... .llseek = llseek_f, ... }; @ has_read depends on fops0 @ identifier fops0.fops; identifier read_f; @@ struct file_operations fops = { ... .read = read_f, ... }; @ has_write depends on fops0 @ identifier fops0.fops; identifier write_f; @@ struct file_operations fops = { ... .write = write_f, ... }; @ has_open depends on fops0 @ identifier fops0.fops; identifier open_f; @@ struct file_operations fops = { ... .open = open_f, ... }; // use no_llseek if we call nonseekable_open //////////////////////////////////////////// @ nonseekable1 depends on !has_llseek && has_open @ identifier fops0.fops; identifier nso ~= "nonseekable_open"; @@ struct file_operations fops = { ... .open = nso, ... +.llseek = no_llseek, /* nonseekable */ }; @ nonseekable2 depends on !has_llseek @ identifier fops0.fops; identifier open.open_f; @@ struct file_operations fops = { ... .open = open_f, ... +.llseek = no_llseek, /* open uses nonseekable */ }; // use seq_lseek for sequential files ///////////////////////////////////// @ seq depends on !has_llseek @ identifier fops0.fops; identifier sr ~= "seq_read"; @@ struct file_operations fops = { ... .read = sr, ... +.llseek = seq_lseek, /* we have seq_read */ }; // use default_llseek if there is a readdir /////////////////////////////////////////// @ fops1 depends on !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier readdir_e; @@ // any other fop is used that changes pos struct file_operations fops = { ... .readdir = readdir_e, ... +.llseek = default_llseek, /* readdir is present */ }; // use default_llseek if at least one of read/write touches f_pos ///////////////////////////////////////////////////////////////// @ fops2 depends on !fops1 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier read.read_f; @@ // read fops use offset struct file_operations fops = { ... .read = read_f, ... +.llseek = default_llseek, /* read accesses f_pos */ }; @ fops3 depends on !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier write.write_f; @@ // write fops use offset struct file_operations fops = { ... .write = write_f, ... + .llseek = default_llseek, /* write accesses f_pos */ }; // Use noop_llseek if neither read nor write accesses f_pos /////////////////////////////////////////////////////////// @ fops4 depends on !fops1 && !fops2 && !fops3 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier read_no_fpos.read_f; identifier write_no_fpos.write_f; @@ // write fops use offset struct file_operations fops = { ... .write = write_f, .read = read_f, ... +.llseek = noop_llseek, /* read and write both use no f_pos */ }; @ depends on has_write && !has_read && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier write_no_fpos.write_f; @@ struct file_operations fops = { ... .write = write_f, ... +.llseek = noop_llseek, /* write uses no f_pos */ }; @ depends on has_read && !has_write && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; identifier read_no_fpos.read_f; @@ struct file_operations fops = { ... .read = read_f, ... +.llseek = noop_llseek, /* read uses no f_pos */ }; @ depends on !has_read && !has_write && !fops1 && !fops2 && !has_llseek && !nonseekable1 && !nonseekable2 && !seq @ identifier fops0.fops; @@ struct file_operations fops = { ... +.llseek = noop_llseek, /* no read or write fn */ }; ===== End semantic patch ===== Signed-off-by: Arnd Bergmann <arnd@arndb.de> Cc: Julia Lawall <julia@diku.dk> Cc: Christoph Hellwig <hch@infradead.org>
440 lines
11 KiB
C
440 lines
11 KiB
C
/*
|
|
* fs/eventfd.c
|
|
*
|
|
* Copyright (C) 2007 Davide Libenzi <davidel@xmailserver.org>
|
|
*
|
|
*/
|
|
|
|
#include <linux/file.h>
|
|
#include <linux/poll.h>
|
|
#include <linux/init.h>
|
|
#include <linux/fs.h>
|
|
#include <linux/sched.h>
|
|
#include <linux/kernel.h>
|
|
#include <linux/slab.h>
|
|
#include <linux/list.h>
|
|
#include <linux/spinlock.h>
|
|
#include <linux/anon_inodes.h>
|
|
#include <linux/syscalls.h>
|
|
#include <linux/module.h>
|
|
#include <linux/kref.h>
|
|
#include <linux/eventfd.h>
|
|
|
|
struct eventfd_ctx {
|
|
struct kref kref;
|
|
wait_queue_head_t wqh;
|
|
/*
|
|
* Every time that a write(2) is performed on an eventfd, the
|
|
* value of the __u64 being written is added to "count" and a
|
|
* wakeup is performed on "wqh". A read(2) will return the "count"
|
|
* value to userspace, and will reset "count" to zero. The kernel
|
|
* side eventfd_signal() also, adds to the "count" counter and
|
|
* issue a wakeup.
|
|
*/
|
|
__u64 count;
|
|
unsigned int flags;
|
|
};
|
|
|
|
/**
|
|
* eventfd_signal - Adds @n to the eventfd counter.
|
|
* @ctx: [in] Pointer to the eventfd context.
|
|
* @n: [in] Value of the counter to be added to the eventfd internal counter.
|
|
* The value cannot be negative.
|
|
*
|
|
* This function is supposed to be called by the kernel in paths that do not
|
|
* allow sleeping. In this function we allow the counter to reach the ULLONG_MAX
|
|
* value, and we signal this as overflow condition by returining a POLLERR
|
|
* to poll(2).
|
|
*
|
|
* Returns @n in case of success, a non-negative number lower than @n in case
|
|
* of overflow, or the following error codes:
|
|
*
|
|
* -EINVAL : The value of @n is negative.
|
|
*/
|
|
int eventfd_signal(struct eventfd_ctx *ctx, int n)
|
|
{
|
|
unsigned long flags;
|
|
|
|
if (n < 0)
|
|
return -EINVAL;
|
|
spin_lock_irqsave(&ctx->wqh.lock, flags);
|
|
if (ULLONG_MAX - ctx->count < n)
|
|
n = (int) (ULLONG_MAX - ctx->count);
|
|
ctx->count += n;
|
|
if (waitqueue_active(&ctx->wqh))
|
|
wake_up_locked_poll(&ctx->wqh, POLLIN);
|
|
spin_unlock_irqrestore(&ctx->wqh.lock, flags);
|
|
|
|
return n;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_signal);
|
|
|
|
static void eventfd_free_ctx(struct eventfd_ctx *ctx)
|
|
{
|
|
kfree(ctx);
|
|
}
|
|
|
|
static void eventfd_free(struct kref *kref)
|
|
{
|
|
struct eventfd_ctx *ctx = container_of(kref, struct eventfd_ctx, kref);
|
|
|
|
eventfd_free_ctx(ctx);
|
|
}
|
|
|
|
/**
|
|
* eventfd_ctx_get - Acquires a reference to the internal eventfd context.
|
|
* @ctx: [in] Pointer to the eventfd context.
|
|
*
|
|
* Returns: In case of success, returns a pointer to the eventfd context.
|
|
*/
|
|
struct eventfd_ctx *eventfd_ctx_get(struct eventfd_ctx *ctx)
|
|
{
|
|
kref_get(&ctx->kref);
|
|
return ctx;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_get);
|
|
|
|
/**
|
|
* eventfd_ctx_put - Releases a reference to the internal eventfd context.
|
|
* @ctx: [in] Pointer to eventfd context.
|
|
*
|
|
* The eventfd context reference must have been previously acquired either
|
|
* with eventfd_ctx_get() or eventfd_ctx_fdget()).
|
|
*/
|
|
void eventfd_ctx_put(struct eventfd_ctx *ctx)
|
|
{
|
|
kref_put(&ctx->kref, eventfd_free);
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_put);
|
|
|
|
static int eventfd_release(struct inode *inode, struct file *file)
|
|
{
|
|
struct eventfd_ctx *ctx = file->private_data;
|
|
|
|
wake_up_poll(&ctx->wqh, POLLHUP);
|
|
eventfd_ctx_put(ctx);
|
|
return 0;
|
|
}
|
|
|
|
static unsigned int eventfd_poll(struct file *file, poll_table *wait)
|
|
{
|
|
struct eventfd_ctx *ctx = file->private_data;
|
|
unsigned int events = 0;
|
|
unsigned long flags;
|
|
|
|
poll_wait(file, &ctx->wqh, wait);
|
|
|
|
spin_lock_irqsave(&ctx->wqh.lock, flags);
|
|
if (ctx->count > 0)
|
|
events |= POLLIN;
|
|
if (ctx->count == ULLONG_MAX)
|
|
events |= POLLERR;
|
|
if (ULLONG_MAX - 1 > ctx->count)
|
|
events |= POLLOUT;
|
|
spin_unlock_irqrestore(&ctx->wqh.lock, flags);
|
|
|
|
return events;
|
|
}
|
|
|
|
static void eventfd_ctx_do_read(struct eventfd_ctx *ctx, __u64 *cnt)
|
|
{
|
|
*cnt = (ctx->flags & EFD_SEMAPHORE) ? 1 : ctx->count;
|
|
ctx->count -= *cnt;
|
|
}
|
|
|
|
/**
|
|
* eventfd_ctx_remove_wait_queue - Read the current counter and removes wait queue.
|
|
* @ctx: [in] Pointer to eventfd context.
|
|
* @wait: [in] Wait queue to be removed.
|
|
* @cnt: [out] Pointer to the 64bit conter value.
|
|
*
|
|
* Returns zero if successful, or the following error codes:
|
|
*
|
|
* -EAGAIN : The operation would have blocked.
|
|
*
|
|
* This is used to atomically remove a wait queue entry from the eventfd wait
|
|
* queue head, and read/reset the counter value.
|
|
*/
|
|
int eventfd_ctx_remove_wait_queue(struct eventfd_ctx *ctx, wait_queue_t *wait,
|
|
__u64 *cnt)
|
|
{
|
|
unsigned long flags;
|
|
|
|
spin_lock_irqsave(&ctx->wqh.lock, flags);
|
|
eventfd_ctx_do_read(ctx, cnt);
|
|
__remove_wait_queue(&ctx->wqh, wait);
|
|
if (*cnt != 0 && waitqueue_active(&ctx->wqh))
|
|
wake_up_locked_poll(&ctx->wqh, POLLOUT);
|
|
spin_unlock_irqrestore(&ctx->wqh.lock, flags);
|
|
|
|
return *cnt != 0 ? 0 : -EAGAIN;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_remove_wait_queue);
|
|
|
|
/**
|
|
* eventfd_ctx_read - Reads the eventfd counter or wait if it is zero.
|
|
* @ctx: [in] Pointer to eventfd context.
|
|
* @no_wait: [in] Different from zero if the operation should not block.
|
|
* @cnt: [out] Pointer to the 64bit conter value.
|
|
*
|
|
* Returns zero if successful, or the following error codes:
|
|
*
|
|
* -EAGAIN : The operation would have blocked but @no_wait was nonzero.
|
|
* -ERESTARTSYS : A signal interrupted the wait operation.
|
|
*
|
|
* If @no_wait is zero, the function might sleep until the eventfd internal
|
|
* counter becomes greater than zero.
|
|
*/
|
|
ssize_t eventfd_ctx_read(struct eventfd_ctx *ctx, int no_wait, __u64 *cnt)
|
|
{
|
|
ssize_t res;
|
|
DECLARE_WAITQUEUE(wait, current);
|
|
|
|
spin_lock_irq(&ctx->wqh.lock);
|
|
*cnt = 0;
|
|
res = -EAGAIN;
|
|
if (ctx->count > 0)
|
|
res = 0;
|
|
else if (!no_wait) {
|
|
__add_wait_queue(&ctx->wqh, &wait);
|
|
for (;;) {
|
|
set_current_state(TASK_INTERRUPTIBLE);
|
|
if (ctx->count > 0) {
|
|
res = 0;
|
|
break;
|
|
}
|
|
if (signal_pending(current)) {
|
|
res = -ERESTARTSYS;
|
|
break;
|
|
}
|
|
spin_unlock_irq(&ctx->wqh.lock);
|
|
schedule();
|
|
spin_lock_irq(&ctx->wqh.lock);
|
|
}
|
|
__remove_wait_queue(&ctx->wqh, &wait);
|
|
__set_current_state(TASK_RUNNING);
|
|
}
|
|
if (likely(res == 0)) {
|
|
eventfd_ctx_do_read(ctx, cnt);
|
|
if (waitqueue_active(&ctx->wqh))
|
|
wake_up_locked_poll(&ctx->wqh, POLLOUT);
|
|
}
|
|
spin_unlock_irq(&ctx->wqh.lock);
|
|
|
|
return res;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_read);
|
|
|
|
static ssize_t eventfd_read(struct file *file, char __user *buf, size_t count,
|
|
loff_t *ppos)
|
|
{
|
|
struct eventfd_ctx *ctx = file->private_data;
|
|
ssize_t res;
|
|
__u64 cnt;
|
|
|
|
if (count < sizeof(cnt))
|
|
return -EINVAL;
|
|
res = eventfd_ctx_read(ctx, file->f_flags & O_NONBLOCK, &cnt);
|
|
if (res < 0)
|
|
return res;
|
|
|
|
return put_user(cnt, (__u64 __user *) buf) ? -EFAULT : sizeof(cnt);
|
|
}
|
|
|
|
static ssize_t eventfd_write(struct file *file, const char __user *buf, size_t count,
|
|
loff_t *ppos)
|
|
{
|
|
struct eventfd_ctx *ctx = file->private_data;
|
|
ssize_t res;
|
|
__u64 ucnt;
|
|
DECLARE_WAITQUEUE(wait, current);
|
|
|
|
if (count < sizeof(ucnt))
|
|
return -EINVAL;
|
|
if (copy_from_user(&ucnt, buf, sizeof(ucnt)))
|
|
return -EFAULT;
|
|
if (ucnt == ULLONG_MAX)
|
|
return -EINVAL;
|
|
spin_lock_irq(&ctx->wqh.lock);
|
|
res = -EAGAIN;
|
|
if (ULLONG_MAX - ctx->count > ucnt)
|
|
res = sizeof(ucnt);
|
|
else if (!(file->f_flags & O_NONBLOCK)) {
|
|
__add_wait_queue(&ctx->wqh, &wait);
|
|
for (res = 0;;) {
|
|
set_current_state(TASK_INTERRUPTIBLE);
|
|
if (ULLONG_MAX - ctx->count > ucnt) {
|
|
res = sizeof(ucnt);
|
|
break;
|
|
}
|
|
if (signal_pending(current)) {
|
|
res = -ERESTARTSYS;
|
|
break;
|
|
}
|
|
spin_unlock_irq(&ctx->wqh.lock);
|
|
schedule();
|
|
spin_lock_irq(&ctx->wqh.lock);
|
|
}
|
|
__remove_wait_queue(&ctx->wqh, &wait);
|
|
__set_current_state(TASK_RUNNING);
|
|
}
|
|
if (likely(res > 0)) {
|
|
ctx->count += ucnt;
|
|
if (waitqueue_active(&ctx->wqh))
|
|
wake_up_locked_poll(&ctx->wqh, POLLIN);
|
|
}
|
|
spin_unlock_irq(&ctx->wqh.lock);
|
|
|
|
return res;
|
|
}
|
|
|
|
static const struct file_operations eventfd_fops = {
|
|
.release = eventfd_release,
|
|
.poll = eventfd_poll,
|
|
.read = eventfd_read,
|
|
.write = eventfd_write,
|
|
.llseek = noop_llseek,
|
|
};
|
|
|
|
/**
|
|
* eventfd_fget - Acquire a reference of an eventfd file descriptor.
|
|
* @fd: [in] Eventfd file descriptor.
|
|
*
|
|
* Returns a pointer to the eventfd file structure in case of success, or the
|
|
* following error pointer:
|
|
*
|
|
* -EBADF : Invalid @fd file descriptor.
|
|
* -EINVAL : The @fd file descriptor is not an eventfd file.
|
|
*/
|
|
struct file *eventfd_fget(int fd)
|
|
{
|
|
struct file *file;
|
|
|
|
file = fget(fd);
|
|
if (!file)
|
|
return ERR_PTR(-EBADF);
|
|
if (file->f_op != &eventfd_fops) {
|
|
fput(file);
|
|
return ERR_PTR(-EINVAL);
|
|
}
|
|
|
|
return file;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_fget);
|
|
|
|
/**
|
|
* eventfd_ctx_fdget - Acquires a reference to the internal eventfd context.
|
|
* @fd: [in] Eventfd file descriptor.
|
|
*
|
|
* Returns a pointer to the internal eventfd context, otherwise the error
|
|
* pointers returned by the following functions:
|
|
*
|
|
* eventfd_fget
|
|
*/
|
|
struct eventfd_ctx *eventfd_ctx_fdget(int fd)
|
|
{
|
|
struct file *file;
|
|
struct eventfd_ctx *ctx;
|
|
|
|
file = eventfd_fget(fd);
|
|
if (IS_ERR(file))
|
|
return (struct eventfd_ctx *) file;
|
|
ctx = eventfd_ctx_get(file->private_data);
|
|
fput(file);
|
|
|
|
return ctx;
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_fdget);
|
|
|
|
/**
|
|
* eventfd_ctx_fileget - Acquires a reference to the internal eventfd context.
|
|
* @file: [in] Eventfd file pointer.
|
|
*
|
|
* Returns a pointer to the internal eventfd context, otherwise the error
|
|
* pointer:
|
|
*
|
|
* -EINVAL : The @fd file descriptor is not an eventfd file.
|
|
*/
|
|
struct eventfd_ctx *eventfd_ctx_fileget(struct file *file)
|
|
{
|
|
if (file->f_op != &eventfd_fops)
|
|
return ERR_PTR(-EINVAL);
|
|
|
|
return eventfd_ctx_get(file->private_data);
|
|
}
|
|
EXPORT_SYMBOL_GPL(eventfd_ctx_fileget);
|
|
|
|
/**
|
|
* eventfd_file_create - Creates an eventfd file pointer.
|
|
* @count: Initial eventfd counter value.
|
|
* @flags: Flags for the eventfd file.
|
|
*
|
|
* This function creates an eventfd file pointer, w/out installing it into
|
|
* the fd table. This is useful when the eventfd file is used during the
|
|
* initialization of data structures that require extra setup after the eventfd
|
|
* creation. So the eventfd creation is split into the file pointer creation
|
|
* phase, and the file descriptor installation phase.
|
|
* In this way races with userspace closing the newly installed file descriptor
|
|
* can be avoided.
|
|
* Returns an eventfd file pointer, or a proper error pointer.
|
|
*/
|
|
struct file *eventfd_file_create(unsigned int count, int flags)
|
|
{
|
|
struct file *file;
|
|
struct eventfd_ctx *ctx;
|
|
|
|
/* Check the EFD_* constants for consistency. */
|
|
BUILD_BUG_ON(EFD_CLOEXEC != O_CLOEXEC);
|
|
BUILD_BUG_ON(EFD_NONBLOCK != O_NONBLOCK);
|
|
|
|
if (flags & ~EFD_FLAGS_SET)
|
|
return ERR_PTR(-EINVAL);
|
|
|
|
ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
|
|
if (!ctx)
|
|
return ERR_PTR(-ENOMEM);
|
|
|
|
kref_init(&ctx->kref);
|
|
init_waitqueue_head(&ctx->wqh);
|
|
ctx->count = count;
|
|
ctx->flags = flags;
|
|
|
|
file = anon_inode_getfile("[eventfd]", &eventfd_fops, ctx,
|
|
O_RDWR | (flags & EFD_SHARED_FCNTL_FLAGS));
|
|
if (IS_ERR(file))
|
|
eventfd_free_ctx(ctx);
|
|
|
|
return file;
|
|
}
|
|
|
|
SYSCALL_DEFINE2(eventfd2, unsigned int, count, int, flags)
|
|
{
|
|
int fd, error;
|
|
struct file *file;
|
|
|
|
error = get_unused_fd_flags(flags & EFD_SHARED_FCNTL_FLAGS);
|
|
if (error < 0)
|
|
return error;
|
|
fd = error;
|
|
|
|
file = eventfd_file_create(count, flags);
|
|
if (IS_ERR(file)) {
|
|
error = PTR_ERR(file);
|
|
goto err_put_unused_fd;
|
|
}
|
|
fd_install(fd, file);
|
|
|
|
return fd;
|
|
|
|
err_put_unused_fd:
|
|
put_unused_fd(fd);
|
|
|
|
return error;
|
|
}
|
|
|
|
SYSCALL_DEFINE1(eventfd, unsigned int, count)
|
|
{
|
|
return sys_eventfd2(count, 0);
|
|
}
|
|
|