blob: 15e06defca5518ca1378c797bbcaa28472e66c72 [file] [log] [blame]
john stultz85240702007-05-08 00:27:59 -07001/*
2 * linux/kernel/time/timekeeping.c
3 *
4 * Kernel timekeeping code and accessor functions
5 *
6 * This code was moved from linux/kernel/timer.c.
7 * Please see that file for copyright and history logs.
8 *
9 */
10
11#include <linux/module.h>
12#include <linux/interrupt.h>
13#include <linux/percpu.h>
14#include <linux/init.h>
15#include <linux/mm.h>
16#include <linux/sysdev.h>
17#include <linux/clocksource.h>
18#include <linux/jiffies.h>
19#include <linux/time.h>
20#include <linux/tick.h>
Martin Schwidefsky75c51582009-08-14 15:47:30 +020021#include <linux/stop_machine.h>
john stultz85240702007-05-08 00:27:59 -070022
Martin Schwidefsky155ec602009-08-14 15:47:26 +020023/* Structure holding internal timekeeping values. */
24struct timekeeper {
25 /* Current clocksource used for timekeeping. */
26 struct clocksource *clock;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020027 /* The shift value of the current clocksource. */
28 int shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020029
30 /* Number of clock cycles in one NTP interval. */
31 cycle_t cycle_interval;
32 /* Number of clock shifted nano seconds in one NTP interval. */
33 u64 xtime_interval;
34 /* Raw nano seconds accumulated per NTP interval. */
35 u32 raw_interval;
36
37 /* Clock shifted nano seconds remainder not stored in xtime.tv_nsec. */
38 u64 xtime_nsec;
39 /* Difference between accumulated time and NTP time in ntp
40 * shifted nano seconds. */
41 s64 ntp_error;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020042 /* Shift conversion between clock shifted nano seconds and
43 * ntp shifted nano seconds. */
44 int ntp_error_shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020045 /* NTP adjusted clock multiplier */
46 u32 mult;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020047};
48
49struct timekeeper timekeeper;
50
51/**
52 * timekeeper_setup_internals - Set up internals to use clocksource clock.
53 *
54 * @clock: Pointer to clocksource.
55 *
56 * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
57 * pair and interval request.
58 *
59 * Unless you're the timekeeping code, you should not be using this!
60 */
61static void timekeeper_setup_internals(struct clocksource *clock)
62{
63 cycle_t interval;
64 u64 tmp;
65
66 timekeeper.clock = clock;
67 clock->cycle_last = clock->read(clock);
68
69 /* Do the ns -> cycle conversion first, using original mult */
70 tmp = NTP_INTERVAL_LENGTH;
71 tmp <<= clock->shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020072 tmp += clock->mult/2;
73 do_div(tmp, clock->mult);
Martin Schwidefsky155ec602009-08-14 15:47:26 +020074 if (tmp == 0)
75 tmp = 1;
76
77 interval = (cycle_t) tmp;
78 timekeeper.cycle_interval = interval;
79
80 /* Go back from cycles -> shifted ns */
81 timekeeper.xtime_interval = (u64) interval * clock->mult;
82 timekeeper.raw_interval =
Martin Schwidefsky0a544192009-08-14 15:47:28 +020083 ((u64) interval * clock->mult) >> clock->shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020084
85 timekeeper.xtime_nsec = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020086 timekeeper.shift = clock->shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020087
88 timekeeper.ntp_error = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020089 timekeeper.ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020090
91 /*
92 * The timekeeper keeps its own mult values for the currently
93 * active clocksource. These value will be adjusted via NTP
94 * to counteract clock drifting.
95 */
96 timekeeper.mult = clock->mult;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020097}
john stultz85240702007-05-08 00:27:59 -070098
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +020099/* Timekeeper helper functions. */
100static inline s64 timekeeping_get_ns(void)
101{
102 cycle_t cycle_now, cycle_delta;
103 struct clocksource *clock;
104
105 /* read clocksource: */
106 clock = timekeeper.clock;
107 cycle_now = clock->read(clock);
108
109 /* calculate the delta since the last update_wall_time: */
110 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
111
112 /* return delta convert to nanoseconds using ntp adjusted mult. */
113 return clocksource_cyc2ns(cycle_delta, timekeeper.mult,
114 timekeeper.shift);
115}
116
117static inline s64 timekeeping_get_ns_raw(void)
118{
119 cycle_t cycle_now, cycle_delta;
120 struct clocksource *clock;
121
122 /* read clocksource: */
123 clock = timekeeper.clock;
124 cycle_now = clock->read(clock);
125
126 /* calculate the delta since the last update_wall_time: */
127 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
128
129 /* return delta convert to nanoseconds using ntp adjusted mult. */
130 return clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
131}
132
john stultz85240702007-05-08 00:27:59 -0700133/*
134 * This read-write spinlock protects us from races in SMP while
Thomas Gleixnerdce48a82009-04-11 10:43:41 +0200135 * playing with xtime.
john stultz85240702007-05-08 00:27:59 -0700136 */
Adrian Bunkba2a6312007-10-16 23:27:16 -0700137__cacheline_aligned_in_smp DEFINE_SEQLOCK(xtime_lock);
john stultz85240702007-05-08 00:27:59 -0700138
139
140/*
141 * The current time
142 * wall_to_monotonic is what we need to add to xtime (or xtime corrected
143 * for sub jiffie times) to get to monotonic time. Monotonic is pegged
144 * at zero at system boot time, so wall_to_monotonic will be negative,
145 * however, we will ALWAYS keep the tv_nsec part positive so we can use
146 * the usual normalization.
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700147 *
148 * wall_to_monotonic is moved after resume from suspend for the monotonic
149 * time not to jump. We need to add total_sleep_time to wall_to_monotonic
150 * to get the real boot based time offset.
151 *
152 * - wall_to_monotonic is no longer the boot time, getboottime must be
153 * used instead.
john stultz85240702007-05-08 00:27:59 -0700154 */
155struct timespec xtime __attribute__ ((aligned (16)));
156struct timespec wall_to_monotonic __attribute__ ((aligned (16)));
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200157static struct timespec total_sleep_time;
john stultz85240702007-05-08 00:27:59 -0700158
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200159/*
160 * The raw monotonic time for the CLOCK_MONOTONIC_RAW posix clock.
161 */
162struct timespec raw_time;
163
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100164/* flag for if timekeeping is suspended */
165int __read_mostly timekeeping_suspended;
166
john stultz17c38b72007-07-24 18:38:34 -0700167static struct timespec xtime_cache __attribute__ ((aligned (16)));
Thomas Gleixner1001d0a2008-02-01 17:45:13 +0100168void update_xtime_cache(u64 nsec)
john stultz17c38b72007-07-24 18:38:34 -0700169{
170 xtime_cache = xtime;
171 timespec_add_ns(&xtime_cache, nsec);
172}
john stultz17c38b72007-07-24 18:38:34 -0700173
John Stultz31089c12009-08-14 15:47:18 +0200174/* must hold xtime_lock */
175void timekeeping_leap_insert(int leapsecond)
176{
177 xtime.tv_sec += leapsecond;
178 wall_to_monotonic.tv_sec -= leapsecond;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200179 update_vsyscall(&xtime, timekeeper.clock);
John Stultz31089c12009-08-14 15:47:18 +0200180}
john stultz85240702007-05-08 00:27:59 -0700181
182#ifdef CONFIG_GENERIC_TIME
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200183
john stultz85240702007-05-08 00:27:59 -0700184/**
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200185 * timekeeping_forward_now - update clock to the current time
john stultz85240702007-05-08 00:27:59 -0700186 *
Roman Zippel9a055112008-08-20 16:37:28 -0700187 * Forward the current clock to update its state since the last call to
188 * update_wall_time(). This is useful before significant clock changes,
189 * as it avoids having to deal with this time offset explicitly.
john stultz85240702007-05-08 00:27:59 -0700190 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200191static void timekeeping_forward_now(void)
john stultz85240702007-05-08 00:27:59 -0700192{
193 cycle_t cycle_now, cycle_delta;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200194 struct clocksource *clock;
Roman Zippel9a055112008-08-20 16:37:28 -0700195 s64 nsec;
john stultz85240702007-05-08 00:27:59 -0700196
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200197 clock = timekeeper.clock;
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200198 cycle_now = clock->read(clock);
john stultz85240702007-05-08 00:27:59 -0700199 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
Roman Zippel9a055112008-08-20 16:37:28 -0700200 clock->cycle_last = cycle_now;
john stultz85240702007-05-08 00:27:59 -0700201
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200202 nsec = clocksource_cyc2ns(cycle_delta, timekeeper.mult,
203 timekeeper.shift);
john stultz7d275582009-05-01 13:10:26 -0700204
205 /* If arch requires, add in gettimeoffset() */
206 nsec += arch_gettimeoffset();
207
Roman Zippel9a055112008-08-20 16:37:28 -0700208 timespec_add_ns(&xtime, nsec);
John Stultz2d422442008-08-20 16:37:30 -0700209
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200210 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200211 timespec_add_ns(&raw_time, nsec);
john stultz85240702007-05-08 00:27:59 -0700212}
213
214/**
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100215 * getnstimeofday - Returns the time of day in a timespec
john stultz85240702007-05-08 00:27:59 -0700216 * @ts: pointer to the timespec to be set
217 *
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100218 * Returns the time of day in a timespec.
john stultz85240702007-05-08 00:27:59 -0700219 */
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100220void getnstimeofday(struct timespec *ts)
john stultz85240702007-05-08 00:27:59 -0700221{
222 unsigned long seq;
223 s64 nsecs;
224
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100225 WARN_ON(timekeeping_suspended);
226
john stultz85240702007-05-08 00:27:59 -0700227 do {
228 seq = read_seqbegin(&xtime_lock);
229
230 *ts = xtime;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200231 nsecs = timekeeping_get_ns();
john stultz85240702007-05-08 00:27:59 -0700232
john stultz7d275582009-05-01 13:10:26 -0700233 /* If arch requires, add in gettimeoffset() */
234 nsecs += arch_gettimeoffset();
235
john stultz85240702007-05-08 00:27:59 -0700236 } while (read_seqretry(&xtime_lock, seq));
237
238 timespec_add_ns(ts, nsecs);
239}
240
john stultz85240702007-05-08 00:27:59 -0700241EXPORT_SYMBOL(getnstimeofday);
242
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200243ktime_t ktime_get(void)
244{
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200245 unsigned int seq;
246 s64 secs, nsecs;
247
248 WARN_ON(timekeeping_suspended);
249
250 do {
251 seq = read_seqbegin(&xtime_lock);
252 secs = xtime.tv_sec + wall_to_monotonic.tv_sec;
253 nsecs = xtime.tv_nsec + wall_to_monotonic.tv_nsec;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200254 nsecs += timekeeping_get_ns();
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200255
256 } while (read_seqretry(&xtime_lock, seq));
257 /*
258 * Use ktime_set/ktime_add_ns to create a proper ktime on
259 * 32-bit architectures without CONFIG_KTIME_SCALAR.
260 */
261 return ktime_add_ns(ktime_set(secs, 0), nsecs);
262}
263EXPORT_SYMBOL_GPL(ktime_get);
264
265/**
266 * ktime_get_ts - get the monotonic clock in timespec format
267 * @ts: pointer to timespec variable
268 *
269 * The function calculates the monotonic clock from the realtime
270 * clock and the wall_to_monotonic offset and stores the result
271 * in normalized timespec format in the variable pointed to by @ts.
272 */
273void ktime_get_ts(struct timespec *ts)
274{
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200275 struct timespec tomono;
276 unsigned int seq;
277 s64 nsecs;
278
279 WARN_ON(timekeeping_suspended);
280
281 do {
282 seq = read_seqbegin(&xtime_lock);
283 *ts = xtime;
284 tomono = wall_to_monotonic;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200285 nsecs = timekeeping_get_ns();
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200286
287 } while (read_seqretry(&xtime_lock, seq));
288
289 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
290 ts->tv_nsec + tomono.tv_nsec + nsecs);
291}
292EXPORT_SYMBOL_GPL(ktime_get_ts);
293
john stultz85240702007-05-08 00:27:59 -0700294/**
295 * do_gettimeofday - Returns the time of day in a timeval
296 * @tv: pointer to the timeval to be set
297 *
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100298 * NOTE: Users should be converted to using getnstimeofday()
john stultz85240702007-05-08 00:27:59 -0700299 */
300void do_gettimeofday(struct timeval *tv)
301{
302 struct timespec now;
303
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100304 getnstimeofday(&now);
john stultz85240702007-05-08 00:27:59 -0700305 tv->tv_sec = now.tv_sec;
306 tv->tv_usec = now.tv_nsec/1000;
307}
308
309EXPORT_SYMBOL(do_gettimeofday);
310/**
311 * do_settimeofday - Sets the time of day
312 * @tv: pointer to the timespec variable containing the new time
313 *
314 * Sets the time of day to the new time and update NTP and notify hrtimers
315 */
316int do_settimeofday(struct timespec *tv)
317{
Roman Zippel9a055112008-08-20 16:37:28 -0700318 struct timespec ts_delta;
john stultz85240702007-05-08 00:27:59 -0700319 unsigned long flags;
john stultz85240702007-05-08 00:27:59 -0700320
321 if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
322 return -EINVAL;
323
324 write_seqlock_irqsave(&xtime_lock, flags);
325
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200326 timekeeping_forward_now();
john stultz85240702007-05-08 00:27:59 -0700327
Roman Zippel9a055112008-08-20 16:37:28 -0700328 ts_delta.tv_sec = tv->tv_sec - xtime.tv_sec;
329 ts_delta.tv_nsec = tv->tv_nsec - xtime.tv_nsec;
330 wall_to_monotonic = timespec_sub(wall_to_monotonic, ts_delta);
john stultz85240702007-05-08 00:27:59 -0700331
Roman Zippel9a055112008-08-20 16:37:28 -0700332 xtime = *tv;
333
Thomas Gleixner1001d0a2008-02-01 17:45:13 +0100334 update_xtime_cache(0);
john stultz85240702007-05-08 00:27:59 -0700335
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200336 timekeeper.ntp_error = 0;
john stultz85240702007-05-08 00:27:59 -0700337 ntp_clear();
338
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200339 update_vsyscall(&xtime, timekeeper.clock);
john stultz85240702007-05-08 00:27:59 -0700340
341 write_sequnlock_irqrestore(&xtime_lock, flags);
342
343 /* signal hrtimers about time change */
344 clock_was_set();
345
346 return 0;
347}
348
349EXPORT_SYMBOL(do_settimeofday);
350
351/**
352 * change_clocksource - Swaps clocksources if a new one is available
353 *
354 * Accumulates current time interval and initializes new clocksource
355 */
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200356static int change_clocksource(void *data)
john stultz85240702007-05-08 00:27:59 -0700357{
Magnus Damm4614e6a2009-04-21 12:24:02 -0700358 struct clocksource *new, *old;
john stultz85240702007-05-08 00:27:59 -0700359
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200360 new = (struct clocksource *) data;
john stultz85240702007-05-08 00:27:59 -0700361
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200362 timekeeping_forward_now();
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200363 if (!new->enable || new->enable(new) == 0) {
364 old = timekeeper.clock;
365 timekeeper_setup_internals(new);
366 if (old->disable)
367 old->disable(old);
368 }
369 return 0;
370}
john stultz85240702007-05-08 00:27:59 -0700371
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200372/**
373 * timekeeping_notify - Install a new clock source
374 * @clock: pointer to the clock source
375 *
376 * This function is called from clocksource.c after a new, better clock
377 * source has been registered. The caller holds the clocksource_mutex.
378 */
379void timekeeping_notify(struct clocksource *clock)
380{
381 if (timekeeper.clock == clock)
Magnus Damm4614e6a2009-04-21 12:24:02 -0700382 return;
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200383 stop_machine(change_clocksource, clock, NULL);
john stultz85240702007-05-08 00:27:59 -0700384 tick_clock_notify();
john stultz85240702007-05-08 00:27:59 -0700385}
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200386
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200387#else /* GENERIC_TIME */
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200388
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200389static inline void timekeeping_forward_now(void) { }
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200390
391/**
392 * ktime_get - get the monotonic time in ktime_t format
393 *
394 * returns the time in ktime_t format
395 */
396ktime_t ktime_get(void)
397{
398 struct timespec now;
399
400 ktime_get_ts(&now);
401
402 return timespec_to_ktime(now);
403}
404EXPORT_SYMBOL_GPL(ktime_get);
405
406/**
407 * ktime_get_ts - get the monotonic clock in timespec format
408 * @ts: pointer to timespec variable
409 *
410 * The function calculates the monotonic clock from the realtime
411 * clock and the wall_to_monotonic offset and stores the result
412 * in normalized timespec format in the variable pointed to by @ts.
413 */
414void ktime_get_ts(struct timespec *ts)
415{
416 struct timespec tomono;
417 unsigned long seq;
418
419 do {
420 seq = read_seqbegin(&xtime_lock);
421 getnstimeofday(ts);
422 tomono = wall_to_monotonic;
423
424 } while (read_seqretry(&xtime_lock, seq));
425
426 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
427 ts->tv_nsec + tomono.tv_nsec);
428}
429EXPORT_SYMBOL_GPL(ktime_get_ts);
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200430
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200431#endif /* !GENERIC_TIME */
432
433/**
434 * ktime_get_real - get the real (wall-) time in ktime_t format
435 *
436 * returns the time in ktime_t format
437 */
438ktime_t ktime_get_real(void)
439{
440 struct timespec now;
441
442 getnstimeofday(&now);
443
444 return timespec_to_ktime(now);
445}
446EXPORT_SYMBOL_GPL(ktime_get_real);
john stultz85240702007-05-08 00:27:59 -0700447
448/**
John Stultz2d422442008-08-20 16:37:30 -0700449 * getrawmonotonic - Returns the raw monotonic time in a timespec
450 * @ts: pointer to the timespec to be set
451 *
452 * Returns the raw monotonic time (completely un-modified by ntp)
453 */
454void getrawmonotonic(struct timespec *ts)
455{
456 unsigned long seq;
457 s64 nsecs;
John Stultz2d422442008-08-20 16:37:30 -0700458
459 do {
460 seq = read_seqbegin(&xtime_lock);
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200461 nsecs = timekeeping_get_ns_raw();
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200462 *ts = raw_time;
John Stultz2d422442008-08-20 16:37:30 -0700463
464 } while (read_seqretry(&xtime_lock, seq));
465
466 timespec_add_ns(ts, nsecs);
467}
468EXPORT_SYMBOL(getrawmonotonic);
469
470
471/**
Li Zefancf4fc6c2008-02-08 04:19:24 -0800472 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
john stultz85240702007-05-08 00:27:59 -0700473 */
Li Zefancf4fc6c2008-02-08 04:19:24 -0800474int timekeeping_valid_for_hres(void)
john stultz85240702007-05-08 00:27:59 -0700475{
476 unsigned long seq;
477 int ret;
478
479 do {
480 seq = read_seqbegin(&xtime_lock);
481
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200482 ret = timekeeper.clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
john stultz85240702007-05-08 00:27:59 -0700483
484 } while (read_seqretry(&xtime_lock, seq));
485
486 return ret;
487}
488
489/**
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200490 * read_persistent_clock - Return time from the persistent clock.
john stultz85240702007-05-08 00:27:59 -0700491 *
492 * Weak dummy function for arches that do not yet support it.
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200493 * Reads the time from the battery backed persistent clock.
494 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
john stultz85240702007-05-08 00:27:59 -0700495 *
496 * XXX - Do be sure to remove it once all arches implement it.
497 */
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200498void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
john stultz85240702007-05-08 00:27:59 -0700499{
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200500 ts->tv_sec = 0;
501 ts->tv_nsec = 0;
john stultz85240702007-05-08 00:27:59 -0700502}
503
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200504/**
505 * read_boot_clock - Return time of the system start.
506 *
507 * Weak dummy function for arches that do not yet support it.
508 * Function to read the exact time the system has been started.
509 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
510 *
511 * XXX - Do be sure to remove it once all arches implement it.
512 */
513void __attribute__((weak)) read_boot_clock(struct timespec *ts)
514{
515 ts->tv_sec = 0;
516 ts->tv_nsec = 0;
517}
518
john stultz85240702007-05-08 00:27:59 -0700519/*
520 * timekeeping_init - Initializes the clocksource and common timekeeping values
521 */
522void __init timekeeping_init(void)
523{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200524 struct clocksource *clock;
john stultz85240702007-05-08 00:27:59 -0700525 unsigned long flags;
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200526 struct timespec now, boot;
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200527
528 read_persistent_clock(&now);
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200529 read_boot_clock(&boot);
john stultz85240702007-05-08 00:27:59 -0700530
531 write_seqlock_irqsave(&xtime_lock, flags);
532
Roman Zippel7dffa3c2008-05-01 04:34:41 -0700533 ntp_init();
john stultz85240702007-05-08 00:27:59 -0700534
Martin Schwidefskyf1b82742009-08-14 15:47:21 +0200535 clock = clocksource_default_clock();
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200536 if (clock->enable)
537 clock->enable(clock);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200538 timekeeper_setup_internals(clock);
john stultz85240702007-05-08 00:27:59 -0700539
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200540 xtime.tv_sec = now.tv_sec;
541 xtime.tv_nsec = now.tv_nsec;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200542 raw_time.tv_sec = 0;
543 raw_time.tv_nsec = 0;
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200544 if (boot.tv_sec == 0 && boot.tv_nsec == 0) {
545 boot.tv_sec = xtime.tv_sec;
546 boot.tv_nsec = xtime.tv_nsec;
547 }
john stultz85240702007-05-08 00:27:59 -0700548 set_normalized_timespec(&wall_to_monotonic,
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200549 -boot.tv_sec, -boot.tv_nsec);
Thomas Gleixner1001d0a2008-02-01 17:45:13 +0100550 update_xtime_cache(0);
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200551 total_sleep_time.tv_sec = 0;
552 total_sleep_time.tv_nsec = 0;
john stultz85240702007-05-08 00:27:59 -0700553 write_sequnlock_irqrestore(&xtime_lock, flags);
554}
555
john stultz85240702007-05-08 00:27:59 -0700556/* time in seconds when suspend began */
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200557static struct timespec timekeeping_suspend_time;
john stultz85240702007-05-08 00:27:59 -0700558
559/**
560 * timekeeping_resume - Resumes the generic timekeeping subsystem.
561 * @dev: unused
562 *
563 * This is for the generic clocksource timekeeping.
564 * xtime/wall_to_monotonic/jiffies/etc are
565 * still managed by arch specific suspend/resume code.
566 */
567static int timekeeping_resume(struct sys_device *dev)
568{
569 unsigned long flags;
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200570 struct timespec ts;
571
572 read_persistent_clock(&ts);
john stultz85240702007-05-08 00:27:59 -0700573
Thomas Gleixnerd10ff3f2007-05-14 11:10:02 +0200574 clocksource_resume();
575
john stultz85240702007-05-08 00:27:59 -0700576 write_seqlock_irqsave(&xtime_lock, flags);
577
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200578 if (timespec_compare(&ts, &timekeeping_suspend_time) > 0) {
579 ts = timespec_sub(ts, timekeeping_suspend_time);
580 xtime = timespec_add_safe(xtime, ts);
581 wall_to_monotonic = timespec_sub(wall_to_monotonic, ts);
582 total_sleep_time = timespec_add_safe(total_sleep_time, ts);
john stultz85240702007-05-08 00:27:59 -0700583 }
Thomas Gleixner1001d0a2008-02-01 17:45:13 +0100584 update_xtime_cache(0);
john stultz85240702007-05-08 00:27:59 -0700585 /* re-base the last cycle value */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200586 timekeeper.clock->cycle_last = timekeeper.clock->read(timekeeper.clock);
587 timekeeper.ntp_error = 0;
john stultz85240702007-05-08 00:27:59 -0700588 timekeeping_suspended = 0;
589 write_sequnlock_irqrestore(&xtime_lock, flags);
590
591 touch_softlockup_watchdog();
592
593 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
594
595 /* Resume hrtimers */
596 hres_timers_resume();
597
598 return 0;
599}
600
601static int timekeeping_suspend(struct sys_device *dev, pm_message_t state)
602{
603 unsigned long flags;
604
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200605 read_persistent_clock(&timekeeping_suspend_time);
Thomas Gleixner3be90952007-09-16 15:36:43 +0200606
john stultz85240702007-05-08 00:27:59 -0700607 write_seqlock_irqsave(&xtime_lock, flags);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200608 timekeeping_forward_now();
john stultz85240702007-05-08 00:27:59 -0700609 timekeeping_suspended = 1;
john stultz85240702007-05-08 00:27:59 -0700610 write_sequnlock_irqrestore(&xtime_lock, flags);
611
612 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
613
614 return 0;
615}
616
617/* sysfs resume/suspend bits for timekeeping */
618static struct sysdev_class timekeeping_sysclass = {
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100619 .name = "timekeeping",
john stultz85240702007-05-08 00:27:59 -0700620 .resume = timekeeping_resume,
621 .suspend = timekeeping_suspend,
john stultz85240702007-05-08 00:27:59 -0700622};
623
624static struct sys_device device_timer = {
625 .id = 0,
626 .cls = &timekeeping_sysclass,
627};
628
629static int __init timekeeping_init_device(void)
630{
631 int error = sysdev_class_register(&timekeeping_sysclass);
632 if (!error)
633 error = sysdev_register(&device_timer);
634 return error;
635}
636
637device_initcall(timekeeping_init_device);
638
639/*
640 * If the error is already larger, we look ahead even further
641 * to compensate for late or lost adjustments.
642 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200643static __always_inline int timekeeping_bigadjust(s64 error, s64 *interval,
john stultz85240702007-05-08 00:27:59 -0700644 s64 *offset)
645{
646 s64 tick_error, i;
647 u32 look_ahead, adj;
648 s32 error2, mult;
649
650 /*
651 * Use the current error value to determine how much to look ahead.
652 * The larger the error the slower we adjust for it to avoid problems
653 * with losing too many ticks, otherwise we would overadjust and
654 * produce an even larger error. The smaller the adjustment the
655 * faster we try to adjust for it, as lost ticks can do less harm
Li Zefan3eb05672008-02-08 04:19:25 -0800656 * here. This is tuned so that an error of about 1 msec is adjusted
john stultz85240702007-05-08 00:27:59 -0700657 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
658 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200659 error2 = timekeeper.ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
john stultz85240702007-05-08 00:27:59 -0700660 error2 = abs(error2);
661 for (look_ahead = 0; error2 > 0; look_ahead++)
662 error2 >>= 2;
663
664 /*
665 * Now calculate the error in (1 << look_ahead) ticks, but first
666 * remove the single look ahead already included in the error.
667 */
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200668 tick_error = tick_length >> (timekeeper.ntp_error_shift + 1);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200669 tick_error -= timekeeper.xtime_interval >> 1;
john stultz85240702007-05-08 00:27:59 -0700670 error = ((error - tick_error) >> look_ahead) + tick_error;
671
672 /* Finally calculate the adjustment shift value. */
673 i = *interval;
674 mult = 1;
675 if (error < 0) {
676 error = -error;
677 *interval = -*interval;
678 *offset = -*offset;
679 mult = -1;
680 }
681 for (adj = 0; error > i; adj++)
682 error >>= 1;
683
684 *interval <<= adj;
685 *offset <<= adj;
686 return mult << adj;
687}
688
689/*
690 * Adjust the multiplier to reduce the error value,
691 * this is optimized for the most common adjustments of -1,0,1,
692 * for other values we can do a bit more work.
693 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200694static void timekeeping_adjust(s64 offset)
john stultz85240702007-05-08 00:27:59 -0700695{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200696 s64 error, interval = timekeeper.cycle_interval;
john stultz85240702007-05-08 00:27:59 -0700697 int adj;
698
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200699 error = timekeeper.ntp_error >> (timekeeper.ntp_error_shift - 1);
john stultz85240702007-05-08 00:27:59 -0700700 if (error > interval) {
701 error >>= 2;
702 if (likely(error <= interval))
703 adj = 1;
704 else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200705 adj = timekeeping_bigadjust(error, &interval, &offset);
john stultz85240702007-05-08 00:27:59 -0700706 } else if (error < -interval) {
707 error >>= 2;
708 if (likely(error >= -interval)) {
709 adj = -1;
710 interval = -interval;
711 offset = -offset;
712 } else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200713 adj = timekeeping_bigadjust(error, &interval, &offset);
john stultz85240702007-05-08 00:27:59 -0700714 } else
715 return;
716
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200717 timekeeper.mult += adj;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200718 timekeeper.xtime_interval += interval;
719 timekeeper.xtime_nsec -= offset;
720 timekeeper.ntp_error -= (interval - offset) <<
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200721 timekeeper.ntp_error_shift;
john stultz85240702007-05-08 00:27:59 -0700722}
723
724/**
725 * update_wall_time - Uses the current clocksource to increment the wall time
726 *
727 * Called from the timer interrupt, must hold a write on xtime_lock.
728 */
729void update_wall_time(void)
730{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200731 struct clocksource *clock;
john stultz85240702007-05-08 00:27:59 -0700732 cycle_t offset;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200733 u64 nsecs;
john stultz85240702007-05-08 00:27:59 -0700734
735 /* Make sure we're fully resumed: */
736 if (unlikely(timekeeping_suspended))
737 return;
738
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200739 clock = timekeeper.clock;
john stultz85240702007-05-08 00:27:59 -0700740#ifdef CONFIG_GENERIC_TIME
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200741 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
john stultz85240702007-05-08 00:27:59 -0700742#else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200743 offset = timekeeper.cycle_interval;
john stultz85240702007-05-08 00:27:59 -0700744#endif
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200745 timekeeper.xtime_nsec = (s64)xtime.tv_nsec << timekeeper.shift;
john stultz85240702007-05-08 00:27:59 -0700746
747 /* normally this loop will run just once, however in the
748 * case of lost or late ticks, it will accumulate correctly.
749 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200750 while (offset >= timekeeper.cycle_interval) {
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200751 u64 nsecps = (u64)NSEC_PER_SEC << timekeeper.shift;
john stultz85240702007-05-08 00:27:59 -0700752
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200753 /* accumulate one interval */
754 offset -= timekeeper.cycle_interval;
755 clock->cycle_last += timekeeper.cycle_interval;
756
757 timekeeper.xtime_nsec += timekeeper.xtime_interval;
758 if (timekeeper.xtime_nsec >= nsecps) {
759 timekeeper.xtime_nsec -= nsecps;
john stultz85240702007-05-08 00:27:59 -0700760 xtime.tv_sec++;
761 second_overflow();
762 }
763
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200764 raw_time.tv_nsec += timekeeper.raw_interval;
765 if (raw_time.tv_nsec >= NSEC_PER_SEC) {
766 raw_time.tv_nsec -= NSEC_PER_SEC;
767 raw_time.tv_sec++;
John Stultz2d422442008-08-20 16:37:30 -0700768 }
769
john stultz85240702007-05-08 00:27:59 -0700770 /* accumulate error between NTP and clock interval */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200771 timekeeper.ntp_error += tick_length;
772 timekeeper.ntp_error -= timekeeper.xtime_interval <<
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200773 timekeeper.ntp_error_shift;
john stultz85240702007-05-08 00:27:59 -0700774 }
775
776 /* correct the clock when NTP error is too big */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200777 timekeeping_adjust(offset);
john stultz85240702007-05-08 00:27:59 -0700778
john stultz6c9bacb2008-12-01 18:34:41 -0800779 /*
780 * Since in the loop above, we accumulate any amount of time
781 * in xtime_nsec over a second into xtime.tv_sec, its possible for
782 * xtime_nsec to be fairly small after the loop. Further, if we're
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200783 * slightly speeding the clocksource up in timekeeping_adjust(),
john stultz6c9bacb2008-12-01 18:34:41 -0800784 * its possible the required corrective factor to xtime_nsec could
785 * cause it to underflow.
786 *
787 * Now, we cannot simply roll the accumulated second back, since
788 * the NTP subsystem has been notified via second_overflow. So
789 * instead we push xtime_nsec forward by the amount we underflowed,
790 * and add that amount into the error.
791 *
792 * We'll correct this error next time through this function, when
793 * xtime_nsec is not as small.
794 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200795 if (unlikely((s64)timekeeper.xtime_nsec < 0)) {
796 s64 neg = -(s64)timekeeper.xtime_nsec;
797 timekeeper.xtime_nsec = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200798 timekeeper.ntp_error += neg << timekeeper.ntp_error_shift;
john stultz6c9bacb2008-12-01 18:34:41 -0800799 }
800
Roman Zippel5cd1c9c2008-09-22 14:42:43 -0700801 /* store full nanoseconds into xtime after rounding it up and
802 * add the remainder to the error difference.
803 */
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200804 xtime.tv_nsec = ((s64) timekeeper.xtime_nsec >> timekeeper.shift) + 1;
805 timekeeper.xtime_nsec -= (s64) xtime.tv_nsec << timekeeper.shift;
806 timekeeper.ntp_error += timekeeper.xtime_nsec <<
807 timekeeper.ntp_error_shift;
john stultz85240702007-05-08 00:27:59 -0700808
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200809 nsecs = clocksource_cyc2ns(offset, timekeeper.mult, timekeeper.shift);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200810 update_xtime_cache(nsecs);
john stultz17c38b72007-07-24 18:38:34 -0700811
john stultz85240702007-05-08 00:27:59 -0700812 /* check to see if there is a new clocksource to use */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200813 update_vsyscall(&xtime, timekeeper.clock);
john stultz85240702007-05-08 00:27:59 -0700814}
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700815
816/**
817 * getboottime - Return the real time of system boot.
818 * @ts: pointer to the timespec to be set
819 *
820 * Returns the time of day in a timespec.
821 *
822 * This is based on the wall_to_monotonic offset and the total suspend
823 * time. Calls to settimeofday will affect the value returned (which
824 * basically means that however wrong your real time clock is at boot time,
825 * you get the right time here).
826 */
827void getboottime(struct timespec *ts)
828{
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200829 struct timespec boottime;
830
831 boottime = timespec_add_safe(wall_to_monotonic, total_sleep_time);
832 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700833}
834
835/**
836 * monotonic_to_bootbased - Convert the monotonic time to boot based.
837 * @ts: pointer to the timespec to be converted
838 */
839void monotonic_to_bootbased(struct timespec *ts)
840{
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200841 *ts = timespec_add_safe(*ts, total_sleep_time);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700842}
john stultz2c6b47d2007-07-24 17:47:43 -0700843
john stultz17c38b72007-07-24 18:38:34 -0700844unsigned long get_seconds(void)
845{
846 return xtime_cache.tv_sec;
847}
848EXPORT_SYMBOL(get_seconds);
849
850
john stultz2c6b47d2007-07-24 17:47:43 -0700851struct timespec current_kernel_time(void)
852{
853 struct timespec now;
854 unsigned long seq;
855
856 do {
857 seq = read_seqbegin(&xtime_lock);
858
john stultz17c38b72007-07-24 18:38:34 -0700859 now = xtime_cache;
john stultz2c6b47d2007-07-24 17:47:43 -0700860 } while (read_seqretry(&xtime_lock, seq));
861
862 return now;
863}
john stultz2c6b47d2007-07-24 17:47:43 -0700864EXPORT_SYMBOL(current_kernel_time);