blob: caf8d4d4f5c873dffbbc124c62cff08d84a0eb0d [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>
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040016#include <linux/sched.h>
john stultz85240702007-05-08 00:27:59 -070017#include <linux/sysdev.h>
18#include <linux/clocksource.h>
19#include <linux/jiffies.h>
20#include <linux/time.h>
21#include <linux/tick.h>
Martin Schwidefsky75c51582009-08-14 15:47:30 +020022#include <linux/stop_machine.h>
john stultz85240702007-05-08 00:27:59 -070023
Martin Schwidefsky155ec602009-08-14 15:47:26 +020024/* Structure holding internal timekeeping values. */
25struct timekeeper {
26 /* Current clocksource used for timekeeping. */
27 struct clocksource *clock;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020028 /* The shift value of the current clocksource. */
29 int shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020030
31 /* Number of clock cycles in one NTP interval. */
32 cycle_t cycle_interval;
33 /* Number of clock shifted nano seconds in one NTP interval. */
34 u64 xtime_interval;
35 /* Raw nano seconds accumulated per NTP interval. */
36 u32 raw_interval;
37
38 /* Clock shifted nano seconds remainder not stored in xtime.tv_nsec. */
39 u64 xtime_nsec;
40 /* Difference between accumulated time and NTP time in ntp
41 * shifted nano seconds. */
42 s64 ntp_error;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020043 /* Shift conversion between clock shifted nano seconds and
44 * ntp shifted nano seconds. */
45 int ntp_error_shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020046 /* NTP adjusted clock multiplier */
47 u32 mult;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020048};
49
50struct timekeeper timekeeper;
51
52/**
53 * timekeeper_setup_internals - Set up internals to use clocksource clock.
54 *
55 * @clock: Pointer to clocksource.
56 *
57 * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
58 * pair and interval request.
59 *
60 * Unless you're the timekeeping code, you should not be using this!
61 */
62static void timekeeper_setup_internals(struct clocksource *clock)
63{
64 cycle_t interval;
65 u64 tmp;
66
67 timekeeper.clock = clock;
68 clock->cycle_last = clock->read(clock);
69
70 /* Do the ns -> cycle conversion first, using original mult */
71 tmp = NTP_INTERVAL_LENGTH;
72 tmp <<= clock->shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020073 tmp += clock->mult/2;
74 do_div(tmp, clock->mult);
Martin Schwidefsky155ec602009-08-14 15:47:26 +020075 if (tmp == 0)
76 tmp = 1;
77
78 interval = (cycle_t) tmp;
79 timekeeper.cycle_interval = interval;
80
81 /* Go back from cycles -> shifted ns */
82 timekeeper.xtime_interval = (u64) interval * clock->mult;
83 timekeeper.raw_interval =
Martin Schwidefsky0a544192009-08-14 15:47:28 +020084 ((u64) interval * clock->mult) >> clock->shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020085
86 timekeeper.xtime_nsec = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020087 timekeeper.shift = clock->shift;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020088
89 timekeeper.ntp_error = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +020090 timekeeper.ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
Martin Schwidefsky0a544192009-08-14 15:47:28 +020091
92 /*
93 * The timekeeper keeps its own mult values for the currently
94 * active clocksource. These value will be adjusted via NTP
95 * to counteract clock drifting.
96 */
97 timekeeper.mult = clock->mult;
Martin Schwidefsky155ec602009-08-14 15:47:26 +020098}
john stultz85240702007-05-08 00:27:59 -070099
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200100/* Timekeeper helper functions. */
101static inline s64 timekeeping_get_ns(void)
102{
103 cycle_t cycle_now, cycle_delta;
104 struct clocksource *clock;
105
106 /* read clocksource: */
107 clock = timekeeper.clock;
108 cycle_now = clock->read(clock);
109
110 /* calculate the delta since the last update_wall_time: */
111 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
112
113 /* return delta convert to nanoseconds using ntp adjusted mult. */
114 return clocksource_cyc2ns(cycle_delta, timekeeper.mult,
115 timekeeper.shift);
116}
117
118static inline s64 timekeeping_get_ns_raw(void)
119{
120 cycle_t cycle_now, cycle_delta;
121 struct clocksource *clock;
122
123 /* read clocksource: */
124 clock = timekeeper.clock;
125 cycle_now = clock->read(clock);
126
127 /* calculate the delta since the last update_wall_time: */
128 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
129
130 /* return delta convert to nanoseconds using ntp adjusted mult. */
131 return clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
132}
133
john stultz85240702007-05-08 00:27:59 -0700134/*
135 * This read-write spinlock protects us from races in SMP while
Thomas Gleixnerdce48a82009-04-11 10:43:41 +0200136 * playing with xtime.
john stultz85240702007-05-08 00:27:59 -0700137 */
Adrian Bunkba2a6312007-10-16 23:27:16 -0700138__cacheline_aligned_in_smp DEFINE_SEQLOCK(xtime_lock);
john stultz85240702007-05-08 00:27:59 -0700139
140
141/*
142 * The current time
143 * wall_to_monotonic is what we need to add to xtime (or xtime corrected
144 * for sub jiffie times) to get to monotonic time. Monotonic is pegged
145 * at zero at system boot time, so wall_to_monotonic will be negative,
146 * however, we will ALWAYS keep the tv_nsec part positive so we can use
147 * the usual normalization.
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700148 *
149 * wall_to_monotonic is moved after resume from suspend for the monotonic
150 * time not to jump. We need to add total_sleep_time to wall_to_monotonic
151 * to get the real boot based time offset.
152 *
153 * - wall_to_monotonic is no longer the boot time, getboottime must be
154 * used instead.
john stultz85240702007-05-08 00:27:59 -0700155 */
156struct timespec xtime __attribute__ ((aligned (16)));
157struct timespec wall_to_monotonic __attribute__ ((aligned (16)));
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200158static struct timespec total_sleep_time;
john stultz85240702007-05-08 00:27:59 -0700159
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200160/*
161 * The raw monotonic time for the CLOCK_MONOTONIC_RAW posix clock.
162 */
163struct timespec raw_time;
164
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100165/* flag for if timekeeping is suspended */
166int __read_mostly timekeeping_suspended;
167
John Stultz31089c12009-08-14 15:47:18 +0200168/* must hold xtime_lock */
169void timekeeping_leap_insert(int leapsecond)
170{
171 xtime.tv_sec += leapsecond;
172 wall_to_monotonic.tv_sec -= leapsecond;
Lin Ming0696b712009-11-17 13:49:50 +0800173 update_vsyscall(&xtime, timekeeper.clock, timekeeper.mult);
John Stultz31089c12009-08-14 15:47:18 +0200174}
john stultz85240702007-05-08 00:27:59 -0700175
176#ifdef CONFIG_GENERIC_TIME
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200177
john stultz85240702007-05-08 00:27:59 -0700178/**
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200179 * timekeeping_forward_now - update clock to the current time
john stultz85240702007-05-08 00:27:59 -0700180 *
Roman Zippel9a055112008-08-20 16:37:28 -0700181 * Forward the current clock to update its state since the last call to
182 * update_wall_time(). This is useful before significant clock changes,
183 * as it avoids having to deal with this time offset explicitly.
john stultz85240702007-05-08 00:27:59 -0700184 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200185static void timekeeping_forward_now(void)
john stultz85240702007-05-08 00:27:59 -0700186{
187 cycle_t cycle_now, cycle_delta;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200188 struct clocksource *clock;
Roman Zippel9a055112008-08-20 16:37:28 -0700189 s64 nsec;
john stultz85240702007-05-08 00:27:59 -0700190
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200191 clock = timekeeper.clock;
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200192 cycle_now = clock->read(clock);
john stultz85240702007-05-08 00:27:59 -0700193 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
Roman Zippel9a055112008-08-20 16:37:28 -0700194 clock->cycle_last = cycle_now;
john stultz85240702007-05-08 00:27:59 -0700195
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200196 nsec = clocksource_cyc2ns(cycle_delta, timekeeper.mult,
197 timekeeper.shift);
john stultz7d275582009-05-01 13:10:26 -0700198
199 /* If arch requires, add in gettimeoffset() */
200 nsec += arch_gettimeoffset();
201
Roman Zippel9a055112008-08-20 16:37:28 -0700202 timespec_add_ns(&xtime, nsec);
John Stultz2d422442008-08-20 16:37:30 -0700203
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200204 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200205 timespec_add_ns(&raw_time, nsec);
john stultz85240702007-05-08 00:27:59 -0700206}
207
208/**
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100209 * getnstimeofday - Returns the time of day in a timespec
john stultz85240702007-05-08 00:27:59 -0700210 * @ts: pointer to the timespec to be set
211 *
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100212 * Returns the time of day in a timespec.
john stultz85240702007-05-08 00:27:59 -0700213 */
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100214void getnstimeofday(struct timespec *ts)
john stultz85240702007-05-08 00:27:59 -0700215{
216 unsigned long seq;
217 s64 nsecs;
218
Thomas Gleixner1c5745a2008-12-22 23:05:28 +0100219 WARN_ON(timekeeping_suspended);
220
john stultz85240702007-05-08 00:27:59 -0700221 do {
222 seq = read_seqbegin(&xtime_lock);
223
224 *ts = xtime;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200225 nsecs = timekeeping_get_ns();
john stultz85240702007-05-08 00:27:59 -0700226
john stultz7d275582009-05-01 13:10:26 -0700227 /* If arch requires, add in gettimeoffset() */
228 nsecs += arch_gettimeoffset();
229
john stultz85240702007-05-08 00:27:59 -0700230 } while (read_seqretry(&xtime_lock, seq));
231
232 timespec_add_ns(ts, nsecs);
233}
234
john stultz85240702007-05-08 00:27:59 -0700235EXPORT_SYMBOL(getnstimeofday);
236
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200237ktime_t ktime_get(void)
238{
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200239 unsigned int seq;
240 s64 secs, nsecs;
241
242 WARN_ON(timekeeping_suspended);
243
244 do {
245 seq = read_seqbegin(&xtime_lock);
246 secs = xtime.tv_sec + wall_to_monotonic.tv_sec;
247 nsecs = xtime.tv_nsec + wall_to_monotonic.tv_nsec;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200248 nsecs += timekeeping_get_ns();
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200249
250 } while (read_seqretry(&xtime_lock, seq));
251 /*
252 * Use ktime_set/ktime_add_ns to create a proper ktime on
253 * 32-bit architectures without CONFIG_KTIME_SCALAR.
254 */
255 return ktime_add_ns(ktime_set(secs, 0), nsecs);
256}
257EXPORT_SYMBOL_GPL(ktime_get);
258
259/**
260 * ktime_get_ts - get the monotonic clock in timespec format
261 * @ts: pointer to timespec variable
262 *
263 * The function calculates the monotonic clock from the realtime
264 * clock and the wall_to_monotonic offset and stores the result
265 * in normalized timespec format in the variable pointed to by @ts.
266 */
267void ktime_get_ts(struct timespec *ts)
268{
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200269 struct timespec tomono;
270 unsigned int seq;
271 s64 nsecs;
272
273 WARN_ON(timekeeping_suspended);
274
275 do {
276 seq = read_seqbegin(&xtime_lock);
277 *ts = xtime;
278 tomono = wall_to_monotonic;
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200279 nsecs = timekeeping_get_ns();
Martin Schwidefsky951ed4d2009-07-07 11:27:28 +0200280
281 } while (read_seqretry(&xtime_lock, seq));
282
283 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
284 ts->tv_nsec + tomono.tv_nsec + nsecs);
285}
286EXPORT_SYMBOL_GPL(ktime_get_ts);
287
john stultz85240702007-05-08 00:27:59 -0700288/**
289 * do_gettimeofday - Returns the time of day in a timeval
290 * @tv: pointer to the timeval to be set
291 *
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100292 * NOTE: Users should be converted to using getnstimeofday()
john stultz85240702007-05-08 00:27:59 -0700293 */
294void do_gettimeofday(struct timeval *tv)
295{
296 struct timespec now;
297
Geert Uytterhoevenefd9ac82008-01-30 13:30:01 +0100298 getnstimeofday(&now);
john stultz85240702007-05-08 00:27:59 -0700299 tv->tv_sec = now.tv_sec;
300 tv->tv_usec = now.tv_nsec/1000;
301}
302
303EXPORT_SYMBOL(do_gettimeofday);
304/**
305 * do_settimeofday - Sets the time of day
306 * @tv: pointer to the timespec variable containing the new time
307 *
308 * Sets the time of day to the new time and update NTP and notify hrtimers
309 */
310int do_settimeofday(struct timespec *tv)
311{
Roman Zippel9a055112008-08-20 16:37:28 -0700312 struct timespec ts_delta;
john stultz85240702007-05-08 00:27:59 -0700313 unsigned long flags;
john stultz85240702007-05-08 00:27:59 -0700314
315 if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
316 return -EINVAL;
317
318 write_seqlock_irqsave(&xtime_lock, flags);
319
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200320 timekeeping_forward_now();
john stultz85240702007-05-08 00:27:59 -0700321
Roman Zippel9a055112008-08-20 16:37:28 -0700322 ts_delta.tv_sec = tv->tv_sec - xtime.tv_sec;
323 ts_delta.tv_nsec = tv->tv_nsec - xtime.tv_nsec;
324 wall_to_monotonic = timespec_sub(wall_to_monotonic, ts_delta);
john stultz85240702007-05-08 00:27:59 -0700325
Roman Zippel9a055112008-08-20 16:37:28 -0700326 xtime = *tv;
327
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200328 timekeeper.ntp_error = 0;
john stultz85240702007-05-08 00:27:59 -0700329 ntp_clear();
330
Lin Ming0696b712009-11-17 13:49:50 +0800331 update_vsyscall(&xtime, timekeeper.clock, timekeeper.mult);
john stultz85240702007-05-08 00:27:59 -0700332
333 write_sequnlock_irqrestore(&xtime_lock, flags);
334
335 /* signal hrtimers about time change */
336 clock_was_set();
337
338 return 0;
339}
340
341EXPORT_SYMBOL(do_settimeofday);
342
343/**
344 * change_clocksource - Swaps clocksources if a new one is available
345 *
346 * Accumulates current time interval and initializes new clocksource
347 */
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200348static int change_clocksource(void *data)
john stultz85240702007-05-08 00:27:59 -0700349{
Magnus Damm4614e6a2009-04-21 12:24:02 -0700350 struct clocksource *new, *old;
john stultz85240702007-05-08 00:27:59 -0700351
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200352 new = (struct clocksource *) data;
john stultz85240702007-05-08 00:27:59 -0700353
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200354 timekeeping_forward_now();
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200355 if (!new->enable || new->enable(new) == 0) {
356 old = timekeeper.clock;
357 timekeeper_setup_internals(new);
358 if (old->disable)
359 old->disable(old);
360 }
361 return 0;
362}
john stultz85240702007-05-08 00:27:59 -0700363
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200364/**
365 * timekeeping_notify - Install a new clock source
366 * @clock: pointer to the clock source
367 *
368 * This function is called from clocksource.c after a new, better clock
369 * source has been registered. The caller holds the clocksource_mutex.
370 */
371void timekeeping_notify(struct clocksource *clock)
372{
373 if (timekeeper.clock == clock)
Magnus Damm4614e6a2009-04-21 12:24:02 -0700374 return;
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200375 stop_machine(change_clocksource, clock, NULL);
john stultz85240702007-05-08 00:27:59 -0700376 tick_clock_notify();
john stultz85240702007-05-08 00:27:59 -0700377}
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200378
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200379#else /* GENERIC_TIME */
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200380
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200381static inline void timekeeping_forward_now(void) { }
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200382
383/**
384 * ktime_get - get the monotonic time in ktime_t format
385 *
386 * returns the time in ktime_t format
387 */
388ktime_t ktime_get(void)
389{
390 struct timespec now;
391
392 ktime_get_ts(&now);
393
394 return timespec_to_ktime(now);
395}
396EXPORT_SYMBOL_GPL(ktime_get);
397
398/**
399 * ktime_get_ts - get the monotonic clock in timespec format
400 * @ts: pointer to timespec variable
401 *
402 * The function calculates the monotonic clock from the realtime
403 * clock and the wall_to_monotonic offset and stores the result
404 * in normalized timespec format in the variable pointed to by @ts.
405 */
406void ktime_get_ts(struct timespec *ts)
407{
408 struct timespec tomono;
409 unsigned long seq;
410
411 do {
412 seq = read_seqbegin(&xtime_lock);
413 getnstimeofday(ts);
414 tomono = wall_to_monotonic;
415
416 } while (read_seqretry(&xtime_lock, seq));
417
418 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
419 ts->tv_nsec + tomono.tv_nsec);
420}
421EXPORT_SYMBOL_GPL(ktime_get_ts);
Martin Schwidefsky75c51582009-08-14 15:47:30 +0200422
Thomas Gleixnera40f2622009-07-07 13:00:31 +0200423#endif /* !GENERIC_TIME */
424
425/**
426 * ktime_get_real - get the real (wall-) time in ktime_t format
427 *
428 * returns the time in ktime_t format
429 */
430ktime_t ktime_get_real(void)
431{
432 struct timespec now;
433
434 getnstimeofday(&now);
435
436 return timespec_to_ktime(now);
437}
438EXPORT_SYMBOL_GPL(ktime_get_real);
john stultz85240702007-05-08 00:27:59 -0700439
440/**
John Stultz2d422442008-08-20 16:37:30 -0700441 * getrawmonotonic - Returns the raw monotonic time in a timespec
442 * @ts: pointer to the timespec to be set
443 *
444 * Returns the raw monotonic time (completely un-modified by ntp)
445 */
446void getrawmonotonic(struct timespec *ts)
447{
448 unsigned long seq;
449 s64 nsecs;
John Stultz2d422442008-08-20 16:37:30 -0700450
451 do {
452 seq = read_seqbegin(&xtime_lock);
Martin Schwidefsky2ba2a302009-08-14 15:47:29 +0200453 nsecs = timekeeping_get_ns_raw();
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200454 *ts = raw_time;
John Stultz2d422442008-08-20 16:37:30 -0700455
456 } while (read_seqretry(&xtime_lock, seq));
457
458 timespec_add_ns(ts, nsecs);
459}
460EXPORT_SYMBOL(getrawmonotonic);
461
462
463/**
Li Zefancf4fc6c2008-02-08 04:19:24 -0800464 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
john stultz85240702007-05-08 00:27:59 -0700465 */
Li Zefancf4fc6c2008-02-08 04:19:24 -0800466int timekeeping_valid_for_hres(void)
john stultz85240702007-05-08 00:27:59 -0700467{
468 unsigned long seq;
469 int ret;
470
471 do {
472 seq = read_seqbegin(&xtime_lock);
473
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200474 ret = timekeeper.clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
john stultz85240702007-05-08 00:27:59 -0700475
476 } while (read_seqretry(&xtime_lock, seq));
477
478 return ret;
479}
480
481/**
Jon Hunter98962462009-08-18 12:45:10 -0500482 * timekeeping_max_deferment - Returns max time the clocksource can be deferred
483 *
484 * Caller must observe xtime_lock via read_seqbegin/read_seqretry to
485 * ensure that the clocksource does not change!
486 */
487u64 timekeeping_max_deferment(void)
488{
489 return timekeeper.clock->max_idle_ns;
490}
491
492/**
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200493 * read_persistent_clock - Return time from the persistent clock.
john stultz85240702007-05-08 00:27:59 -0700494 *
495 * Weak dummy function for arches that do not yet support it.
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200496 * Reads the time from the battery backed persistent clock.
497 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
john stultz85240702007-05-08 00:27:59 -0700498 *
499 * XXX - Do be sure to remove it once all arches implement it.
500 */
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200501void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
john stultz85240702007-05-08 00:27:59 -0700502{
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200503 ts->tv_sec = 0;
504 ts->tv_nsec = 0;
john stultz85240702007-05-08 00:27:59 -0700505}
506
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200507/**
508 * read_boot_clock - Return time of the system start.
509 *
510 * Weak dummy function for arches that do not yet support it.
511 * Function to read the exact time the system has been started.
512 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
513 *
514 * XXX - Do be sure to remove it once all arches implement it.
515 */
516void __attribute__((weak)) read_boot_clock(struct timespec *ts)
517{
518 ts->tv_sec = 0;
519 ts->tv_nsec = 0;
520}
521
john stultz85240702007-05-08 00:27:59 -0700522/*
523 * timekeeping_init - Initializes the clocksource and common timekeeping values
524 */
525void __init timekeeping_init(void)
526{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200527 struct clocksource *clock;
john stultz85240702007-05-08 00:27:59 -0700528 unsigned long flags;
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200529 struct timespec now, boot;
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200530
531 read_persistent_clock(&now);
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200532 read_boot_clock(&boot);
john stultz85240702007-05-08 00:27:59 -0700533
534 write_seqlock_irqsave(&xtime_lock, flags);
535
Roman Zippel7dffa3c2008-05-01 04:34:41 -0700536 ntp_init();
john stultz85240702007-05-08 00:27:59 -0700537
Martin Schwidefskyf1b82742009-08-14 15:47:21 +0200538 clock = clocksource_default_clock();
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200539 if (clock->enable)
540 clock->enable(clock);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200541 timekeeper_setup_internals(clock);
john stultz85240702007-05-08 00:27:59 -0700542
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200543 xtime.tv_sec = now.tv_sec;
544 xtime.tv_nsec = now.tv_nsec;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200545 raw_time.tv_sec = 0;
546 raw_time.tv_nsec = 0;
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200547 if (boot.tv_sec == 0 && boot.tv_nsec == 0) {
548 boot.tv_sec = xtime.tv_sec;
549 boot.tv_nsec = xtime.tv_nsec;
550 }
john stultz85240702007-05-08 00:27:59 -0700551 set_normalized_timespec(&wall_to_monotonic,
Martin Schwidefsky23970e32009-08-14 15:47:32 +0200552 -boot.tv_sec, -boot.tv_nsec);
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200553 total_sleep_time.tv_sec = 0;
554 total_sleep_time.tv_nsec = 0;
john stultz85240702007-05-08 00:27:59 -0700555 write_sequnlock_irqrestore(&xtime_lock, flags);
556}
557
john stultz85240702007-05-08 00:27:59 -0700558/* time in seconds when suspend began */
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200559static struct timespec timekeeping_suspend_time;
john stultz85240702007-05-08 00:27:59 -0700560
561/**
562 * timekeeping_resume - Resumes the generic timekeeping subsystem.
563 * @dev: unused
564 *
565 * This is for the generic clocksource timekeeping.
566 * xtime/wall_to_monotonic/jiffies/etc are
567 * still managed by arch specific suspend/resume code.
568 */
569static int timekeeping_resume(struct sys_device *dev)
570{
571 unsigned long flags;
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200572 struct timespec ts;
573
574 read_persistent_clock(&ts);
john stultz85240702007-05-08 00:27:59 -0700575
Thomas Gleixnerd10ff3f2007-05-14 11:10:02 +0200576 clocksource_resume();
577
john stultz85240702007-05-08 00:27:59 -0700578 write_seqlock_irqsave(&xtime_lock, flags);
579
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200580 if (timespec_compare(&ts, &timekeeping_suspend_time) > 0) {
581 ts = timespec_sub(ts, timekeeping_suspend_time);
582 xtime = timespec_add_safe(xtime, ts);
583 wall_to_monotonic = timespec_sub(wall_to_monotonic, ts);
584 total_sleep_time = timespec_add_safe(total_sleep_time, ts);
john stultz85240702007-05-08 00:27:59 -0700585 }
586 /* re-base the last cycle value */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200587 timekeeper.clock->cycle_last = timekeeper.clock->read(timekeeper.clock);
588 timekeeper.ntp_error = 0;
john stultz85240702007-05-08 00:27:59 -0700589 timekeeping_suspended = 0;
590 write_sequnlock_irqrestore(&xtime_lock, flags);
591
592 touch_softlockup_watchdog();
593
594 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
595
596 /* Resume hrtimers */
597 hres_timers_resume();
598
599 return 0;
600}
601
602static int timekeeping_suspend(struct sys_device *dev, pm_message_t state)
603{
604 unsigned long flags;
605
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200606 read_persistent_clock(&timekeeping_suspend_time);
Thomas Gleixner3be90952007-09-16 15:36:43 +0200607
john stultz85240702007-05-08 00:27:59 -0700608 write_seqlock_irqsave(&xtime_lock, flags);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200609 timekeeping_forward_now();
john stultz85240702007-05-08 00:27:59 -0700610 timekeeping_suspended = 1;
john stultz85240702007-05-08 00:27:59 -0700611 write_sequnlock_irqrestore(&xtime_lock, flags);
612
613 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
Magnus Dammc54a42b2010-02-02 14:41:41 -0800614 clocksource_suspend();
john stultz85240702007-05-08 00:27:59 -0700615
616 return 0;
617}
618
619/* sysfs resume/suspend bits for timekeeping */
620static struct sysdev_class timekeeping_sysclass = {
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100621 .name = "timekeeping",
john stultz85240702007-05-08 00:27:59 -0700622 .resume = timekeeping_resume,
623 .suspend = timekeeping_suspend,
john stultz85240702007-05-08 00:27:59 -0700624};
625
626static struct sys_device device_timer = {
627 .id = 0,
628 .cls = &timekeeping_sysclass,
629};
630
631static int __init timekeeping_init_device(void)
632{
633 int error = sysdev_class_register(&timekeeping_sysclass);
634 if (!error)
635 error = sysdev_register(&device_timer);
636 return error;
637}
638
639device_initcall(timekeeping_init_device);
640
641/*
642 * If the error is already larger, we look ahead even further
643 * to compensate for late or lost adjustments.
644 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200645static __always_inline int timekeeping_bigadjust(s64 error, s64 *interval,
john stultz85240702007-05-08 00:27:59 -0700646 s64 *offset)
647{
648 s64 tick_error, i;
649 u32 look_ahead, adj;
650 s32 error2, mult;
651
652 /*
653 * Use the current error value to determine how much to look ahead.
654 * The larger the error the slower we adjust for it to avoid problems
655 * with losing too many ticks, otherwise we would overadjust and
656 * produce an even larger error. The smaller the adjustment the
657 * faster we try to adjust for it, as lost ticks can do less harm
Li Zefan3eb05672008-02-08 04:19:25 -0800658 * here. This is tuned so that an error of about 1 msec is adjusted
john stultz85240702007-05-08 00:27:59 -0700659 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
660 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200661 error2 = timekeeper.ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
john stultz85240702007-05-08 00:27:59 -0700662 error2 = abs(error2);
663 for (look_ahead = 0; error2 > 0; look_ahead++)
664 error2 >>= 2;
665
666 /*
667 * Now calculate the error in (1 << look_ahead) ticks, but first
668 * remove the single look ahead already included in the error.
669 */
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200670 tick_error = tick_length >> (timekeeper.ntp_error_shift + 1);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200671 tick_error -= timekeeper.xtime_interval >> 1;
john stultz85240702007-05-08 00:27:59 -0700672 error = ((error - tick_error) >> look_ahead) + tick_error;
673
674 /* Finally calculate the adjustment shift value. */
675 i = *interval;
676 mult = 1;
677 if (error < 0) {
678 error = -error;
679 *interval = -*interval;
680 *offset = -*offset;
681 mult = -1;
682 }
683 for (adj = 0; error > i; adj++)
684 error >>= 1;
685
686 *interval <<= adj;
687 *offset <<= adj;
688 return mult << adj;
689}
690
691/*
692 * Adjust the multiplier to reduce the error value,
693 * this is optimized for the most common adjustments of -1,0,1,
694 * for other values we can do a bit more work.
695 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200696static void timekeeping_adjust(s64 offset)
john stultz85240702007-05-08 00:27:59 -0700697{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200698 s64 error, interval = timekeeper.cycle_interval;
john stultz85240702007-05-08 00:27:59 -0700699 int adj;
700
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200701 error = timekeeper.ntp_error >> (timekeeper.ntp_error_shift - 1);
john stultz85240702007-05-08 00:27:59 -0700702 if (error > interval) {
703 error >>= 2;
704 if (likely(error <= interval))
705 adj = 1;
706 else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200707 adj = timekeeping_bigadjust(error, &interval, &offset);
john stultz85240702007-05-08 00:27:59 -0700708 } else if (error < -interval) {
709 error >>= 2;
710 if (likely(error >= -interval)) {
711 adj = -1;
712 interval = -interval;
713 offset = -offset;
714 } else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200715 adj = timekeeping_bigadjust(error, &interval, &offset);
john stultz85240702007-05-08 00:27:59 -0700716 } else
717 return;
718
Martin Schwidefsky0a544192009-08-14 15:47:28 +0200719 timekeeper.mult += adj;
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200720 timekeeper.xtime_interval += interval;
721 timekeeper.xtime_nsec -= offset;
722 timekeeper.ntp_error -= (interval - offset) <<
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200723 timekeeper.ntp_error_shift;
john stultz85240702007-05-08 00:27:59 -0700724}
725
Linus Torvalds83f57a12009-12-22 14:10:37 -0800726
john stultz85240702007-05-08 00:27:59 -0700727/**
john stultza092ff02009-10-02 16:17:53 -0700728 * logarithmic_accumulation - shifted accumulation of cycles
729 *
730 * This functions accumulates a shifted interval of cycles into
731 * into a shifted interval nanoseconds. Allows for O(log) accumulation
732 * loop.
733 *
734 * Returns the unconsumed cycles.
735 */
736static cycle_t logarithmic_accumulation(cycle_t offset, int shift)
737{
738 u64 nsecps = (u64)NSEC_PER_SEC << timekeeper.shift;
739
740 /* If the offset is smaller then a shifted interval, do nothing */
741 if (offset < timekeeper.cycle_interval<<shift)
742 return offset;
743
744 /* Accumulate one shifted interval */
745 offset -= timekeeper.cycle_interval << shift;
746 timekeeper.clock->cycle_last += timekeeper.cycle_interval << shift;
747
748 timekeeper.xtime_nsec += timekeeper.xtime_interval << shift;
749 while (timekeeper.xtime_nsec >= nsecps) {
750 timekeeper.xtime_nsec -= nsecps;
751 xtime.tv_sec++;
752 second_overflow();
753 }
754
755 /* Accumulate into raw time */
756 raw_time.tv_nsec += timekeeper.raw_interval << shift;;
757 while (raw_time.tv_nsec >= NSEC_PER_SEC) {
758 raw_time.tv_nsec -= NSEC_PER_SEC;
759 raw_time.tv_sec++;
760 }
761
762 /* Accumulate error between NTP and clock interval */
763 timekeeper.ntp_error += tick_length << shift;
764 timekeeper.ntp_error -= timekeeper.xtime_interval <<
765 (timekeeper.ntp_error_shift + shift);
766
767 return offset;
768}
769
Linus Torvalds83f57a12009-12-22 14:10:37 -0800770
john stultz85240702007-05-08 00:27:59 -0700771/**
772 * update_wall_time - Uses the current clocksource to increment the wall time
773 *
774 * Called from the timer interrupt, must hold a write on xtime_lock.
775 */
776void update_wall_time(void)
777{
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200778 struct clocksource *clock;
john stultz85240702007-05-08 00:27:59 -0700779 cycle_t offset;
john stultza092ff02009-10-02 16:17:53 -0700780 int shift = 0, maxshift;
john stultz85240702007-05-08 00:27:59 -0700781
782 /* Make sure we're fully resumed: */
783 if (unlikely(timekeeping_suspended))
784 return;
785
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200786 clock = timekeeper.clock;
john stultz85240702007-05-08 00:27:59 -0700787#ifdef CONFIG_GENERIC_TIME
Martin Schwidefskya0f7d482009-08-14 15:47:19 +0200788 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
john stultz85240702007-05-08 00:27:59 -0700789#else
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200790 offset = timekeeper.cycle_interval;
john stultz85240702007-05-08 00:27:59 -0700791#endif
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200792 timekeeper.xtime_nsec = (s64)xtime.tv_nsec << timekeeper.shift;
john stultz85240702007-05-08 00:27:59 -0700793
john stultza092ff02009-10-02 16:17:53 -0700794 /*
795 * With NO_HZ we may have to accumulate many cycle_intervals
796 * (think "ticks") worth of time at once. To do this efficiently,
797 * we calculate the largest doubling multiple of cycle_intervals
798 * that is smaller then the offset. We then accumulate that
799 * chunk in one go, and then try to consume the next smaller
800 * doubled multiple.
john stultz85240702007-05-08 00:27:59 -0700801 */
john stultza092ff02009-10-02 16:17:53 -0700802 shift = ilog2(offset) - ilog2(timekeeper.cycle_interval);
803 shift = max(0, shift);
804 /* Bound shift to one less then what overflows tick_length */
805 maxshift = (8*sizeof(tick_length) - (ilog2(tick_length)+1)) - 1;
806 shift = min(shift, maxshift);
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200807 while (offset >= timekeeper.cycle_interval) {
john stultza092ff02009-10-02 16:17:53 -0700808 offset = logarithmic_accumulation(offset, shift);
John Stultz830ec042010-03-18 14:47:30 -0700809 if(offset < timekeeper.cycle_interval<<shift)
810 shift--;
john stultz85240702007-05-08 00:27:59 -0700811 }
812
813 /* correct the clock when NTP error is too big */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200814 timekeeping_adjust(offset);
john stultz85240702007-05-08 00:27:59 -0700815
john stultz6c9bacb2008-12-01 18:34:41 -0800816 /*
817 * Since in the loop above, we accumulate any amount of time
818 * in xtime_nsec over a second into xtime.tv_sec, its possible for
819 * xtime_nsec to be fairly small after the loop. Further, if we're
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200820 * slightly speeding the clocksource up in timekeeping_adjust(),
john stultz6c9bacb2008-12-01 18:34:41 -0800821 * its possible the required corrective factor to xtime_nsec could
822 * cause it to underflow.
823 *
824 * Now, we cannot simply roll the accumulated second back, since
825 * the NTP subsystem has been notified via second_overflow. So
826 * instead we push xtime_nsec forward by the amount we underflowed,
827 * and add that amount into the error.
828 *
829 * We'll correct this error next time through this function, when
830 * xtime_nsec is not as small.
831 */
Martin Schwidefsky155ec602009-08-14 15:47:26 +0200832 if (unlikely((s64)timekeeper.xtime_nsec < 0)) {
833 s64 neg = -(s64)timekeeper.xtime_nsec;
834 timekeeper.xtime_nsec = 0;
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200835 timekeeper.ntp_error += neg << timekeeper.ntp_error_shift;
john stultz6c9bacb2008-12-01 18:34:41 -0800836 }
837
John Stultz6a867a32010-04-06 14:30:51 -0700838
839 /*
840 * Store full nanoseconds into xtime after rounding it up and
Roman Zippel5cd1c9c2008-09-22 14:42:43 -0700841 * add the remainder to the error difference.
842 */
Martin Schwidefsky23ce7212009-08-14 15:47:27 +0200843 xtime.tv_nsec = ((s64) timekeeper.xtime_nsec >> timekeeper.shift) + 1;
844 timekeeper.xtime_nsec -= (s64) xtime.tv_nsec << timekeeper.shift;
845 timekeeper.ntp_error += timekeeper.xtime_nsec <<
846 timekeeper.ntp_error_shift;
john stultz85240702007-05-08 00:27:59 -0700847
John Stultz6a867a32010-04-06 14:30:51 -0700848 /*
849 * Finally, make sure that after the rounding
850 * xtime.tv_nsec isn't larger then NSEC_PER_SEC
851 */
852 if (unlikely(xtime.tv_nsec >= NSEC_PER_SEC)) {
853 xtime.tv_nsec -= NSEC_PER_SEC;
854 xtime.tv_sec++;
855 second_overflow();
856 }
Linus Torvalds83f57a12009-12-22 14:10:37 -0800857
john stultz85240702007-05-08 00:27:59 -0700858 /* check to see if there is a new clocksource to use */
Lin Ming0696b712009-11-17 13:49:50 +0800859 update_vsyscall(&xtime, timekeeper.clock, timekeeper.mult);
john stultz85240702007-05-08 00:27:59 -0700860}
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700861
862/**
863 * getboottime - Return the real time of system boot.
864 * @ts: pointer to the timespec to be set
865 *
866 * Returns the time of day in a timespec.
867 *
868 * This is based on the wall_to_monotonic offset and the total suspend
869 * time. Calls to settimeofday will affect the value returned (which
870 * basically means that however wrong your real time clock is at boot time,
871 * you get the right time here).
872 */
873void getboottime(struct timespec *ts)
874{
Hiroshi Shimamoto36d47482009-08-25 15:08:30 +0900875 struct timespec boottime = {
876 .tv_sec = wall_to_monotonic.tv_sec + total_sleep_time.tv_sec,
877 .tv_nsec = wall_to_monotonic.tv_nsec + total_sleep_time.tv_nsec
878 };
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200879
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200880 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700881}
Jason Wangc93d89f2010-01-27 19:13:40 +0800882EXPORT_SYMBOL_GPL(getboottime);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700883
884/**
885 * monotonic_to_bootbased - Convert the monotonic time to boot based.
886 * @ts: pointer to the timespec to be converted
887 */
888void monotonic_to_bootbased(struct timespec *ts)
889{
Martin Schwidefskyd4f587c2009-08-14 15:47:31 +0200890 *ts = timespec_add_safe(*ts, total_sleep_time);
Tomas Janousek7c3f1a52007-07-15 23:39:41 -0700891}
Jason Wangc93d89f2010-01-27 19:13:40 +0800892EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
john stultz2c6b47d2007-07-24 17:47:43 -0700893
john stultz17c38b72007-07-24 18:38:34 -0700894unsigned long get_seconds(void)
895{
John Stultz6a867a32010-04-06 14:30:51 -0700896 return xtime.tv_sec;
john stultz17c38b72007-07-24 18:38:34 -0700897}
898EXPORT_SYMBOL(get_seconds);
899
john stultzda15cfd2009-08-19 19:13:34 -0700900struct timespec __current_kernel_time(void)
901{
John Stultz6a867a32010-04-06 14:30:51 -0700902 return xtime;
john stultzda15cfd2009-08-19 19:13:34 -0700903}
john stultz17c38b72007-07-24 18:38:34 -0700904
john stultz2c6b47d2007-07-24 17:47:43 -0700905struct timespec current_kernel_time(void)
906{
907 struct timespec now;
908 unsigned long seq;
909
910 do {
911 seq = read_seqbegin(&xtime_lock);
Linus Torvalds83f57a12009-12-22 14:10:37 -0800912
John Stultz6a867a32010-04-06 14:30:51 -0700913 now = xtime;
john stultz2c6b47d2007-07-24 17:47:43 -0700914 } while (read_seqretry(&xtime_lock, seq));
915
916 return now;
917}
john stultz2c6b47d2007-07-24 17:47:43 -0700918EXPORT_SYMBOL(current_kernel_time);
john stultzda15cfd2009-08-19 19:13:34 -0700919
920struct timespec get_monotonic_coarse(void)
921{
922 struct timespec now, mono;
923 unsigned long seq;
924
925 do {
926 seq = read_seqbegin(&xtime_lock);
Linus Torvalds83f57a12009-12-22 14:10:37 -0800927
John Stultz6a867a32010-04-06 14:30:51 -0700928 now = xtime;
john stultzda15cfd2009-08-19 19:13:34 -0700929 mono = wall_to_monotonic;
930 } while (read_seqretry(&xtime_lock, seq));
931
932 set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
933 now.tv_nsec + mono.tv_nsec);
934 return now;
935}