]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - fs/timerfd.c
docs: Procfs -- Document timerfd output
[mirror_ubuntu-artful-kernel.git] / fs / timerfd.c
CommitLineData
b215e283
DL
1/*
2 * fs/timerfd.c
3 *
4 * Copyright (C) 2007 Davide Libenzi <davidel@xmailserver.org>
5 *
6 *
7 * Thanks to Thomas Gleixner for code reviews and useful comments.
8 *
9 */
10
11ffa9d6 11#include <linux/alarmtimer.h>
b215e283
DL
12#include <linux/file.h>
13#include <linux/poll.h>
14#include <linux/init.h>
15#include <linux/fs.h>
16#include <linux/sched.h>
17#include <linux/kernel.h>
5a0e3ad6 18#include <linux/slab.h>
b215e283
DL
19#include <linux/list.h>
20#include <linux/spinlock.h>
21#include <linux/time.h>
22#include <linux/hrtimer.h>
23#include <linux/anon_inodes.h>
24#include <linux/timerfd.h>
45cc2b96 25#include <linux/syscalls.h>
9d94b9e2 26#include <linux/compat.h>
9ec26907 27#include <linux/rcupdate.h>
b215e283
DL
28
29struct timerfd_ctx {
11ffa9d6
TP
30 union {
31 struct hrtimer tmr;
32 struct alarm alarm;
33 } t;
b215e283 34 ktime_t tintv;
99ee5315 35 ktime_t moffs;
b215e283 36 wait_queue_head_t wqh;
4d672e7a 37 u64 ticks;
4d672e7a 38 int clockid;
af9c4957
CG
39 short unsigned expired;
40 short unsigned settime_flags; /* to show in fdinfo */
9ec26907
TG
41 struct rcu_head rcu;
42 struct list_head clist;
99ee5315 43 bool might_cancel;
b215e283
DL
44};
45
9ec26907
TG
46static LIST_HEAD(cancel_list);
47static DEFINE_SPINLOCK(cancel_lock);
48
11ffa9d6
TP
49static inline bool isalarm(struct timerfd_ctx *ctx)
50{
51 return ctx->clockid == CLOCK_REALTIME_ALARM ||
52 ctx->clockid == CLOCK_BOOTTIME_ALARM;
53}
54
b215e283
DL
55/*
56 * This gets called when the timer event triggers. We set the "expired"
57 * flag, but we do not re-arm the timer (in case it's necessary,
4d672e7a 58 * tintv.tv64 != 0) until the timer is accessed.
b215e283 59 */
11ffa9d6 60static void timerfd_triggered(struct timerfd_ctx *ctx)
b215e283 61{
b215e283
DL
62 unsigned long flags;
63
18963c01 64 spin_lock_irqsave(&ctx->wqh.lock, flags);
b215e283 65 ctx->expired = 1;
4d672e7a 66 ctx->ticks++;
b215e283 67 wake_up_locked(&ctx->wqh);
18963c01 68 spin_unlock_irqrestore(&ctx->wqh.lock, flags);
11ffa9d6 69}
b215e283 70
11ffa9d6
TP
71static enum hrtimer_restart timerfd_tmrproc(struct hrtimer *htmr)
72{
73 struct timerfd_ctx *ctx = container_of(htmr, struct timerfd_ctx,
74 t.tmr);
75 timerfd_triggered(ctx);
b215e283
DL
76 return HRTIMER_NORESTART;
77}
78
11ffa9d6
TP
79static enum alarmtimer_restart timerfd_alarmproc(struct alarm *alarm,
80 ktime_t now)
81{
82 struct timerfd_ctx *ctx = container_of(alarm, struct timerfd_ctx,
83 t.alarm);
84 timerfd_triggered(ctx);
85 return ALARMTIMER_NORESTART;
86}
87
9ec26907
TG
88/*
89 * Called when the clock was set to cancel the timers in the cancel
1123d939
MA
90 * list. This will wake up processes waiting on these timers. The
91 * wake-up requires ctx->ticks to be non zero, therefore we increment
92 * it before calling wake_up_locked().
9ec26907
TG
93 */
94void timerfd_clock_was_set(void)
4d672e7a 95{
9ec26907
TG
96 ktime_t moffs = ktime_get_monotonic_offset();
97 struct timerfd_ctx *ctx;
98 unsigned long flags;
4d672e7a 99
9ec26907
TG
100 rcu_read_lock();
101 list_for_each_entry_rcu(ctx, &cancel_list, clist) {
102 if (!ctx->might_cancel)
103 continue;
104 spin_lock_irqsave(&ctx->wqh.lock, flags);
105 if (ctx->moffs.tv64 != moffs.tv64) {
106 ctx->moffs.tv64 = KTIME_MAX;
1123d939 107 ctx->ticks++;
9ec26907
TG
108 wake_up_locked(&ctx->wqh);
109 }
110 spin_unlock_irqrestore(&ctx->wqh.lock, flags);
111 }
112 rcu_read_unlock();
4d672e7a
DL
113}
114
9ec26907 115static void timerfd_remove_cancel(struct timerfd_ctx *ctx)
99ee5315 116{
9ec26907
TG
117 if (ctx->might_cancel) {
118 ctx->might_cancel = false;
119 spin_lock(&cancel_lock);
120 list_del_rcu(&ctx->clist);
121 spin_unlock(&cancel_lock);
122 }
123}
99ee5315 124
9ec26907
TG
125static bool timerfd_canceled(struct timerfd_ctx *ctx)
126{
127 if (!ctx->might_cancel || ctx->moffs.tv64 != KTIME_MAX)
99ee5315 128 return false;
9ec26907
TG
129 ctx->moffs = ktime_get_monotonic_offset();
130 return true;
131}
99ee5315 132
9ec26907
TG
133static void timerfd_setup_cancel(struct timerfd_ctx *ctx, int flags)
134{
11ffa9d6
TP
135 if ((ctx->clockid == CLOCK_REALTIME ||
136 ctx->clockid == CLOCK_REALTIME_ALARM) &&
137 (flags & TFD_TIMER_ABSTIME) && (flags & TFD_TIMER_CANCEL_ON_SET)) {
9ec26907
TG
138 if (!ctx->might_cancel) {
139 ctx->might_cancel = true;
140 spin_lock(&cancel_lock);
141 list_add_rcu(&ctx->clist, &cancel_list);
142 spin_unlock(&cancel_lock);
143 }
144 } else if (ctx->might_cancel) {
145 timerfd_remove_cancel(ctx);
146 }
147}
99ee5315 148
9ec26907
TG
149static ktime_t timerfd_get_remaining(struct timerfd_ctx *ctx)
150{
151 ktime_t remaining;
99ee5315 152
11ffa9d6
TP
153 if (isalarm(ctx))
154 remaining = alarm_expires_remaining(&ctx->t.alarm);
155 else
156 remaining = hrtimer_expires_remaining(&ctx->t.tmr);
157
9ec26907 158 return remaining.tv64 < 0 ? ktime_set(0, 0): remaining;
99ee5315
TG
159}
160
161static int timerfd_setup(struct timerfd_ctx *ctx, int flags,
162 const struct itimerspec *ktmr)
b215e283
DL
163{
164 enum hrtimer_mode htmode;
165 ktime_t texp;
99ee5315 166 int clockid = ctx->clockid;
b215e283
DL
167
168 htmode = (flags & TFD_TIMER_ABSTIME) ?
169 HRTIMER_MODE_ABS: HRTIMER_MODE_REL;
170
171 texp = timespec_to_ktime(ktmr->it_value);
172 ctx->expired = 0;
4d672e7a 173 ctx->ticks = 0;
b215e283 174 ctx->tintv = timespec_to_ktime(ktmr->it_interval);
11ffa9d6
TP
175
176 if (isalarm(ctx)) {
177 alarm_init(&ctx->t.alarm,
178 ctx->clockid == CLOCK_REALTIME_ALARM ?
179 ALARM_REALTIME : ALARM_BOOTTIME,
180 timerfd_alarmproc);
181 } else {
182 hrtimer_init(&ctx->t.tmr, clockid, htmode);
183 hrtimer_set_expires(&ctx->t.tmr, texp);
184 ctx->t.tmr.function = timerfd_tmrproc;
185 }
186
99ee5315 187 if (texp.tv64 != 0) {
11ffa9d6
TP
188 if (isalarm(ctx)) {
189 if (flags & TFD_TIMER_ABSTIME)
190 alarm_start(&ctx->t.alarm, texp);
191 else
192 alarm_start_relative(&ctx->t.alarm, texp);
193 } else {
194 hrtimer_start(&ctx->t.tmr, texp, htmode);
195 }
196
99ee5315
TG
197 if (timerfd_canceled(ctx))
198 return -ECANCELED;
199 }
af9c4957
CG
200
201 ctx->settime_flags = flags & TFD_SETTIME_FLAGS;
99ee5315 202 return 0;
b215e283
DL
203}
204
205static int timerfd_release(struct inode *inode, struct file *file)
206{
207 struct timerfd_ctx *ctx = file->private_data;
208
9ec26907 209 timerfd_remove_cancel(ctx);
11ffa9d6
TP
210
211 if (isalarm(ctx))
212 alarm_cancel(&ctx->t.alarm);
213 else
214 hrtimer_cancel(&ctx->t.tmr);
9ec26907 215 kfree_rcu(ctx, rcu);
b215e283
DL
216 return 0;
217}
218
219static unsigned int timerfd_poll(struct file *file, poll_table *wait)
220{
221 struct timerfd_ctx *ctx = file->private_data;
222 unsigned int events = 0;
223 unsigned long flags;
224
225 poll_wait(file, &ctx->wqh, wait);
226
18963c01 227 spin_lock_irqsave(&ctx->wqh.lock, flags);
4d672e7a 228 if (ctx->ticks)
b215e283 229 events |= POLLIN;
18963c01 230 spin_unlock_irqrestore(&ctx->wqh.lock, flags);
b215e283
DL
231
232 return events;
233}
234
235static ssize_t timerfd_read(struct file *file, char __user *buf, size_t count,
236 loff_t *ppos)
237{
238 struct timerfd_ctx *ctx = file->private_data;
239 ssize_t res;
09828402 240 u64 ticks = 0;
b215e283
DL
241
242 if (count < sizeof(ticks))
243 return -EINVAL;
18963c01 244 spin_lock_irq(&ctx->wqh.lock);
8120a8aa
MN
245 if (file->f_flags & O_NONBLOCK)
246 res = -EAGAIN;
247 else
248 res = wait_event_interruptible_locked_irq(ctx->wqh, ctx->ticks);
99ee5315 249
9ec26907
TG
250 /*
251 * If clock has changed, we do not care about the
252 * ticks and we do not rearm the timer. Userspace must
253 * reevaluate anyway.
254 */
255 if (timerfd_canceled(ctx)) {
256 ctx->ticks = 0;
257 ctx->expired = 0;
258 res = -ECANCELED;
259 }
260
4d672e7a
DL
261 if (ctx->ticks) {
262 ticks = ctx->ticks;
99ee5315 263
4d672e7a 264 if (ctx->expired && ctx->tintv.tv64) {
b215e283
DL
265 /*
266 * If tintv.tv64 != 0, this is a periodic timer that
267 * needs to be re-armed. We avoid doing it in the timer
268 * callback to avoid DoS attacks specifying a very
269 * short timer period.
270 */
11ffa9d6
TP
271 if (isalarm(ctx)) {
272 ticks += alarm_forward_now(
273 &ctx->t.alarm, ctx->tintv) - 1;
274 alarm_restart(&ctx->t.alarm);
275 } else {
276 ticks += hrtimer_forward_now(&ctx->t.tmr,
277 ctx->tintv) - 1;
278 hrtimer_restart(&ctx->t.tmr);
279 }
4d672e7a
DL
280 }
281 ctx->expired = 0;
282 ctx->ticks = 0;
b215e283 283 }
18963c01 284 spin_unlock_irq(&ctx->wqh.lock);
b215e283 285 if (ticks)
09828402 286 res = put_user(ticks, (u64 __user *) buf) ? -EFAULT: sizeof(ticks);
b215e283
DL
287 return res;
288}
289
af9c4957
CG
290#ifdef CONFIG_PROC_FS
291static int timerfd_show(struct seq_file *m, struct file *file)
292{
293 struct timerfd_ctx *ctx = file->private_data;
294 struct itimerspec t;
295
296 spin_lock_irq(&ctx->wqh.lock);
297 t.it_value = ktime_to_timespec(timerfd_get_remaining(ctx));
298 t.it_interval = ktime_to_timespec(ctx->tintv);
299 spin_unlock_irq(&ctx->wqh.lock);
300
301 return seq_printf(m,
302 "clockid: %d\n"
303 "ticks: %llu\n"
304 "settime flags: 0%o\n"
305 "it_value: (%llu, %llu)\n"
306 "it_interval: (%llu, %llu)\n",
307 ctx->clockid, (unsigned long long)ctx->ticks,
308 ctx->settime_flags,
309 (unsigned long long)t.it_value.tv_sec,
310 (unsigned long long)t.it_value.tv_nsec,
311 (unsigned long long)t.it_interval.tv_sec,
312 (unsigned long long)t.it_interval.tv_nsec);
313}
314#else
315#define timerfd_show NULL
316#endif
317
b215e283
DL
318static const struct file_operations timerfd_fops = {
319 .release = timerfd_release,
320 .poll = timerfd_poll,
321 .read = timerfd_read,
6038f373 322 .llseek = noop_llseek,
af9c4957 323 .show_fdinfo = timerfd_show,
b215e283
DL
324};
325
2903ff01 326static int timerfd_fget(int fd, struct fd *p)
4d672e7a 327{
2903ff01
AV
328 struct fd f = fdget(fd);
329 if (!f.file)
330 return -EBADF;
331 if (f.file->f_op != &timerfd_fops) {
332 fdput(f);
333 return -EINVAL;
4d672e7a 334 }
2903ff01
AV
335 *p = f;
336 return 0;
4d672e7a
DL
337}
338
836f92ad 339SYSCALL_DEFINE2(timerfd_create, int, clockid, int, flags)
b215e283 340{
2030a42c 341 int ufd;
b215e283 342 struct timerfd_ctx *ctx;
b215e283 343
e38b36f3
UD
344 /* Check the TFD_* constants for consistency. */
345 BUILD_BUG_ON(TFD_CLOEXEC != O_CLOEXEC);
346 BUILD_BUG_ON(TFD_NONBLOCK != O_NONBLOCK);
347
610d18f4
DL
348 if ((flags & ~TFD_CREATE_FLAGS) ||
349 (clockid != CLOCK_MONOTONIC &&
11ffa9d6
TP
350 clockid != CLOCK_REALTIME &&
351 clockid != CLOCK_REALTIME_ALARM &&
4a2378a9 352 clockid != CLOCK_BOOTTIME &&
11ffa9d6 353 clockid != CLOCK_BOOTTIME_ALARM))
b215e283 354 return -EINVAL;
4d672e7a
DL
355
356 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
357 if (!ctx)
358 return -ENOMEM;
359
360 init_waitqueue_head(&ctx->wqh);
361 ctx->clockid = clockid;
11ffa9d6
TP
362
363 if (isalarm(ctx))
364 alarm_init(&ctx->t.alarm,
365 ctx->clockid == CLOCK_REALTIME_ALARM ?
366 ALARM_REALTIME : ALARM_BOOTTIME,
367 timerfd_alarmproc);
368 else
369 hrtimer_init(&ctx->t.tmr, clockid, HRTIMER_MODE_ABS);
370
99ee5315 371 ctx->moffs = ktime_get_monotonic_offset();
4d672e7a 372
11fcb6c1 373 ufd = anon_inode_getfd("[timerfd]", &timerfd_fops, ctx,
628ff7c1 374 O_RDWR | (flags & TFD_SHARED_FCNTL_FLAGS));
2030a42c 375 if (ufd < 0)
4d672e7a 376 kfree(ctx);
4d672e7a
DL
377
378 return ufd;
379}
380
9d94b9e2
AV
381static int do_timerfd_settime(int ufd, int flags,
382 const struct itimerspec *new,
383 struct itimerspec *old)
4d672e7a 384{
2903ff01 385 struct fd f;
4d672e7a 386 struct timerfd_ctx *ctx;
2903ff01 387 int ret;
4d672e7a 388
610d18f4 389 if ((flags & ~TFD_SETTIME_FLAGS) ||
9d94b9e2
AV
390 !timespec_valid(&new->it_value) ||
391 !timespec_valid(&new->it_interval))
b215e283
DL
392 return -EINVAL;
393
2903ff01
AV
394 ret = timerfd_fget(ufd, &f);
395 if (ret)
396 return ret;
397 ctx = f.file->private_data;
b215e283 398
9ec26907
TG
399 timerfd_setup_cancel(ctx, flags);
400
4d672e7a
DL
401 /*
402 * We need to stop the existing timer before reprogramming
403 * it to the new values.
404 */
405 for (;;) {
406 spin_lock_irq(&ctx->wqh.lock);
11ffa9d6
TP
407
408 if (isalarm(ctx)) {
409 if (alarm_try_to_cancel(&ctx->t.alarm) >= 0)
410 break;
411 } else {
412 if (hrtimer_try_to_cancel(&ctx->t.tmr) >= 0)
413 break;
414 }
18963c01 415 spin_unlock_irq(&ctx->wqh.lock);
4d672e7a 416 cpu_relax();
b215e283
DL
417 }
418
4d672e7a
DL
419 /*
420 * If the timer is expired and it's periodic, we need to advance it
421 * because the caller may want to know the previous expiration time.
422 * We do not update "ticks" and "expired" since the timer will be
423 * re-programmed again in the following timerfd_setup() call.
424 */
11ffa9d6
TP
425 if (ctx->expired && ctx->tintv.tv64) {
426 if (isalarm(ctx))
427 alarm_forward_now(&ctx->t.alarm, ctx->tintv);
428 else
429 hrtimer_forward_now(&ctx->t.tmr, ctx->tintv);
430 }
b215e283 431
9d94b9e2
AV
432 old->it_value = ktime_to_timespec(timerfd_get_remaining(ctx));
433 old->it_interval = ktime_to_timespec(ctx->tintv);
4d672e7a
DL
434
435 /*
436 * Re-program the timer to the new value ...
437 */
9d94b9e2 438 ret = timerfd_setup(ctx, flags, new);
4d672e7a
DL
439
440 spin_unlock_irq(&ctx->wqh.lock);
2903ff01 441 fdput(f);
99ee5315 442 return ret;
4d672e7a
DL
443}
444
9d94b9e2 445static int do_timerfd_gettime(int ufd, struct itimerspec *t)
4d672e7a 446{
2903ff01 447 struct fd f;
4d672e7a 448 struct timerfd_ctx *ctx;
2903ff01
AV
449 int ret = timerfd_fget(ufd, &f);
450 if (ret)
451 return ret;
452 ctx = f.file->private_data;
4d672e7a
DL
453
454 spin_lock_irq(&ctx->wqh.lock);
455 if (ctx->expired && ctx->tintv.tv64) {
456 ctx->expired = 0;
11ffa9d6
TP
457
458 if (isalarm(ctx)) {
459 ctx->ticks +=
460 alarm_forward_now(
461 &ctx->t.alarm, ctx->tintv) - 1;
462 alarm_restart(&ctx->t.alarm);
463 } else {
464 ctx->ticks +=
465 hrtimer_forward_now(&ctx->t.tmr, ctx->tintv)
466 - 1;
467 hrtimer_restart(&ctx->t.tmr);
468 }
4d672e7a 469 }
9d94b9e2
AV
470 t->it_value = ktime_to_timespec(timerfd_get_remaining(ctx));
471 t->it_interval = ktime_to_timespec(ctx->tintv);
4d672e7a 472 spin_unlock_irq(&ctx->wqh.lock);
2903ff01 473 fdput(f);
9d94b9e2
AV
474 return 0;
475}
476
477SYSCALL_DEFINE4(timerfd_settime, int, ufd, int, flags,
478 const struct itimerspec __user *, utmr,
479 struct itimerspec __user *, otmr)
480{
481 struct itimerspec new, old;
482 int ret;
483
484 if (copy_from_user(&new, utmr, sizeof(new)))
485 return -EFAULT;
486 ret = do_timerfd_settime(ufd, flags, &new, &old);
487 if (ret)
488 return ret;
489 if (otmr && copy_to_user(otmr, &old, sizeof(old)))
490 return -EFAULT;
491
492 return ret;
493}
4d672e7a 494
9d94b9e2
AV
495SYSCALL_DEFINE2(timerfd_gettime, int, ufd, struct itimerspec __user *, otmr)
496{
497 struct itimerspec kotmr;
498 int ret = do_timerfd_gettime(ufd, &kotmr);
499 if (ret)
500 return ret;
4d672e7a 501 return copy_to_user(otmr, &kotmr, sizeof(kotmr)) ? -EFAULT: 0;
b215e283
DL
502}
503
0e803baf 504#ifdef CONFIG_COMPAT
9d94b9e2 505COMPAT_SYSCALL_DEFINE4(timerfd_settime, int, ufd, int, flags,
0e803baf
HC
506 const struct compat_itimerspec __user *, utmr,
507 struct compat_itimerspec __user *, otmr)
9d94b9e2
AV
508{
509 struct itimerspec new, old;
510 int ret;
511
512 if (get_compat_itimerspec(&new, utmr))
513 return -EFAULT;
514 ret = do_timerfd_settime(ufd, flags, &new, &old);
515 if (ret)
516 return ret;
517 if (otmr && put_compat_itimerspec(otmr, &old))
518 return -EFAULT;
519 return ret;
520}
521
522COMPAT_SYSCALL_DEFINE2(timerfd_gettime, int, ufd,
0e803baf 523 struct compat_itimerspec __user *, otmr)
9d94b9e2
AV
524{
525 struct itimerspec kotmr;
526 int ret = do_timerfd_gettime(ufd, &kotmr);
527 if (ret)
528 return ret;
0e803baf 529 return put_compat_itimerspec(otmr, &kotmr) ? -EFAULT: 0;
9d94b9e2
AV
530}
531#endif