blob: eca0f5593a7531844b698ab38df57d55c7553bea [file] [log] [blame]
Thomas Gleixnerc0a31322006-01-09 20:52:32 -08001/*
2 * linux/kernel/hrtimer.c
3 *
Thomas Gleixner3c8aa392007-02-16 01:27:50 -08004 * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
5 * Copyright(C) 2005-2006, Red Hat, Inc., Ingo Molnar
6 * Copyright(C) 2006 Timesys Corp., Thomas Gleixner <tglx@timesys.com>
Thomas Gleixnerc0a31322006-01-09 20:52:32 -08007 *
8 * High-resolution kernel timers
9 *
10 * In contrast to the low-resolution timeout API implemented in
11 * kernel/timer.c, hrtimers provide finer resolution and accuracy
12 * depending on system configuration and capabilities.
13 *
14 * These timers are currently used for:
15 * - itimers
16 * - POSIX timers
17 * - nanosleep
18 * - precise in-kernel timing
19 *
20 * Started by: Thomas Gleixner and Ingo Molnar
21 *
22 * Credits:
23 * based on kernel/timer.c
24 *
Thomas Gleixner66188fa2006-02-01 03:05:13 -080025 * Help, testing, suggestions, bugfixes, improvements were
26 * provided by:
27 *
28 * George Anzinger, Andrew Morton, Steven Rostedt, Roman Zippel
29 * et. al.
30 *
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080031 * For licencing details see kernel-base/COPYING
32 */
33
34#include <linux/cpu.h>
35#include <linux/module.h>
36#include <linux/percpu.h>
37#include <linux/hrtimer.h>
38#include <linux/notifier.h>
39#include <linux/syscalls.h>
40#include <linux/interrupt.h>
41
42#include <asm/uaccess.h>
43
44/**
45 * ktime_get - get the monotonic time in ktime_t format
46 *
47 * returns the time in ktime_t format
48 */
49static ktime_t ktime_get(void)
50{
51 struct timespec now;
52
53 ktime_get_ts(&now);
54
55 return timespec_to_ktime(now);
56}
57
58/**
59 * ktime_get_real - get the real (wall-) time in ktime_t format
60 *
61 * returns the time in ktime_t format
62 */
63static ktime_t ktime_get_real(void)
64{
65 struct timespec now;
66
67 getnstimeofday(&now);
68
69 return timespec_to_ktime(now);
70}
71
72EXPORT_SYMBOL_GPL(ktime_get_real);
73
74/*
75 * The timer bases:
George Anzinger7978672c2006-02-01 03:05:11 -080076 *
77 * Note: If we want to add new timer bases, we have to skip the two
78 * clock ids captured by the cpu-timers. We do this by holding empty
79 * entries rather than doing math adjustment of the clock ids.
80 * This ensures that we capture erroneous accesses to these clock ids
81 * rather than moving them into the range of valid clock id's.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080082 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -080083static DEFINE_PER_CPU(struct hrtimer_cpu_base, hrtimer_bases) =
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080084{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -080085
86 .clock_base =
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080087 {
Thomas Gleixner3c8aa392007-02-16 01:27:50 -080088 {
89 .index = CLOCK_REALTIME,
90 .get_time = &ktime_get_real,
91 .resolution = KTIME_REALTIME_RES,
92 },
93 {
94 .index = CLOCK_MONOTONIC,
95 .get_time = &ktime_get,
96 .resolution = KTIME_MONOTONIC_RES,
97 },
98 }
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080099};
100
101/**
102 * ktime_get_ts - get the monotonic clock in timespec format
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800103 * @ts: pointer to timespec variable
104 *
105 * The function calculates the monotonic clock from the realtime
106 * clock and the wall_to_monotonic offset and stores the result
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800107 * in normalized timespec format in the variable pointed to by @ts.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800108 */
109void ktime_get_ts(struct timespec *ts)
110{
111 struct timespec tomono;
112 unsigned long seq;
113
114 do {
115 seq = read_seqbegin(&xtime_lock);
116 getnstimeofday(ts);
117 tomono = wall_to_monotonic;
118
119 } while (read_seqretry(&xtime_lock, seq));
120
121 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
122 ts->tv_nsec + tomono.tv_nsec);
123}
Matt Helsley69778e32006-01-09 20:52:39 -0800124EXPORT_SYMBOL_GPL(ktime_get_ts);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800125
126/*
Thomas Gleixner92127c72006-03-26 01:38:05 -0800127 * Get the coarse grained time at the softirq based on xtime and
128 * wall_to_monotonic.
129 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800130static void hrtimer_get_softirq_time(struct hrtimer_cpu_base *base)
Thomas Gleixner92127c72006-03-26 01:38:05 -0800131{
132 ktime_t xtim, tomono;
john stultzf4304ab2007-02-16 01:27:26 -0800133 struct timespec xts;
Thomas Gleixner92127c72006-03-26 01:38:05 -0800134 unsigned long seq;
135
136 do {
137 seq = read_seqbegin(&xtime_lock);
john stultzf4304ab2007-02-16 01:27:26 -0800138#ifdef CONFIG_NO_HZ
139 getnstimeofday(&xts);
140#else
141 xts = xtime;
142#endif
Thomas Gleixner92127c72006-03-26 01:38:05 -0800143 } while (read_seqretry(&xtime_lock, seq));
144
john stultzf4304ab2007-02-16 01:27:26 -0800145 xtim = timespec_to_ktime(xts);
146 tomono = timespec_to_ktime(wall_to_monotonic);
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800147 base->clock_base[CLOCK_REALTIME].softirq_time = xtim;
148 base->clock_base[CLOCK_MONOTONIC].softirq_time =
149 ktime_add(xtim, tomono);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800150}
151
152/*
Thomas Gleixner303e9672007-02-16 01:27:51 -0800153 * Helper function to check, whether the timer is on one of the queues
154 */
155static inline int hrtimer_is_queued(struct hrtimer *timer)
156{
157 return timer->state & HRTIMER_STATE_ENQUEUED;
158}
159
160/*
161 * Helper function to check, whether the timer is running the callback
162 * function
163 */
164static inline int hrtimer_callback_running(struct hrtimer *timer)
165{
166 return timer->state & HRTIMER_STATE_CALLBACK;
167}
168
169/*
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800170 * Functions and macros which are different for UP/SMP systems are kept in a
171 * single place
172 */
173#ifdef CONFIG_SMP
174
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800175/*
176 * We are using hashed locking: holding per_cpu(hrtimer_bases)[n].lock
177 * means that all timers which are tied to this base via timer->base are
178 * locked, and the base itself is locked too.
179 *
180 * So __run_timers/migrate_timers can safely modify all timers which could
181 * be found on the lists/queues.
182 *
183 * When the timer's base is locked, and the timer removed from list, it is
184 * possible to set timer->base = NULL and drop the lock: the timer remains
185 * locked.
186 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800187static
188struct hrtimer_clock_base *lock_hrtimer_base(const struct hrtimer *timer,
189 unsigned long *flags)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800190{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800191 struct hrtimer_clock_base *base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800192
193 for (;;) {
194 base = timer->base;
195 if (likely(base != NULL)) {
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800196 spin_lock_irqsave(&base->cpu_base->lock, *flags);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800197 if (likely(base == timer->base))
198 return base;
199 /* The timer has migrated to another CPU: */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800200 spin_unlock_irqrestore(&base->cpu_base->lock, *flags);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800201 }
202 cpu_relax();
203 }
204}
205
206/*
207 * Switch the timer base to the current CPU when possible.
208 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800209static inline struct hrtimer_clock_base *
210switch_hrtimer_base(struct hrtimer *timer, struct hrtimer_clock_base *base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800211{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800212 struct hrtimer_clock_base *new_base;
213 struct hrtimer_cpu_base *new_cpu_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800214
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800215 new_cpu_base = &__get_cpu_var(hrtimer_bases);
216 new_base = &new_cpu_base->clock_base[base->index];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800217
218 if (base != new_base) {
219 /*
220 * We are trying to schedule the timer on the local CPU.
221 * However we can't change timer's base while it is running,
222 * so we keep it on the same CPU. No hassle vs. reprogramming
223 * the event source in the high resolution case. The softirq
224 * code will take care of this when the timer function has
225 * completed. There is no conflict as we hold the lock until
226 * the timer is enqueued.
227 */
Thomas Gleixner5cfb6de2007-02-16 01:27:52 -0800228 if (unlikely(timer->state & HRTIMER_STATE_CALLBACK))
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800229 return base;
230
231 /* See the comment in lock_timer_base() */
232 timer->base = NULL;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800233 spin_unlock(&base->cpu_base->lock);
234 spin_lock(&new_base->cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800235 timer->base = new_base;
236 }
237 return new_base;
238}
239
240#else /* CONFIG_SMP */
241
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800242static inline struct hrtimer_clock_base *
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800243lock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
244{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800245 struct hrtimer_clock_base *base = timer->base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800246
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800247 spin_lock_irqsave(&base->cpu_base->lock, *flags);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800248
249 return base;
250}
251
252#define switch_hrtimer_base(t, b) (b)
253
254#endif /* !CONFIG_SMP */
255
256/*
257 * Functions for the union type storage format of ktime_t which are
258 * too large for inlining:
259 */
260#if BITS_PER_LONG < 64
261# ifndef CONFIG_KTIME_SCALAR
262/**
263 * ktime_add_ns - Add a scalar nanoseconds value to a ktime_t variable
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800264 * @kt: addend
265 * @nsec: the scalar nsec value to add
266 *
267 * Returns the sum of kt and nsec in ktime_t format
268 */
269ktime_t ktime_add_ns(const ktime_t kt, u64 nsec)
270{
271 ktime_t tmp;
272
273 if (likely(nsec < NSEC_PER_SEC)) {
274 tmp.tv64 = nsec;
275 } else {
276 unsigned long rem = do_div(nsec, NSEC_PER_SEC);
277
278 tmp = ktime_set((long)nsec, rem);
279 }
280
281 return ktime_add(kt, tmp);
282}
283
284#else /* CONFIG_KTIME_SCALAR */
285
286# endif /* !CONFIG_KTIME_SCALAR */
287
288/*
289 * Divide a ktime value by a nanosecond value
290 */
Roman Zippeldf869b62006-03-26 01:38:11 -0800291static unsigned long ktime_divns(const ktime_t kt, s64 div)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800292{
293 u64 dclc, inc, dns;
294 int sft = 0;
295
296 dclc = dns = ktime_to_ns(kt);
297 inc = div;
298 /* Make sure the divisor is less than 2^32: */
299 while (div >> 32) {
300 sft++;
301 div >>= 1;
302 }
303 dclc >>= sft;
304 do_div(dclc, (unsigned long) div);
305
306 return (unsigned long) dclc;
307}
308
309#else /* BITS_PER_LONG < 64 */
310# define ktime_divns(kt, div) (unsigned long)((kt).tv64 / (div))
311#endif /* BITS_PER_LONG >= 64 */
312
313/*
John Stultz411187f2007-02-16 01:27:30 -0800314 * Timekeeping resumed notification
315 */
316void hrtimer_notify_resume(void)
317{
318 clock_was_set();
319}
320
321/*
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800322 * Counterpart to lock_timer_base above:
323 */
324static inline
325void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
326{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800327 spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800328}
329
330/**
331 * hrtimer_forward - forward the timer expiry
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800332 * @timer: hrtimer to forward
Roman Zippel44f21472006-03-26 01:38:06 -0800333 * @now: forward past this time
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800334 * @interval: the interval to forward
335 *
336 * Forward the timer expiry so it will expire in the future.
Jonathan Corbet8dca6f32006-01-16 15:58:55 -0700337 * Returns the number of overruns.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800338 */
339unsigned long
Roman Zippel44f21472006-03-26 01:38:06 -0800340hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800341{
342 unsigned long orun = 1;
Roman Zippel44f21472006-03-26 01:38:06 -0800343 ktime_t delta;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800344
345 delta = ktime_sub(now, timer->expires);
346
347 if (delta.tv64 < 0)
348 return 0;
349
Thomas Gleixnerc9db4fa2006-01-12 11:47:34 +0100350 if (interval.tv64 < timer->base->resolution.tv64)
351 interval.tv64 = timer->base->resolution.tv64;
352
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800353 if (unlikely(delta.tv64 >= interval.tv64)) {
Roman Zippeldf869b62006-03-26 01:38:11 -0800354 s64 incr = ktime_to_ns(interval);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800355
356 orun = ktime_divns(delta, incr);
357 timer->expires = ktime_add_ns(timer->expires, incr * orun);
358 if (timer->expires.tv64 > now.tv64)
359 return orun;
360 /*
361 * This (and the ktime_add() below) is the
362 * correction for exact:
363 */
364 orun++;
365 }
366 timer->expires = ktime_add(timer->expires, interval);
367
368 return orun;
369}
370
371/*
372 * enqueue_hrtimer - internal function to (re)start a timer
373 *
374 * The timer is inserted in expiry order. Insertion into the
375 * red black tree is O(log(n)). Must hold the base lock.
376 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800377static void enqueue_hrtimer(struct hrtimer *timer,
378 struct hrtimer_clock_base *base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800379{
380 struct rb_node **link = &base->active.rb_node;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800381 struct rb_node *parent = NULL;
382 struct hrtimer *entry;
383
384 /*
385 * Find the right place in the rbtree:
386 */
387 while (*link) {
388 parent = *link;
389 entry = rb_entry(parent, struct hrtimer, node);
390 /*
391 * We dont care about collisions. Nodes with
392 * the same expiry time stay together.
393 */
394 if (timer->expires.tv64 < entry->expires.tv64)
395 link = &(*link)->rb_left;
Thomas Gleixner288867e2006-01-12 11:25:54 +0100396 else
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800397 link = &(*link)->rb_right;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800398 }
399
400 /*
Thomas Gleixner288867e2006-01-12 11:25:54 +0100401 * Insert the timer to the rbtree and check whether it
402 * replaces the first pending timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800403 */
404 rb_link_node(&timer->node, parent, link);
405 rb_insert_color(&timer->node, &base->active);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800406 /*
407 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
408 * state of a possibly running callback.
409 */
410 timer->state |= HRTIMER_STATE_ENQUEUED;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800411
Thomas Gleixner288867e2006-01-12 11:25:54 +0100412 if (!base->first || timer->expires.tv64 <
413 rb_entry(base->first, struct hrtimer, node)->expires.tv64)
414 base->first = &timer->node;
415}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800416
417/*
418 * __remove_hrtimer - internal function to remove a timer
419 *
420 * Caller must hold the base lock.
421 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800422static void __remove_hrtimer(struct hrtimer *timer,
Thomas Gleixner303e9672007-02-16 01:27:51 -0800423 struct hrtimer_clock_base *base,
424 unsigned long newstate)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800425{
426 /*
Thomas Gleixner288867e2006-01-12 11:25:54 +0100427 * Remove the timer from the rbtree and replace the
428 * first entry pointer if necessary.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800429 */
Thomas Gleixner288867e2006-01-12 11:25:54 +0100430 if (base->first == &timer->node)
431 base->first = rb_next(&timer->node);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800432 rb_erase(&timer->node, &base->active);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800433 timer->state = newstate;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800434}
435
436/*
437 * remove hrtimer, called with base lock held
438 */
439static inline int
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800440remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800441{
Thomas Gleixner303e9672007-02-16 01:27:51 -0800442 if (hrtimer_is_queued(timer)) {
443 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800444 return 1;
445 }
446 return 0;
447}
448
449/**
450 * hrtimer_start - (re)start an relative timer on the current CPU
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800451 * @timer: the timer to be added
452 * @tim: expiry time
453 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
454 *
455 * Returns:
456 * 0 on success
457 * 1 when the timer was active
458 */
459int
460hrtimer_start(struct hrtimer *timer, ktime_t tim, const enum hrtimer_mode mode)
461{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800462 struct hrtimer_clock_base *base, *new_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800463 unsigned long flags;
464 int ret;
465
466 base = lock_hrtimer_base(timer, &flags);
467
468 /* Remove an active timer from the queue: */
469 ret = remove_hrtimer(timer, base);
470
471 /* Switch the timer base, if necessary: */
472 new_base = switch_hrtimer_base(timer, base);
473
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800474 if (mode == HRTIMER_MODE_REL) {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800475 tim = ktime_add(tim, new_base->get_time());
Ingo Molnar06027bd2006-02-14 13:53:15 -0800476 /*
477 * CONFIG_TIME_LOW_RES is a temporary way for architectures
478 * to signal that they simply return xtime in
479 * do_gettimeoffset(). In this case we want to round up by
480 * resolution when starting a relative timer, to avoid short
481 * timeouts. This will go away with the GTOD framework.
482 */
483#ifdef CONFIG_TIME_LOW_RES
484 tim = ktime_add(tim, base->resolution);
485#endif
486 }
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800487 timer->expires = tim;
488
489 enqueue_hrtimer(timer, new_base);
490
491 unlock_hrtimer_base(timer, &flags);
492
493 return ret;
494}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700495EXPORT_SYMBOL_GPL(hrtimer_start);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800496
497/**
498 * hrtimer_try_to_cancel - try to deactivate a timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800499 * @timer: hrtimer to stop
500 *
501 * Returns:
502 * 0 when the timer was not active
503 * 1 when the timer was active
504 * -1 when the timer is currently excuting the callback function and
Randy Dunlapfa9799e2006-06-25 05:49:15 -0700505 * cannot be stopped
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800506 */
507int hrtimer_try_to_cancel(struct hrtimer *timer)
508{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800509 struct hrtimer_clock_base *base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800510 unsigned long flags;
511 int ret = -1;
512
513 base = lock_hrtimer_base(timer, &flags);
514
Thomas Gleixner303e9672007-02-16 01:27:51 -0800515 if (!hrtimer_callback_running(timer))
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800516 ret = remove_hrtimer(timer, base);
517
518 unlock_hrtimer_base(timer, &flags);
519
520 return ret;
521
522}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700523EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800524
525/**
526 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800527 * @timer: the timer to be cancelled
528 *
529 * Returns:
530 * 0 when the timer was not active
531 * 1 when the timer was active
532 */
533int hrtimer_cancel(struct hrtimer *timer)
534{
535 for (;;) {
536 int ret = hrtimer_try_to_cancel(timer);
537
538 if (ret >= 0)
539 return ret;
Joe Korty5ef37b12006-04-10 22:54:13 -0700540 cpu_relax();
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800541 }
542}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700543EXPORT_SYMBOL_GPL(hrtimer_cancel);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800544
545/**
546 * hrtimer_get_remaining - get remaining time for the timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800547 * @timer: the timer to read
548 */
549ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
550{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800551 struct hrtimer_clock_base *base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800552 unsigned long flags;
553 ktime_t rem;
554
555 base = lock_hrtimer_base(timer, &flags);
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800556 rem = ktime_sub(timer->expires, base->get_time());
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800557 unlock_hrtimer_base(timer, &flags);
558
559 return rem;
560}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700561EXPORT_SYMBOL_GPL(hrtimer_get_remaining);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800562
Thomas Gleixnerfd064b92007-02-16 01:27:47 -0800563#if defined(CONFIG_NO_IDLE_HZ) || defined(CONFIG_NO_HZ)
Tony Lindgren69239742006-03-06 15:42:45 -0800564/**
565 * hrtimer_get_next_event - get the time until next expiry event
566 *
567 * Returns the delta to the next expiry event or KTIME_MAX if no timer
568 * is pending.
569 */
570ktime_t hrtimer_get_next_event(void)
571{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800572 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
573 struct hrtimer_clock_base *base = cpu_base->clock_base;
Tony Lindgren69239742006-03-06 15:42:45 -0800574 ktime_t delta, mindelta = { .tv64 = KTIME_MAX };
575 unsigned long flags;
576 int i;
577
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800578 spin_lock_irqsave(&cpu_base->lock, flags);
579
580 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
Tony Lindgren69239742006-03-06 15:42:45 -0800581 struct hrtimer *timer;
582
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800583 if (!base->first)
Tony Lindgren69239742006-03-06 15:42:45 -0800584 continue;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800585
Tony Lindgren69239742006-03-06 15:42:45 -0800586 timer = rb_entry(base->first, struct hrtimer, node);
587 delta.tv64 = timer->expires.tv64;
Tony Lindgren69239742006-03-06 15:42:45 -0800588 delta = ktime_sub(delta, base->get_time());
589 if (delta.tv64 < mindelta.tv64)
590 mindelta.tv64 = delta.tv64;
591 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800592
593 spin_unlock_irqrestore(&cpu_base->lock, flags);
594
Tony Lindgren69239742006-03-06 15:42:45 -0800595 if (mindelta.tv64 < 0)
596 mindelta.tv64 = 0;
597 return mindelta;
598}
599#endif
600
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800601/**
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800602 * hrtimer_init - initialize a timer to the given clock
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800603 * @timer: the timer to be initialized
604 * @clock_id: the clock to be used
George Anzinger7978672c2006-02-01 03:05:11 -0800605 * @mode: timer mode abs/rel
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800606 */
George Anzinger7978672c2006-02-01 03:05:11 -0800607void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
608 enum hrtimer_mode mode)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800609{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800610 struct hrtimer_cpu_base *cpu_base;
George Anzinger7978672c2006-02-01 03:05:11 -0800611
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800612 memset(timer, 0, sizeof(struct hrtimer));
George Anzinger7978672c2006-02-01 03:05:11 -0800613
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800614 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
George Anzinger7978672c2006-02-01 03:05:11 -0800615
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800616 if (clock_id == CLOCK_REALTIME && mode != HRTIMER_MODE_ABS)
George Anzinger7978672c2006-02-01 03:05:11 -0800617 clock_id = CLOCK_MONOTONIC;
618
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800619 timer->base = &cpu_base->clock_base[clock_id];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800620}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700621EXPORT_SYMBOL_GPL(hrtimer_init);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800622
623/**
624 * hrtimer_get_res - get the timer resolution for a clock
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800625 * @which_clock: which clock to query
626 * @tp: pointer to timespec variable to store the resolution
627 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800628 * Store the resolution of the clock selected by @which_clock in the
629 * variable pointed to by @tp.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800630 */
631int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
632{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800633 struct hrtimer_cpu_base *cpu_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800634
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800635 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
636 *tp = ktime_to_timespec(cpu_base->clock_base[which_clock].resolution);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800637
638 return 0;
639}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700640EXPORT_SYMBOL_GPL(hrtimer_get_res);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800641
642/*
643 * Expire the per base hrtimer-queue:
644 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800645static inline void run_hrtimer_queue(struct hrtimer_cpu_base *cpu_base,
646 int index)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800647{
Thomas Gleixner288867e2006-01-12 11:25:54 +0100648 struct rb_node *node;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800649 struct hrtimer_clock_base *base = &cpu_base->clock_base[index];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800650
Dimitri Sivanich3055add2006-03-31 02:31:20 -0800651 if (!base->first)
652 return;
653
Thomas Gleixner92127c72006-03-26 01:38:05 -0800654 if (base->get_softirq_time)
655 base->softirq_time = base->get_softirq_time();
656
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800657 spin_lock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800658
Thomas Gleixner288867e2006-01-12 11:25:54 +0100659 while ((node = base->first)) {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800660 struct hrtimer *timer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800661 enum hrtimer_restart (*fn)(struct hrtimer *);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800662 int restart;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800663
Thomas Gleixner288867e2006-01-12 11:25:54 +0100664 timer = rb_entry(node, struct hrtimer, node);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800665 if (base->softirq_time.tv64 <= timer->expires.tv64)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800666 break;
667
668 fn = timer->function;
Thomas Gleixner303e9672007-02-16 01:27:51 -0800669 __remove_hrtimer(timer, base, HRTIMER_STATE_CALLBACK);
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800670 spin_unlock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800671
Roman Zippel05cfb612006-03-26 01:38:12 -0800672 restart = fn(timer);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800673
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800674 spin_lock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800675
Thomas Gleixner303e9672007-02-16 01:27:51 -0800676 timer->state &= ~HRTIMER_STATE_CALLBACK;
Roman Zippelb75f7a52006-03-26 01:38:09 -0800677 if (restart != HRTIMER_NORESTART) {
678 BUG_ON(hrtimer_active(timer));
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800679 enqueue_hrtimer(timer, base);
Roman Zippelb75f7a52006-03-26 01:38:09 -0800680 }
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800681 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800682 spin_unlock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800683}
684
685/*
686 * Called from timer softirq every jiffy, expire hrtimers:
687 */
688void hrtimer_run_queues(void)
689{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800690 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800691 int i;
692
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800693 hrtimer_get_softirq_time(cpu_base);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800694
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800695 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
696 run_hrtimer_queue(cpu_base, i);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800697}
698
699/*
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800700 * Sleep related functions:
701 */
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800702static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
Thomas Gleixner00362e32006-03-31 02:31:17 -0800703{
704 struct hrtimer_sleeper *t =
705 container_of(timer, struct hrtimer_sleeper, timer);
706 struct task_struct *task = t->task;
707
708 t->task = NULL;
709 if (task)
710 wake_up_process(task);
711
712 return HRTIMER_NORESTART;
713}
714
Ingo Molnar36c8b582006-07-03 00:25:41 -0700715void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
Thomas Gleixner00362e32006-03-31 02:31:17 -0800716{
717 sl->timer.function = hrtimer_wakeup;
718 sl->task = task;
719}
720
Thomas Gleixner669d7862006-03-31 02:31:19 -0800721static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800722{
Thomas Gleixner669d7862006-03-31 02:31:19 -0800723 hrtimer_init_sleeper(t, current);
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800724
Roman Zippel432569b2006-03-26 01:38:08 -0800725 do {
726 set_current_state(TASK_INTERRUPTIBLE);
727 hrtimer_start(&t->timer, t->timer.expires, mode);
728
729 schedule();
730
Thomas Gleixner669d7862006-03-31 02:31:19 -0800731 hrtimer_cancel(&t->timer);
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800732 mode = HRTIMER_MODE_ABS;
Roman Zippel432569b2006-03-26 01:38:08 -0800733
Thomas Gleixner669d7862006-03-31 02:31:19 -0800734 } while (t->task && !signal_pending(current));
735
736 return t->task == NULL;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800737}
738
Toyo Abe1711ef32006-09-29 02:00:28 -0700739long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800740{
Thomas Gleixner669d7862006-03-31 02:31:19 -0800741 struct hrtimer_sleeper t;
Ingo Molnarea13dbc2006-01-16 10:59:41 +0100742 struct timespec __user *rmtp;
743 struct timespec tu;
Roman Zippel432569b2006-03-26 01:38:08 -0800744 ktime_t time;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800745
746 restart->fn = do_no_restart_syscall;
747
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800748 hrtimer_init(&t.timer, restart->arg0, HRTIMER_MODE_ABS);
Toyo Abe1711ef32006-09-29 02:00:28 -0700749 t.timer.expires.tv64 = ((u64)restart->arg3 << 32) | (u64) restart->arg2;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800750
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800751 if (do_nanosleep(&t, HRTIMER_MODE_ABS))
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800752 return 0;
753
Toyo Abe1711ef32006-09-29 02:00:28 -0700754 rmtp = (struct timespec __user *) restart->arg1;
Roman Zippel432569b2006-03-26 01:38:08 -0800755 if (rmtp) {
756 time = ktime_sub(t.timer.expires, t.timer.base->get_time());
757 if (time.tv64 <= 0)
758 return 0;
759 tu = ktime_to_timespec(time);
760 if (copy_to_user(rmtp, &tu, sizeof(tu)))
761 return -EFAULT;
762 }
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800763
Toyo Abe1711ef32006-09-29 02:00:28 -0700764 restart->fn = hrtimer_nanosleep_restart;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800765
766 /* The other values in restart are already filled in */
767 return -ERESTART_RESTARTBLOCK;
768}
769
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800770long hrtimer_nanosleep(struct timespec *rqtp, struct timespec __user *rmtp,
771 const enum hrtimer_mode mode, const clockid_t clockid)
772{
773 struct restart_block *restart;
Thomas Gleixner669d7862006-03-31 02:31:19 -0800774 struct hrtimer_sleeper t;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800775 struct timespec tu;
776 ktime_t rem;
777
Roman Zippel432569b2006-03-26 01:38:08 -0800778 hrtimer_init(&t.timer, clockid, mode);
779 t.timer.expires = timespec_to_ktime(*rqtp);
780 if (do_nanosleep(&t, mode))
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800781 return 0;
782
George Anzinger7978672c2006-02-01 03:05:11 -0800783 /* Absolute timers do not update the rmtp value and restart: */
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800784 if (mode == HRTIMER_MODE_ABS)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800785 return -ERESTARTNOHAND;
786
Roman Zippel432569b2006-03-26 01:38:08 -0800787 if (rmtp) {
788 rem = ktime_sub(t.timer.expires, t.timer.base->get_time());
789 if (rem.tv64 <= 0)
790 return 0;
791 tu = ktime_to_timespec(rem);
792 if (copy_to_user(rmtp, &tu, sizeof(tu)))
793 return -EFAULT;
794 }
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800795
796 restart = &current_thread_info()->restart_block;
Toyo Abe1711ef32006-09-29 02:00:28 -0700797 restart->fn = hrtimer_nanosleep_restart;
798 restart->arg0 = (unsigned long) t.timer.base->index;
799 restart->arg1 = (unsigned long) rmtp;
800 restart->arg2 = t.timer.expires.tv64 & 0xFFFFFFFF;
801 restart->arg3 = t.timer.expires.tv64 >> 32;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800802
803 return -ERESTART_RESTARTBLOCK;
804}
805
Thomas Gleixner6ba1b912006-01-09 20:52:36 -0800806asmlinkage long
807sys_nanosleep(struct timespec __user *rqtp, struct timespec __user *rmtp)
808{
809 struct timespec tu;
810
811 if (copy_from_user(&tu, rqtp, sizeof(tu)))
812 return -EFAULT;
813
814 if (!timespec_valid(&tu))
815 return -EINVAL;
816
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800817 return hrtimer_nanosleep(&tu, rmtp, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
Thomas Gleixner6ba1b912006-01-09 20:52:36 -0800818}
819
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800820/*
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800821 * Functions related to boot-time initialization:
822 */
823static void __devinit init_hrtimers_cpu(int cpu)
824{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800825 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800826 int i;
827
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800828 spin_lock_init(&cpu_base->lock);
829 lockdep_set_class(&cpu_base->lock, &cpu_base->lock_key);
830
831 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
832 cpu_base->clock_base[i].cpu_base = cpu_base;
833
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800834}
835
836#ifdef CONFIG_HOTPLUG_CPU
837
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800838static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
839 struct hrtimer_clock_base *new_base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800840{
841 struct hrtimer *timer;
842 struct rb_node *node;
843
844 while ((node = rb_first(&old_base->active))) {
845 timer = rb_entry(node, struct hrtimer, node);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800846 BUG_ON(timer->state & HRTIMER_STATE_CALLBACK);
847 __remove_hrtimer(timer, old_base, HRTIMER_STATE_INACTIVE);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800848 timer->base = new_base;
849 enqueue_hrtimer(timer, new_base);
850 }
851}
852
853static void migrate_hrtimers(int cpu)
854{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800855 struct hrtimer_cpu_base *old_base, *new_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800856 int i;
857
858 BUG_ON(cpu_online(cpu));
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800859 old_base = &per_cpu(hrtimer_bases, cpu);
860 new_base = &get_cpu_var(hrtimer_bases);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800861
862 local_irq_disable();
863
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800864 spin_lock(&new_base->lock);
865 spin_lock(&old_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800866
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800867 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800868 migrate_hrtimer_list(&old_base->clock_base[i],
869 &new_base->clock_base[i]);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800870 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800871 spin_unlock(&old_base->lock);
872 spin_unlock(&new_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800873
874 local_irq_enable();
875 put_cpu_var(hrtimer_bases);
876}
877#endif /* CONFIG_HOTPLUG_CPU */
878
Chandra Seetharaman8c78f302006-07-30 03:03:35 -0700879static int __cpuinit hrtimer_cpu_notify(struct notifier_block *self,
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800880 unsigned long action, void *hcpu)
881{
882 long cpu = (long)hcpu;
883
884 switch (action) {
885
886 case CPU_UP_PREPARE:
887 init_hrtimers_cpu(cpu);
888 break;
889
890#ifdef CONFIG_HOTPLUG_CPU
891 case CPU_DEAD:
892 migrate_hrtimers(cpu);
893 break;
894#endif
895
896 default:
897 break;
898 }
899
900 return NOTIFY_OK;
901}
902
Chandra Seetharaman8c78f302006-07-30 03:03:35 -0700903static struct notifier_block __cpuinitdata hrtimers_nb = {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800904 .notifier_call = hrtimer_cpu_notify,
905};
906
907void __init hrtimers_init(void)
908{
909 hrtimer_cpu_notify(&hrtimers_nb, (unsigned long)CPU_UP_PREPARE,
910 (void *)(long)smp_processor_id());
911 register_cpu_notifier(&hrtimers_nb);
912}
913