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