timerfd.c 6.48 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 *  fs/timerfd.c
 *
 *  Copyright (C) 2007  Davide Libenzi <davidel@xmailserver.org>
 *
 *
 *  Thanks to Thomas Gleixner for code reviews and useful comments.
 *
 */

#include <linux/file.h>
#include <linux/poll.h>
#include <linux/init.h>
#include <linux/fs.h>
#include <linux/sched.h>
#include <linux/kernel.h>
17
#include <linux/slab.h>
18 19 20 21 22 23
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/time.h>
#include <linux/hrtimer.h>
#include <linux/anon_inodes.h>
#include <linux/timerfd.h>
24
#include <linux/syscalls.h>
25 26 27 28 29

struct timerfd_ctx {
	struct hrtimer tmr;
	ktime_t tintv;
	wait_queue_head_t wqh;
Davide Libenzi's avatar
Davide Libenzi committed
30
	u64 ticks;
31
	int expired;
Davide Libenzi's avatar
Davide Libenzi committed
32
	int clockid;
33 34 35 36 37
};

/*
 * This gets called when the timer event triggers. We set the "expired"
 * flag, but we do not re-arm the timer (in case it's necessary,
Davide Libenzi's avatar
Davide Libenzi committed
38
 * tintv.tv64 != 0) until the timer is accessed.
39 40 41 42 43 44
 */
static enum hrtimer_restart timerfd_tmrproc(struct hrtimer *htmr)
{
	struct timerfd_ctx *ctx = container_of(htmr, struct timerfd_ctx, tmr);
	unsigned long flags;

45
	spin_lock_irqsave(&ctx->wqh.lock, flags);
46
	ctx->expired = 1;
Davide Libenzi's avatar
Davide Libenzi committed
47
	ctx->ticks++;
48
	wake_up_locked(&ctx->wqh);
49
	spin_unlock_irqrestore(&ctx->wqh.lock, flags);
50 51 52 53

	return HRTIMER_NORESTART;
}

Davide Libenzi's avatar
Davide Libenzi committed
54 55
static ktime_t timerfd_get_remaining(struct timerfd_ctx *ctx)
{
56
	ktime_t remaining;
Davide Libenzi's avatar
Davide Libenzi committed
57

58
	remaining = hrtimer_expires_remaining(&ctx->tmr);
Davide Libenzi's avatar
Davide Libenzi committed
59 60 61 62
	return remaining.tv64 < 0 ? ktime_set(0, 0): remaining;
}

static void timerfd_setup(struct timerfd_ctx *ctx, int flags,
63 64 65 66 67 68 69 70 71 72
			  const struct itimerspec *ktmr)
{
	enum hrtimer_mode htmode;
	ktime_t texp;

	htmode = (flags & TFD_TIMER_ABSTIME) ?
		HRTIMER_MODE_ABS: HRTIMER_MODE_REL;

	texp = timespec_to_ktime(ktmr->it_value);
	ctx->expired = 0;
Davide Libenzi's avatar
Davide Libenzi committed
73
	ctx->ticks = 0;
74
	ctx->tintv = timespec_to_ktime(ktmr->it_interval);
Davide Libenzi's avatar
Davide Libenzi committed
75
	hrtimer_init(&ctx->tmr, ctx->clockid, htmode);
76
	hrtimer_set_expires(&ctx->tmr, texp);
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
	ctx->tmr.function = timerfd_tmrproc;
	if (texp.tv64 != 0)
		hrtimer_start(&ctx->tmr, texp, htmode);
}

static int timerfd_release(struct inode *inode, struct file *file)
{
	struct timerfd_ctx *ctx = file->private_data;

	hrtimer_cancel(&ctx->tmr);
	kfree(ctx);
	return 0;
}

static unsigned int timerfd_poll(struct file *file, poll_table *wait)
{
	struct timerfd_ctx *ctx = file->private_data;
	unsigned int events = 0;
	unsigned long flags;

	poll_wait(file, &ctx->wqh, wait);

99
	spin_lock_irqsave(&ctx->wqh.lock, flags);
Davide Libenzi's avatar
Davide Libenzi committed
100
	if (ctx->ticks)
101
		events |= POLLIN;
102
	spin_unlock_irqrestore(&ctx->wqh.lock, flags);
103 104 105 106 107 108 109 110 111

	return events;
}

static ssize_t timerfd_read(struct file *file, char __user *buf, size_t count,
			    loff_t *ppos)
{
	struct timerfd_ctx *ctx = file->private_data;
	ssize_t res;
112
	u64 ticks = 0;
113 114 115

	if (count < sizeof(ticks))
		return -EINVAL;
116
	spin_lock_irq(&ctx->wqh.lock);
117 118 119 120
	if (file->f_flags & O_NONBLOCK)
		res = -EAGAIN;
	else
		res = wait_event_interruptible_locked_irq(ctx->wqh, ctx->ticks);
Davide Libenzi's avatar
Davide Libenzi committed
121 122 123
	if (ctx->ticks) {
		ticks = ctx->ticks;
		if (ctx->expired && ctx->tintv.tv64) {
124 125 126 127 128 129
			/*
			 * If tintv.tv64 != 0, this is a periodic timer that
			 * needs to be re-armed. We avoid doing it in the timer
			 * callback to avoid DoS attacks specifying a very
			 * short timer period.
			 */
Davide Libenzi's avatar
Davide Libenzi committed
130 131
			ticks += hrtimer_forward_now(&ctx->tmr,
						     ctx->tintv) - 1;
132
			hrtimer_restart(&ctx->tmr);
Davide Libenzi's avatar
Davide Libenzi committed
133 134 135
		}
		ctx->expired = 0;
		ctx->ticks = 0;
136
	}
137
	spin_unlock_irq(&ctx->wqh.lock);
138
	if (ticks)
139
		res = put_user(ticks, (u64 __user *) buf) ? -EFAULT: sizeof(ticks);
140 141 142 143 144 145 146
	return res;
}

static const struct file_operations timerfd_fops = {
	.release	= timerfd_release,
	.poll		= timerfd_poll,
	.read		= timerfd_read,
147
	.llseek		= noop_llseek,
148 149
};

Davide Libenzi's avatar
Davide Libenzi committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
static struct file *timerfd_fget(int fd)
{
	struct file *file;

	file = fget(fd);
	if (!file)
		return ERR_PTR(-EBADF);
	if (file->f_op != &timerfd_fops) {
		fput(file);
		return ERR_PTR(-EINVAL);
	}

	return file;
}

165
SYSCALL_DEFINE2(timerfd_create, int, clockid, int, flags)
166
{
167
	int ufd;
168 169
	struct timerfd_ctx *ctx;

170 171 172 173
	/* Check the TFD_* constants for consistency.  */
	BUILD_BUG_ON(TFD_CLOEXEC != O_CLOEXEC);
	BUILD_BUG_ON(TFD_NONBLOCK != O_NONBLOCK);

Davide Libenzi's avatar
Davide Libenzi committed
174 175 176
	if ((flags & ~TFD_CREATE_FLAGS) ||
	    (clockid != CLOCK_MONOTONIC &&
	     clockid != CLOCK_REALTIME))
177
		return -EINVAL;
Davide Libenzi's avatar
Davide Libenzi committed
178 179 180 181 182 183 184 185 186

	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
	if (!ctx)
		return -ENOMEM;

	init_waitqueue_head(&ctx->wqh);
	ctx->clockid = clockid;
	hrtimer_init(&ctx->tmr, clockid, HRTIMER_MODE_ABS);

187
	ufd = anon_inode_getfd("[timerfd]", &timerfd_fops, ctx,
188
			       O_RDWR | (flags & TFD_SHARED_FCNTL_FLAGS));
189
	if (ufd < 0)
Davide Libenzi's avatar
Davide Libenzi committed
190 191 192 193 194
		kfree(ctx);

	return ufd;
}

195 196 197
SYSCALL_DEFINE4(timerfd_settime, int, ufd, int, flags,
		const struct itimerspec __user *, utmr,
		struct itimerspec __user *, otmr)
Davide Libenzi's avatar
Davide Libenzi committed
198 199 200 201 202 203 204 205
{
	struct file *file;
	struct timerfd_ctx *ctx;
	struct itimerspec ktmr, kotmr;

	if (copy_from_user(&ktmr, utmr, sizeof(ktmr)))
		return -EFAULT;

Davide Libenzi's avatar
Davide Libenzi committed
206 207
	if ((flags & ~TFD_SETTIME_FLAGS) ||
	    !timespec_valid(&ktmr.it_value) ||
208 209 210
	    !timespec_valid(&ktmr.it_interval))
		return -EINVAL;

Davide Libenzi's avatar
Davide Libenzi committed
211 212 213 214
	file = timerfd_fget(ufd);
	if (IS_ERR(file))
		return PTR_ERR(file);
	ctx = file->private_data;
215

Davide Libenzi's avatar
Davide Libenzi committed
216 217 218 219 220 221 222 223
	/*
	 * We need to stop the existing timer before reprogramming
	 * it to the new values.
	 */
	for (;;) {
		spin_lock_irq(&ctx->wqh.lock);
		if (hrtimer_try_to_cancel(&ctx->tmr) >= 0)
			break;
224
		spin_unlock_irq(&ctx->wqh.lock);
Davide Libenzi's avatar
Davide Libenzi committed
225
		cpu_relax();
226 227
	}

Davide Libenzi's avatar
Davide Libenzi committed
228 229 230 231 232 233 234 235
	/*
	 * If the timer is expired and it's periodic, we need to advance it
	 * because the caller may want to know the previous expiration time.
	 * We do not update "ticks" and "expired" since the timer will be
	 * re-programmed again in the following timerfd_setup() call.
	 */
	if (ctx->expired && ctx->tintv.tv64)
		hrtimer_forward_now(&ctx->tmr, ctx->tintv);
236

Davide Libenzi's avatar
Davide Libenzi committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
	kotmr.it_value = ktime_to_timespec(timerfd_get_remaining(ctx));
	kotmr.it_interval = ktime_to_timespec(ctx->tintv);

	/*
	 * Re-program the timer to the new value ...
	 */
	timerfd_setup(ctx, flags, &ktmr);

	spin_unlock_irq(&ctx->wqh.lock);
	fput(file);
	if (otmr && copy_to_user(otmr, &kotmr, sizeof(kotmr)))
		return -EFAULT;

	return 0;
}

253
SYSCALL_DEFINE2(timerfd_gettime, int, ufd, struct itimerspec __user *, otmr)
Davide Libenzi's avatar
Davide Libenzi committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
{
	struct file *file;
	struct timerfd_ctx *ctx;
	struct itimerspec kotmr;

	file = timerfd_fget(ufd);
	if (IS_ERR(file))
		return PTR_ERR(file);
	ctx = file->private_data;

	spin_lock_irq(&ctx->wqh.lock);
	if (ctx->expired && ctx->tintv.tv64) {
		ctx->expired = 0;
		ctx->ticks +=
			hrtimer_forward_now(&ctx->tmr, ctx->tintv) - 1;
		hrtimer_restart(&ctx->tmr);
	}
	kotmr.it_value = ktime_to_timespec(timerfd_get_remaining(ctx));
	kotmr.it_interval = ktime_to_timespec(ctx->tintv);
	spin_unlock_irq(&ctx->wqh.lock);
	fput(file);

	return copy_to_user(otmr, &kotmr, sizeof(kotmr)) ? -EFAULT: 0;
277 278
}