blob: a2310d1bebe14bc10ba6d261bccca9168b28151e [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 */
Thomas Gleixnerd316c572007-02-16 01:28:00 -080049ktime_t ktime_get(void)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080050{
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 */
Thomas Gleixnerd316c572007-02-16 01:28:00 -080063ktime_t ktime_get_real(void)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -080064{
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/*
314 * Counterpart to lock_timer_base above:
315 */
316static inline
317void unlock_hrtimer_base(const struct hrtimer *timer, unsigned long *flags)
318{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800319 spin_unlock_irqrestore(&timer->base->cpu_base->lock, *flags);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800320}
321
322/**
323 * hrtimer_forward - forward the timer expiry
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800324 * @timer: hrtimer to forward
Roman Zippel44f21472006-03-26 01:38:06 -0800325 * @now: forward past this time
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800326 * @interval: the interval to forward
327 *
328 * Forward the timer expiry so it will expire in the future.
Jonathan Corbet8dca6f32006-01-16 15:58:55 -0700329 * Returns the number of overruns.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800330 */
331unsigned long
Roman Zippel44f21472006-03-26 01:38:06 -0800332hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800333{
334 unsigned long orun = 1;
Roman Zippel44f21472006-03-26 01:38:06 -0800335 ktime_t delta;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800336
337 delta = ktime_sub(now, timer->expires);
338
339 if (delta.tv64 < 0)
340 return 0;
341
Thomas Gleixnerc9db4fa2006-01-12 11:47:34 +0100342 if (interval.tv64 < timer->base->resolution.tv64)
343 interval.tv64 = timer->base->resolution.tv64;
344
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800345 if (unlikely(delta.tv64 >= interval.tv64)) {
Roman Zippeldf869b62006-03-26 01:38:11 -0800346 s64 incr = ktime_to_ns(interval);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800347
348 orun = ktime_divns(delta, incr);
349 timer->expires = ktime_add_ns(timer->expires, incr * orun);
350 if (timer->expires.tv64 > now.tv64)
351 return orun;
352 /*
353 * This (and the ktime_add() below) is the
354 * correction for exact:
355 */
356 orun++;
357 }
358 timer->expires = ktime_add(timer->expires, interval);
359
360 return orun;
361}
362
363/*
364 * enqueue_hrtimer - internal function to (re)start a timer
365 *
366 * The timer is inserted in expiry order. Insertion into the
367 * red black tree is O(log(n)). Must hold the base lock.
368 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800369static void enqueue_hrtimer(struct hrtimer *timer,
370 struct hrtimer_clock_base *base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800371{
372 struct rb_node **link = &base->active.rb_node;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800373 struct rb_node *parent = NULL;
374 struct hrtimer *entry;
375
376 /*
377 * Find the right place in the rbtree:
378 */
379 while (*link) {
380 parent = *link;
381 entry = rb_entry(parent, struct hrtimer, node);
382 /*
383 * We dont care about collisions. Nodes with
384 * the same expiry time stay together.
385 */
386 if (timer->expires.tv64 < entry->expires.tv64)
387 link = &(*link)->rb_left;
Thomas Gleixner288867e2006-01-12 11:25:54 +0100388 else
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800389 link = &(*link)->rb_right;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800390 }
391
392 /*
Thomas Gleixner288867e2006-01-12 11:25:54 +0100393 * Insert the timer to the rbtree and check whether it
394 * replaces the first pending timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800395 */
396 rb_link_node(&timer->node, parent, link);
397 rb_insert_color(&timer->node, &base->active);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800398 /*
399 * HRTIMER_STATE_ENQUEUED is or'ed to the current state to preserve the
400 * state of a possibly running callback.
401 */
402 timer->state |= HRTIMER_STATE_ENQUEUED;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800403
Thomas Gleixner288867e2006-01-12 11:25:54 +0100404 if (!base->first || timer->expires.tv64 <
405 rb_entry(base->first, struct hrtimer, node)->expires.tv64)
406 base->first = &timer->node;
407}
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800408
409/*
410 * __remove_hrtimer - internal function to remove a timer
411 *
412 * Caller must hold the base lock.
413 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800414static void __remove_hrtimer(struct hrtimer *timer,
Thomas Gleixner303e9672007-02-16 01:27:51 -0800415 struct hrtimer_clock_base *base,
416 unsigned long newstate)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800417{
418 /*
Thomas Gleixner288867e2006-01-12 11:25:54 +0100419 * Remove the timer from the rbtree and replace the
420 * first entry pointer if necessary.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800421 */
Thomas Gleixner288867e2006-01-12 11:25:54 +0100422 if (base->first == &timer->node)
423 base->first = rb_next(&timer->node);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800424 rb_erase(&timer->node, &base->active);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800425 timer->state = newstate;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800426}
427
428/*
429 * remove hrtimer, called with base lock held
430 */
431static inline int
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800432remove_hrtimer(struct hrtimer *timer, struct hrtimer_clock_base *base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800433{
Thomas Gleixner303e9672007-02-16 01:27:51 -0800434 if (hrtimer_is_queued(timer)) {
435 __remove_hrtimer(timer, base, HRTIMER_STATE_INACTIVE);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800436 return 1;
437 }
438 return 0;
439}
440
441/**
442 * hrtimer_start - (re)start an relative timer on the current CPU
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800443 * @timer: the timer to be added
444 * @tim: expiry time
445 * @mode: expiry mode: absolute (HRTIMER_ABS) or relative (HRTIMER_REL)
446 *
447 * Returns:
448 * 0 on success
449 * 1 when the timer was active
450 */
451int
452hrtimer_start(struct hrtimer *timer, ktime_t tim, const enum hrtimer_mode mode)
453{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800454 struct hrtimer_clock_base *base, *new_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800455 unsigned long flags;
456 int ret;
457
458 base = lock_hrtimer_base(timer, &flags);
459
460 /* Remove an active timer from the queue: */
461 ret = remove_hrtimer(timer, base);
462
463 /* Switch the timer base, if necessary: */
464 new_base = switch_hrtimer_base(timer, base);
465
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800466 if (mode == HRTIMER_MODE_REL) {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800467 tim = ktime_add(tim, new_base->get_time());
Ingo Molnar06027bd2006-02-14 13:53:15 -0800468 /*
469 * CONFIG_TIME_LOW_RES is a temporary way for architectures
470 * to signal that they simply return xtime in
471 * do_gettimeoffset(). In this case we want to round up by
472 * resolution when starting a relative timer, to avoid short
473 * timeouts. This will go away with the GTOD framework.
474 */
475#ifdef CONFIG_TIME_LOW_RES
476 tim = ktime_add(tim, base->resolution);
477#endif
478 }
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800479 timer->expires = tim;
480
481 enqueue_hrtimer(timer, new_base);
482
483 unlock_hrtimer_base(timer, &flags);
484
485 return ret;
486}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700487EXPORT_SYMBOL_GPL(hrtimer_start);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800488
489/**
490 * hrtimer_try_to_cancel - try to deactivate a timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800491 * @timer: hrtimer to stop
492 *
493 * Returns:
494 * 0 when the timer was not active
495 * 1 when the timer was active
496 * -1 when the timer is currently excuting the callback function and
Randy Dunlapfa9799e2006-06-25 05:49:15 -0700497 * cannot be stopped
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800498 */
499int hrtimer_try_to_cancel(struct hrtimer *timer)
500{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800501 struct hrtimer_clock_base *base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800502 unsigned long flags;
503 int ret = -1;
504
505 base = lock_hrtimer_base(timer, &flags);
506
Thomas Gleixner303e9672007-02-16 01:27:51 -0800507 if (!hrtimer_callback_running(timer))
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800508 ret = remove_hrtimer(timer, base);
509
510 unlock_hrtimer_base(timer, &flags);
511
512 return ret;
513
514}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700515EXPORT_SYMBOL_GPL(hrtimer_try_to_cancel);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800516
517/**
518 * hrtimer_cancel - cancel a timer and wait for the handler to finish.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800519 * @timer: the timer to be cancelled
520 *
521 * Returns:
522 * 0 when the timer was not active
523 * 1 when the timer was active
524 */
525int hrtimer_cancel(struct hrtimer *timer)
526{
527 for (;;) {
528 int ret = hrtimer_try_to_cancel(timer);
529
530 if (ret >= 0)
531 return ret;
Joe Korty5ef37b12006-04-10 22:54:13 -0700532 cpu_relax();
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800533 }
534}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700535EXPORT_SYMBOL_GPL(hrtimer_cancel);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800536
537/**
538 * hrtimer_get_remaining - get remaining time for the timer
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800539 * @timer: the timer to read
540 */
541ktime_t hrtimer_get_remaining(const struct hrtimer *timer)
542{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800543 struct hrtimer_clock_base *base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800544 unsigned long flags;
545 ktime_t rem;
546
547 base = lock_hrtimer_base(timer, &flags);
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800548 rem = ktime_sub(timer->expires, base->get_time());
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800549 unlock_hrtimer_base(timer, &flags);
550
551 return rem;
552}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700553EXPORT_SYMBOL_GPL(hrtimer_get_remaining);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800554
Thomas Gleixnerfd064b92007-02-16 01:27:47 -0800555#if defined(CONFIG_NO_IDLE_HZ) || defined(CONFIG_NO_HZ)
Tony Lindgren69239742006-03-06 15:42:45 -0800556/**
557 * hrtimer_get_next_event - get the time until next expiry event
558 *
559 * Returns the delta to the next expiry event or KTIME_MAX if no timer
560 * is pending.
561 */
562ktime_t hrtimer_get_next_event(void)
563{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800564 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
565 struct hrtimer_clock_base *base = cpu_base->clock_base;
Tony Lindgren69239742006-03-06 15:42:45 -0800566 ktime_t delta, mindelta = { .tv64 = KTIME_MAX };
567 unsigned long flags;
568 int i;
569
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800570 spin_lock_irqsave(&cpu_base->lock, flags);
571
572 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++, base++) {
Tony Lindgren69239742006-03-06 15:42:45 -0800573 struct hrtimer *timer;
574
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800575 if (!base->first)
Tony Lindgren69239742006-03-06 15:42:45 -0800576 continue;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800577
Tony Lindgren69239742006-03-06 15:42:45 -0800578 timer = rb_entry(base->first, struct hrtimer, node);
579 delta.tv64 = timer->expires.tv64;
Tony Lindgren69239742006-03-06 15:42:45 -0800580 delta = ktime_sub(delta, base->get_time());
581 if (delta.tv64 < mindelta.tv64)
582 mindelta.tv64 = delta.tv64;
583 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800584
585 spin_unlock_irqrestore(&cpu_base->lock, flags);
586
Tony Lindgren69239742006-03-06 15:42:45 -0800587 if (mindelta.tv64 < 0)
588 mindelta.tv64 = 0;
589 return mindelta;
590}
591#endif
592
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800593/**
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800594 * hrtimer_init - initialize a timer to the given clock
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800595 * @timer: the timer to be initialized
596 * @clock_id: the clock to be used
George Anzinger7978672c2006-02-01 03:05:11 -0800597 * @mode: timer mode abs/rel
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800598 */
George Anzinger7978672c2006-02-01 03:05:11 -0800599void hrtimer_init(struct hrtimer *timer, clockid_t clock_id,
600 enum hrtimer_mode mode)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800601{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800602 struct hrtimer_cpu_base *cpu_base;
George Anzinger7978672c2006-02-01 03:05:11 -0800603
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800604 memset(timer, 0, sizeof(struct hrtimer));
George Anzinger7978672c2006-02-01 03:05:11 -0800605
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800606 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
George Anzinger7978672c2006-02-01 03:05:11 -0800607
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800608 if (clock_id == CLOCK_REALTIME && mode != HRTIMER_MODE_ABS)
George Anzinger7978672c2006-02-01 03:05:11 -0800609 clock_id = CLOCK_MONOTONIC;
610
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800611 timer->base = &cpu_base->clock_base[clock_id];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800612}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700613EXPORT_SYMBOL_GPL(hrtimer_init);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800614
615/**
616 * hrtimer_get_res - get the timer resolution for a clock
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800617 * @which_clock: which clock to query
618 * @tp: pointer to timespec variable to store the resolution
619 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800620 * Store the resolution of the clock selected by @which_clock in the
621 * variable pointed to by @tp.
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800622 */
623int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
624{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800625 struct hrtimer_cpu_base *cpu_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800626
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800627 cpu_base = &__raw_get_cpu_var(hrtimer_bases);
628 *tp = ktime_to_timespec(cpu_base->clock_base[which_clock].resolution);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800629
630 return 0;
631}
Stephen Hemminger8d16b762006-05-30 21:26:09 -0700632EXPORT_SYMBOL_GPL(hrtimer_get_res);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800633
634/*
635 * Expire the per base hrtimer-queue:
636 */
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800637static inline void run_hrtimer_queue(struct hrtimer_cpu_base *cpu_base,
638 int index)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800639{
Thomas Gleixner288867e2006-01-12 11:25:54 +0100640 struct rb_node *node;
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800641 struct hrtimer_clock_base *base = &cpu_base->clock_base[index];
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800642
Dimitri Sivanich3055add2006-03-31 02:31:20 -0800643 if (!base->first)
644 return;
645
Thomas Gleixner92127c72006-03-26 01:38:05 -0800646 if (base->get_softirq_time)
647 base->softirq_time = base->get_softirq_time();
648
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800649 spin_lock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800650
Thomas Gleixner288867e2006-01-12 11:25:54 +0100651 while ((node = base->first)) {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800652 struct hrtimer *timer;
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800653 enum hrtimer_restart (*fn)(struct hrtimer *);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800654 int restart;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800655
Thomas Gleixner288867e2006-01-12 11:25:54 +0100656 timer = rb_entry(node, struct hrtimer, node);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800657 if (base->softirq_time.tv64 <= timer->expires.tv64)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800658 break;
659
660 fn = timer->function;
Thomas Gleixner303e9672007-02-16 01:27:51 -0800661 __remove_hrtimer(timer, base, HRTIMER_STATE_CALLBACK);
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800662 spin_unlock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800663
Roman Zippel05cfb612006-03-26 01:38:12 -0800664 restart = fn(timer);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800665
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800666 spin_lock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800667
Thomas Gleixner303e9672007-02-16 01:27:51 -0800668 timer->state &= ~HRTIMER_STATE_CALLBACK;
Roman Zippelb75f7a52006-03-26 01:38:09 -0800669 if (restart != HRTIMER_NORESTART) {
670 BUG_ON(hrtimer_active(timer));
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800671 enqueue_hrtimer(timer, base);
Roman Zippelb75f7a52006-03-26 01:38:09 -0800672 }
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800673 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800674 spin_unlock_irq(&cpu_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800675}
676
677/*
678 * Called from timer softirq every jiffy, expire hrtimers:
679 */
680void hrtimer_run_queues(void)
681{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800682 struct hrtimer_cpu_base *cpu_base = &__get_cpu_var(hrtimer_bases);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800683 int i;
684
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800685 hrtimer_get_softirq_time(cpu_base);
Thomas Gleixner92127c72006-03-26 01:38:05 -0800686
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800687 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
688 run_hrtimer_queue(cpu_base, i);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800689}
690
691/*
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800692 * Sleep related functions:
693 */
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800694static enum hrtimer_restart hrtimer_wakeup(struct hrtimer *timer)
Thomas Gleixner00362e32006-03-31 02:31:17 -0800695{
696 struct hrtimer_sleeper *t =
697 container_of(timer, struct hrtimer_sleeper, timer);
698 struct task_struct *task = t->task;
699
700 t->task = NULL;
701 if (task)
702 wake_up_process(task);
703
704 return HRTIMER_NORESTART;
705}
706
Ingo Molnar36c8b582006-07-03 00:25:41 -0700707void hrtimer_init_sleeper(struct hrtimer_sleeper *sl, struct task_struct *task)
Thomas Gleixner00362e32006-03-31 02:31:17 -0800708{
709 sl->timer.function = hrtimer_wakeup;
710 sl->task = task;
711}
712
Thomas Gleixner669d7862006-03-31 02:31:19 -0800713static int __sched do_nanosleep(struct hrtimer_sleeper *t, enum hrtimer_mode mode)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800714{
Thomas Gleixner669d7862006-03-31 02:31:19 -0800715 hrtimer_init_sleeper(t, current);
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800716
Roman Zippel432569b2006-03-26 01:38:08 -0800717 do {
718 set_current_state(TASK_INTERRUPTIBLE);
719 hrtimer_start(&t->timer, t->timer.expires, mode);
720
721 schedule();
722
Thomas Gleixner669d7862006-03-31 02:31:19 -0800723 hrtimer_cancel(&t->timer);
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800724 mode = HRTIMER_MODE_ABS;
Roman Zippel432569b2006-03-26 01:38:08 -0800725
Thomas Gleixner669d7862006-03-31 02:31:19 -0800726 } while (t->task && !signal_pending(current));
727
728 return t->task == NULL;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800729}
730
Toyo Abe1711ef32006-09-29 02:00:28 -0700731long __sched hrtimer_nanosleep_restart(struct restart_block *restart)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800732{
Thomas Gleixner669d7862006-03-31 02:31:19 -0800733 struct hrtimer_sleeper t;
Ingo Molnarea13dbc2006-01-16 10:59:41 +0100734 struct timespec __user *rmtp;
735 struct timespec tu;
Roman Zippel432569b2006-03-26 01:38:08 -0800736 ktime_t time;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800737
738 restart->fn = do_no_restart_syscall;
739
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800740 hrtimer_init(&t.timer, restart->arg0, HRTIMER_MODE_ABS);
Toyo Abe1711ef32006-09-29 02:00:28 -0700741 t.timer.expires.tv64 = ((u64)restart->arg3 << 32) | (u64) restart->arg2;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800742
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800743 if (do_nanosleep(&t, HRTIMER_MODE_ABS))
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800744 return 0;
745
Toyo Abe1711ef32006-09-29 02:00:28 -0700746 rmtp = (struct timespec __user *) restart->arg1;
Roman Zippel432569b2006-03-26 01:38:08 -0800747 if (rmtp) {
748 time = ktime_sub(t.timer.expires, t.timer.base->get_time());
749 if (time.tv64 <= 0)
750 return 0;
751 tu = ktime_to_timespec(time);
752 if (copy_to_user(rmtp, &tu, sizeof(tu)))
753 return -EFAULT;
754 }
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800755
Toyo Abe1711ef32006-09-29 02:00:28 -0700756 restart->fn = hrtimer_nanosleep_restart;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800757
758 /* The other values in restart are already filled in */
759 return -ERESTART_RESTARTBLOCK;
760}
761
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800762long hrtimer_nanosleep(struct timespec *rqtp, struct timespec __user *rmtp,
763 const enum hrtimer_mode mode, const clockid_t clockid)
764{
765 struct restart_block *restart;
Thomas Gleixner669d7862006-03-31 02:31:19 -0800766 struct hrtimer_sleeper t;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800767 struct timespec tu;
768 ktime_t rem;
769
Roman Zippel432569b2006-03-26 01:38:08 -0800770 hrtimer_init(&t.timer, clockid, mode);
771 t.timer.expires = timespec_to_ktime(*rqtp);
772 if (do_nanosleep(&t, mode))
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800773 return 0;
774
George Anzinger7978672c2006-02-01 03:05:11 -0800775 /* Absolute timers do not update the rmtp value and restart: */
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800776 if (mode == HRTIMER_MODE_ABS)
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800777 return -ERESTARTNOHAND;
778
Roman Zippel432569b2006-03-26 01:38:08 -0800779 if (rmtp) {
780 rem = ktime_sub(t.timer.expires, t.timer.base->get_time());
781 if (rem.tv64 <= 0)
782 return 0;
783 tu = ktime_to_timespec(rem);
784 if (copy_to_user(rmtp, &tu, sizeof(tu)))
785 return -EFAULT;
786 }
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800787
788 restart = &current_thread_info()->restart_block;
Toyo Abe1711ef32006-09-29 02:00:28 -0700789 restart->fn = hrtimer_nanosleep_restart;
790 restart->arg0 = (unsigned long) t.timer.base->index;
791 restart->arg1 = (unsigned long) rmtp;
792 restart->arg2 = t.timer.expires.tv64 & 0xFFFFFFFF;
793 restart->arg3 = t.timer.expires.tv64 >> 32;
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800794
795 return -ERESTART_RESTARTBLOCK;
796}
797
Thomas Gleixner6ba1b912006-01-09 20:52:36 -0800798asmlinkage long
799sys_nanosleep(struct timespec __user *rqtp, struct timespec __user *rmtp)
800{
801 struct timespec tu;
802
803 if (copy_from_user(&tu, rqtp, sizeof(tu)))
804 return -EFAULT;
805
806 if (!timespec_valid(&tu))
807 return -EINVAL;
808
Thomas Gleixnerc9cb2e32007-02-16 01:27:49 -0800809 return hrtimer_nanosleep(&tu, rmtp, HRTIMER_MODE_REL, CLOCK_MONOTONIC);
Thomas Gleixner6ba1b912006-01-09 20:52:36 -0800810}
811
Thomas Gleixner10c94ec2006-01-09 20:52:35 -0800812/*
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800813 * Functions related to boot-time initialization:
814 */
815static void __devinit init_hrtimers_cpu(int cpu)
816{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800817 struct hrtimer_cpu_base *cpu_base = &per_cpu(hrtimer_bases, cpu);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800818 int i;
819
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800820 spin_lock_init(&cpu_base->lock);
821 lockdep_set_class(&cpu_base->lock, &cpu_base->lock_key);
822
823 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++)
824 cpu_base->clock_base[i].cpu_base = cpu_base;
825
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800826}
827
828#ifdef CONFIG_HOTPLUG_CPU
829
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800830static void migrate_hrtimer_list(struct hrtimer_clock_base *old_base,
831 struct hrtimer_clock_base *new_base)
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800832{
833 struct hrtimer *timer;
834 struct rb_node *node;
835
836 while ((node = rb_first(&old_base->active))) {
837 timer = rb_entry(node, struct hrtimer, node);
Thomas Gleixner303e9672007-02-16 01:27:51 -0800838 BUG_ON(timer->state & HRTIMER_STATE_CALLBACK);
839 __remove_hrtimer(timer, old_base, HRTIMER_STATE_INACTIVE);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800840 timer->base = new_base;
841 enqueue_hrtimer(timer, new_base);
842 }
843}
844
845static void migrate_hrtimers(int cpu)
846{
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800847 struct hrtimer_cpu_base *old_base, *new_base;
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800848 int i;
849
850 BUG_ON(cpu_online(cpu));
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800851 old_base = &per_cpu(hrtimer_bases, cpu);
852 new_base = &get_cpu_var(hrtimer_bases);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800853
854 local_irq_disable();
855
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800856 spin_lock(&new_base->lock);
857 spin_lock(&old_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800858
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800859 for (i = 0; i < HRTIMER_MAX_CLOCK_BASES; i++) {
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800860 migrate_hrtimer_list(&old_base->clock_base[i],
861 &new_base->clock_base[i]);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800862 }
Thomas Gleixner3c8aa392007-02-16 01:27:50 -0800863 spin_unlock(&old_base->lock);
864 spin_unlock(&new_base->lock);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800865
866 local_irq_enable();
867 put_cpu_var(hrtimer_bases);
868}
869#endif /* CONFIG_HOTPLUG_CPU */
870
Chandra Seetharaman8c78f302006-07-30 03:03:35 -0700871static int __cpuinit hrtimer_cpu_notify(struct notifier_block *self,
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800872 unsigned long action, void *hcpu)
873{
874 long cpu = (long)hcpu;
875
876 switch (action) {
877
878 case CPU_UP_PREPARE:
879 init_hrtimers_cpu(cpu);
880 break;
881
882#ifdef CONFIG_HOTPLUG_CPU
883 case CPU_DEAD:
Thomas Gleixnerd316c572007-02-16 01:28:00 -0800884 clockevents_notify(CLOCK_EVT_NOTIFY_CPU_DEAD, &cpu);
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800885 migrate_hrtimers(cpu);
886 break;
887#endif
888
889 default:
890 break;
891 }
892
893 return NOTIFY_OK;
894}
895
Chandra Seetharaman8c78f302006-07-30 03:03:35 -0700896static struct notifier_block __cpuinitdata hrtimers_nb = {
Thomas Gleixnerc0a31322006-01-09 20:52:32 -0800897 .notifier_call = hrtimer_cpu_notify,
898};
899
900void __init hrtimers_init(void)
901{
902 hrtimer_cpu_notify(&hrtimers_nb, (unsigned long)CPU_UP_PREPARE,
903 (void *)(long)smp_processor_id());
904 register_cpu_notifier(&hrtimers_nb);
905}
906