]> git.ipfire.org Git - thirdparty/linux.git/blame - kernel/time/timekeeping.c
time: Catch invalid timespec sleep values in __timekeeping_inject_sleeptime
[thirdparty/linux.git] / kernel / time / timekeeping.c
CommitLineData
8524070b
JS
1/*
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>
d43c36dc 16#include <linux/sched.h>
e1a85b2c 17#include <linux/syscore_ops.h>
8524070b
JS
18#include <linux/clocksource.h>
19#include <linux/jiffies.h>
20#include <linux/time.h>
21#include <linux/tick.h>
75c5158f 22#include <linux/stop_machine.h>
8524070b 23
155ec602
MS
24/* Structure holding internal timekeeping values. */
25struct timekeeper {
26 /* Current clocksource used for timekeeping. */
27 struct clocksource *clock;
23ce7211
MS
28 /* The shift value of the current clocksource. */
29 int shift;
155ec602
MS
30
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;
a386b5af
KP
35 /* shifted nano seconds left over when rounding cycle_interval */
36 s64 xtime_remainder;
155ec602
MS
37 /* Raw nano seconds accumulated per NTP interval. */
38 u32 raw_interval;
39
40 /* Clock shifted nano seconds remainder not stored in xtime.tv_nsec. */
41 u64 xtime_nsec;
42 /* Difference between accumulated time and NTP time in ntp
43 * shifted nano seconds. */
44 s64 ntp_error;
23ce7211
MS
45 /* Shift conversion between clock shifted nano seconds and
46 * ntp shifted nano seconds. */
47 int ntp_error_shift;
0a544198
MS
48 /* NTP adjusted clock multiplier */
49 u32 mult;
155ec602
MS
50};
51
afa14e7c 52static struct timekeeper timekeeper;
155ec602
MS
53
54/**
55 * timekeeper_setup_internals - Set up internals to use clocksource clock.
56 *
57 * @clock: Pointer to clocksource.
58 *
59 * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
60 * pair and interval request.
61 *
62 * Unless you're the timekeeping code, you should not be using this!
63 */
64static void timekeeper_setup_internals(struct clocksource *clock)
65{
66 cycle_t interval;
a386b5af 67 u64 tmp, ntpinterval;
155ec602
MS
68
69 timekeeper.clock = clock;
70 clock->cycle_last = clock->read(clock);
71
72 /* Do the ns -> cycle conversion first, using original mult */
73 tmp = NTP_INTERVAL_LENGTH;
74 tmp <<= clock->shift;
a386b5af 75 ntpinterval = tmp;
0a544198
MS
76 tmp += clock->mult/2;
77 do_div(tmp, clock->mult);
155ec602
MS
78 if (tmp == 0)
79 tmp = 1;
80
81 interval = (cycle_t) tmp;
82 timekeeper.cycle_interval = interval;
83
84 /* Go back from cycles -> shifted ns */
85 timekeeper.xtime_interval = (u64) interval * clock->mult;
a386b5af 86 timekeeper.xtime_remainder = ntpinterval - timekeeper.xtime_interval;
155ec602 87 timekeeper.raw_interval =
0a544198 88 ((u64) interval * clock->mult) >> clock->shift;
155ec602
MS
89
90 timekeeper.xtime_nsec = 0;
23ce7211 91 timekeeper.shift = clock->shift;
155ec602
MS
92
93 timekeeper.ntp_error = 0;
23ce7211 94 timekeeper.ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
0a544198
MS
95
96 /*
97 * The timekeeper keeps its own mult values for the currently
98 * active clocksource. These value will be adjusted via NTP
99 * to counteract clock drifting.
100 */
101 timekeeper.mult = clock->mult;
155ec602 102}
8524070b 103
2ba2a305
MS
104/* Timekeeper helper functions. */
105static inline s64 timekeeping_get_ns(void)
106{
107 cycle_t cycle_now, cycle_delta;
108 struct clocksource *clock;
109
110 /* read clocksource: */
111 clock = timekeeper.clock;
112 cycle_now = clock->read(clock);
113
114 /* calculate the delta since the last update_wall_time: */
115 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
116
117 /* return delta convert to nanoseconds using ntp adjusted mult. */
118 return clocksource_cyc2ns(cycle_delta, timekeeper.mult,
119 timekeeper.shift);
120}
121
122static inline s64 timekeeping_get_ns_raw(void)
123{
124 cycle_t cycle_now, cycle_delta;
125 struct clocksource *clock;
126
127 /* read clocksource: */
128 clock = timekeeper.clock;
129 cycle_now = clock->read(clock);
130
131 /* calculate the delta since the last update_wall_time: */
132 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
133
134 /* return delta convert to nanoseconds using ntp adjusted mult. */
135 return clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
136}
137
8524070b
JS
138/*
139 * This read-write spinlock protects us from races in SMP while
dce48a84 140 * playing with xtime.
8524070b 141 */
ba2a631b 142__cacheline_aligned_in_smp DEFINE_SEQLOCK(xtime_lock);
8524070b
JS
143
144
145/*
146 * The current time
147 * wall_to_monotonic is what we need to add to xtime (or xtime corrected
148 * for sub jiffie times) to get to monotonic time. Monotonic is pegged
149 * at zero at system boot time, so wall_to_monotonic will be negative,
150 * however, we will ALWAYS keep the tv_nsec part positive so we can use
151 * the usual normalization.
7c3f1a57
TJ
152 *
153 * wall_to_monotonic is moved after resume from suspend for the monotonic
154 * time not to jump. We need to add total_sleep_time to wall_to_monotonic
155 * to get the real boot based time offset.
156 *
157 * - wall_to_monotonic is no longer the boot time, getboottime must be
158 * used instead.
8524070b 159 */
0fb86b06
JS
160static struct timespec xtime __attribute__ ((aligned (16)));
161static struct timespec wall_to_monotonic __attribute__ ((aligned (16)));
d4f587c6 162static struct timespec total_sleep_time;
8524070b 163
155ec602
MS
164/*
165 * The raw monotonic time for the CLOCK_MONOTONIC_RAW posix clock.
166 */
afa14e7c 167static struct timespec raw_time;
155ec602 168
1c5745aa
TG
169/* flag for if timekeeping is suspended */
170int __read_mostly timekeeping_suspended;
171
31089c13
JS
172/* must hold xtime_lock */
173void timekeeping_leap_insert(int leapsecond)
174{
175 xtime.tv_sec += leapsecond;
176 wall_to_monotonic.tv_sec -= leapsecond;
7615856e
JS
177 update_vsyscall(&xtime, &wall_to_monotonic, timekeeper.clock,
178 timekeeper.mult);
31089c13 179}
8524070b 180
8524070b 181/**
155ec602 182 * timekeeping_forward_now - update clock to the current time
8524070b 183 *
9a055117
RZ
184 * Forward the current clock to update its state since the last call to
185 * update_wall_time(). This is useful before significant clock changes,
186 * as it avoids having to deal with this time offset explicitly.
8524070b 187 */
155ec602 188static void timekeeping_forward_now(void)
8524070b
JS
189{
190 cycle_t cycle_now, cycle_delta;
155ec602 191 struct clocksource *clock;
9a055117 192 s64 nsec;
8524070b 193
155ec602 194 clock = timekeeper.clock;
a0f7d48b 195 cycle_now = clock->read(clock);
8524070b 196 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
9a055117 197 clock->cycle_last = cycle_now;
8524070b 198
0a544198
MS
199 nsec = clocksource_cyc2ns(cycle_delta, timekeeper.mult,
200 timekeeper.shift);
7d27558c
JS
201
202 /* If arch requires, add in gettimeoffset() */
203 nsec += arch_gettimeoffset();
204
9a055117 205 timespec_add_ns(&xtime, nsec);
2d42244a 206
0a544198 207 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
155ec602 208 timespec_add_ns(&raw_time, nsec);
8524070b
JS
209}
210
211/**
efd9ac86 212 * getnstimeofday - Returns the time of day in a timespec
8524070b
JS
213 * @ts: pointer to the timespec to be set
214 *
efd9ac86 215 * Returns the time of day in a timespec.
8524070b 216 */
efd9ac86 217void getnstimeofday(struct timespec *ts)
8524070b
JS
218{
219 unsigned long seq;
220 s64 nsecs;
221
1c5745aa
TG
222 WARN_ON(timekeeping_suspended);
223
8524070b
JS
224 do {
225 seq = read_seqbegin(&xtime_lock);
226
227 *ts = xtime;
2ba2a305 228 nsecs = timekeeping_get_ns();
8524070b 229
7d27558c
JS
230 /* If arch requires, add in gettimeoffset() */
231 nsecs += arch_gettimeoffset();
232
8524070b
JS
233 } while (read_seqretry(&xtime_lock, seq));
234
235 timespec_add_ns(ts, nsecs);
236}
237
8524070b
JS
238EXPORT_SYMBOL(getnstimeofday);
239
951ed4d3
MS
240ktime_t ktime_get(void)
241{
951ed4d3
MS
242 unsigned int seq;
243 s64 secs, nsecs;
244
245 WARN_ON(timekeeping_suspended);
246
247 do {
248 seq = read_seqbegin(&xtime_lock);
249 secs = xtime.tv_sec + wall_to_monotonic.tv_sec;
250 nsecs = xtime.tv_nsec + wall_to_monotonic.tv_nsec;
2ba2a305 251 nsecs += timekeeping_get_ns();
951ed4d3
MS
252
253 } while (read_seqretry(&xtime_lock, seq));
254 /*
255 * Use ktime_set/ktime_add_ns to create a proper ktime on
256 * 32-bit architectures without CONFIG_KTIME_SCALAR.
257 */
258 return ktime_add_ns(ktime_set(secs, 0), nsecs);
259}
260EXPORT_SYMBOL_GPL(ktime_get);
261
262/**
263 * ktime_get_ts - get the monotonic clock in timespec format
264 * @ts: pointer to timespec variable
265 *
266 * The function calculates the monotonic clock from the realtime
267 * clock and the wall_to_monotonic offset and stores the result
268 * in normalized timespec format in the variable pointed to by @ts.
269 */
270void ktime_get_ts(struct timespec *ts)
271{
951ed4d3
MS
272 struct timespec tomono;
273 unsigned int seq;
274 s64 nsecs;
275
276 WARN_ON(timekeeping_suspended);
277
278 do {
279 seq = read_seqbegin(&xtime_lock);
280 *ts = xtime;
281 tomono = wall_to_monotonic;
2ba2a305 282 nsecs = timekeeping_get_ns();
951ed4d3
MS
283
284 } while (read_seqretry(&xtime_lock, seq));
285
286 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
287 ts->tv_nsec + tomono.tv_nsec + nsecs);
288}
289EXPORT_SYMBOL_GPL(ktime_get_ts);
290
e2c18e49
AG
291#ifdef CONFIG_NTP_PPS
292
293/**
294 * getnstime_raw_and_real - get day and raw monotonic time in timespec format
295 * @ts_raw: pointer to the timespec to be set to raw monotonic time
296 * @ts_real: pointer to the timespec to be set to the time of day
297 *
298 * This function reads both the time of day and raw monotonic time at the
299 * same time atomically and stores the resulting timestamps in timespec
300 * format.
301 */
302void getnstime_raw_and_real(struct timespec *ts_raw, struct timespec *ts_real)
303{
304 unsigned long seq;
305 s64 nsecs_raw, nsecs_real;
306
307 WARN_ON_ONCE(timekeeping_suspended);
308
309 do {
310 u32 arch_offset;
311
312 seq = read_seqbegin(&xtime_lock);
313
314 *ts_raw = raw_time;
315 *ts_real = xtime;
316
317 nsecs_raw = timekeeping_get_ns_raw();
318 nsecs_real = timekeeping_get_ns();
319
320 /* If arch requires, add in gettimeoffset() */
321 arch_offset = arch_gettimeoffset();
322 nsecs_raw += arch_offset;
323 nsecs_real += arch_offset;
324
325 } while (read_seqretry(&xtime_lock, seq));
326
327 timespec_add_ns(ts_raw, nsecs_raw);
328 timespec_add_ns(ts_real, nsecs_real);
329}
330EXPORT_SYMBOL(getnstime_raw_and_real);
331
332#endif /* CONFIG_NTP_PPS */
333
8524070b
JS
334/**
335 * do_gettimeofday - Returns the time of day in a timeval
336 * @tv: pointer to the timeval to be set
337 *
efd9ac86 338 * NOTE: Users should be converted to using getnstimeofday()
8524070b
JS
339 */
340void do_gettimeofday(struct timeval *tv)
341{
342 struct timespec now;
343
efd9ac86 344 getnstimeofday(&now);
8524070b
JS
345 tv->tv_sec = now.tv_sec;
346 tv->tv_usec = now.tv_nsec/1000;
347}
348
349EXPORT_SYMBOL(do_gettimeofday);
350/**
351 * do_settimeofday - Sets the time of day
352 * @tv: pointer to the timespec variable containing the new time
353 *
354 * Sets the time of day to the new time and update NTP and notify hrtimers
355 */
1e6d7679 356int do_settimeofday(const struct timespec *tv)
8524070b 357{
9a055117 358 struct timespec ts_delta;
8524070b 359 unsigned long flags;
8524070b
JS
360
361 if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
362 return -EINVAL;
363
364 write_seqlock_irqsave(&xtime_lock, flags);
365
155ec602 366 timekeeping_forward_now();
9a055117
RZ
367
368 ts_delta.tv_sec = tv->tv_sec - xtime.tv_sec;
369 ts_delta.tv_nsec = tv->tv_nsec - xtime.tv_nsec;
370 wall_to_monotonic = timespec_sub(wall_to_monotonic, ts_delta);
8524070b 371
9a055117 372 xtime = *tv;
8524070b 373
155ec602 374 timekeeper.ntp_error = 0;
8524070b
JS
375 ntp_clear();
376
7615856e
JS
377 update_vsyscall(&xtime, &wall_to_monotonic, timekeeper.clock,
378 timekeeper.mult);
8524070b
JS
379
380 write_sequnlock_irqrestore(&xtime_lock, flags);
381
382 /* signal hrtimers about time change */
383 clock_was_set();
384
385 return 0;
386}
387
388EXPORT_SYMBOL(do_settimeofday);
389
c528f7c6
JS
390
391/**
392 * timekeeping_inject_offset - Adds or subtracts from the current time.
393 * @tv: pointer to the timespec variable containing the offset
394 *
395 * Adds or subtracts an offset value from the current time.
396 */
397int timekeeping_inject_offset(struct timespec *ts)
398{
399 unsigned long flags;
400
401 if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
402 return -EINVAL;
403
404 write_seqlock_irqsave(&xtime_lock, flags);
405
406 timekeeping_forward_now();
407
408 xtime = timespec_add(xtime, *ts);
409 wall_to_monotonic = timespec_sub(wall_to_monotonic, *ts);
410
411 timekeeper.ntp_error = 0;
412 ntp_clear();
413
414 update_vsyscall(&xtime, &wall_to_monotonic, timekeeper.clock,
415 timekeeper.mult);
416
417 write_sequnlock_irqrestore(&xtime_lock, flags);
418
419 /* signal hrtimers about time change */
420 clock_was_set();
421
422 return 0;
423}
424EXPORT_SYMBOL(timekeeping_inject_offset);
425
8524070b
JS
426/**
427 * change_clocksource - Swaps clocksources if a new one is available
428 *
429 * Accumulates current time interval and initializes new clocksource
430 */
75c5158f 431static int change_clocksource(void *data)
8524070b 432{
4614e6ad 433 struct clocksource *new, *old;
8524070b 434
75c5158f 435 new = (struct clocksource *) data;
8524070b 436
155ec602 437 timekeeping_forward_now();
75c5158f
MS
438 if (!new->enable || new->enable(new) == 0) {
439 old = timekeeper.clock;
440 timekeeper_setup_internals(new);
441 if (old->disable)
442 old->disable(old);
443 }
444 return 0;
445}
8524070b 446
75c5158f
MS
447/**
448 * timekeeping_notify - Install a new clock source
449 * @clock: pointer to the clock source
450 *
451 * This function is called from clocksource.c after a new, better clock
452 * source has been registered. The caller holds the clocksource_mutex.
453 */
454void timekeeping_notify(struct clocksource *clock)
455{
456 if (timekeeper.clock == clock)
4614e6ad 457 return;
75c5158f 458 stop_machine(change_clocksource, clock, NULL);
8524070b 459 tick_clock_notify();
8524070b 460}
75c5158f 461
a40f262c
TG
462/**
463 * ktime_get_real - get the real (wall-) time in ktime_t format
464 *
465 * returns the time in ktime_t format
466 */
467ktime_t ktime_get_real(void)
468{
469 struct timespec now;
470
471 getnstimeofday(&now);
472
473 return timespec_to_ktime(now);
474}
475EXPORT_SYMBOL_GPL(ktime_get_real);
8524070b 476
2d42244a
JS
477/**
478 * getrawmonotonic - Returns the raw monotonic time in a timespec
479 * @ts: pointer to the timespec to be set
480 *
481 * Returns the raw monotonic time (completely un-modified by ntp)
482 */
483void getrawmonotonic(struct timespec *ts)
484{
485 unsigned long seq;
486 s64 nsecs;
2d42244a
JS
487
488 do {
489 seq = read_seqbegin(&xtime_lock);
2ba2a305 490 nsecs = timekeeping_get_ns_raw();
155ec602 491 *ts = raw_time;
2d42244a
JS
492
493 } while (read_seqretry(&xtime_lock, seq));
494
495 timespec_add_ns(ts, nsecs);
496}
497EXPORT_SYMBOL(getrawmonotonic);
498
499
8524070b 500/**
cf4fc6cb 501 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
8524070b 502 */
cf4fc6cb 503int timekeeping_valid_for_hres(void)
8524070b
JS
504{
505 unsigned long seq;
506 int ret;
507
508 do {
509 seq = read_seqbegin(&xtime_lock);
510
155ec602 511 ret = timekeeper.clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
8524070b
JS
512
513 } while (read_seqretry(&xtime_lock, seq));
514
515 return ret;
516}
517
98962465
JH
518/**
519 * timekeeping_max_deferment - Returns max time the clocksource can be deferred
520 *
521 * Caller must observe xtime_lock via read_seqbegin/read_seqretry to
522 * ensure that the clocksource does not change!
523 */
524u64 timekeeping_max_deferment(void)
525{
526 return timekeeper.clock->max_idle_ns;
527}
528
8524070b 529/**
d4f587c6 530 * read_persistent_clock - Return time from the persistent clock.
8524070b
JS
531 *
532 * Weak dummy function for arches that do not yet support it.
d4f587c6
MS
533 * Reads the time from the battery backed persistent clock.
534 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
8524070b
JS
535 *
536 * XXX - Do be sure to remove it once all arches implement it.
537 */
d4f587c6 538void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
8524070b 539{
d4f587c6
MS
540 ts->tv_sec = 0;
541 ts->tv_nsec = 0;
8524070b
JS
542}
543
23970e38
MS
544/**
545 * read_boot_clock - Return time of the system start.
546 *
547 * Weak dummy function for arches that do not yet support it.
548 * Function to read the exact time the system has been started.
549 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
550 *
551 * XXX - Do be sure to remove it once all arches implement it.
552 */
553void __attribute__((weak)) read_boot_clock(struct timespec *ts)
554{
555 ts->tv_sec = 0;
556 ts->tv_nsec = 0;
557}
558
8524070b
JS
559/*
560 * timekeeping_init - Initializes the clocksource and common timekeeping values
561 */
562void __init timekeeping_init(void)
563{
155ec602 564 struct clocksource *clock;
8524070b 565 unsigned long flags;
23970e38 566 struct timespec now, boot;
d4f587c6
MS
567
568 read_persistent_clock(&now);
23970e38 569 read_boot_clock(&boot);
8524070b
JS
570
571 write_seqlock_irqsave(&xtime_lock, flags);
572
7dffa3c6 573 ntp_init();
8524070b 574
f1b82746 575 clock = clocksource_default_clock();
a0f7d48b
MS
576 if (clock->enable)
577 clock->enable(clock);
155ec602 578 timekeeper_setup_internals(clock);
8524070b 579
d4f587c6
MS
580 xtime.tv_sec = now.tv_sec;
581 xtime.tv_nsec = now.tv_nsec;
155ec602
MS
582 raw_time.tv_sec = 0;
583 raw_time.tv_nsec = 0;
23970e38
MS
584 if (boot.tv_sec == 0 && boot.tv_nsec == 0) {
585 boot.tv_sec = xtime.tv_sec;
586 boot.tv_nsec = xtime.tv_nsec;
587 }
8524070b 588 set_normalized_timespec(&wall_to_monotonic,
23970e38 589 -boot.tv_sec, -boot.tv_nsec);
d4f587c6
MS
590 total_sleep_time.tv_sec = 0;
591 total_sleep_time.tv_nsec = 0;
8524070b
JS
592 write_sequnlock_irqrestore(&xtime_lock, flags);
593}
594
8524070b 595/* time in seconds when suspend began */
d4f587c6 596static struct timespec timekeeping_suspend_time;
8524070b 597
304529b1
JS
598/**
599 * __timekeeping_inject_sleeptime - Internal function to add sleep interval
600 * @delta: pointer to a timespec delta value
601 *
602 * Takes a timespec offset measuring a suspend interval and properly
603 * adds the sleep offset to the timekeeping variables.
604 */
605static void __timekeeping_inject_sleeptime(struct timespec *delta)
606{
cb5de2f8
JS
607 if (!timespec_valid(delta)) {
608 printk(KERN_WARN "__timekeeping_inject_sleeptime: Invalid "
609 "sleep delta value!\n");
610 return;
611 }
612
304529b1
JS
613 xtime = timespec_add(xtime, *delta);
614 wall_to_monotonic = timespec_sub(wall_to_monotonic, *delta);
615 total_sleep_time = timespec_add(total_sleep_time, *delta);
616}
617
618
619/**
620 * timekeeping_inject_sleeptime - Adds suspend interval to timeekeeping values
621 * @delta: pointer to a timespec delta value
622 *
623 * This hook is for architectures that cannot support read_persistent_clock
624 * because their RTC/persistent clock is only accessible when irqs are enabled.
625 *
626 * This function should only be called by rtc_resume(), and allows
627 * a suspend offset to be injected into the timekeeping values.
628 */
629void timekeeping_inject_sleeptime(struct timespec *delta)
630{
631 unsigned long flags;
632 struct timespec ts;
633
634 /* Make sure we don't set the clock twice */
635 read_persistent_clock(&ts);
636 if (!(ts.tv_sec == 0 && ts.tv_nsec == 0))
637 return;
638
639 write_seqlock_irqsave(&xtime_lock, flags);
640 timekeeping_forward_now();
641
642 __timekeeping_inject_sleeptime(delta);
643
644 timekeeper.ntp_error = 0;
645 ntp_clear();
646 update_vsyscall(&xtime, &wall_to_monotonic, timekeeper.clock,
647 timekeeper.mult);
648
649 write_sequnlock_irqrestore(&xtime_lock, flags);
650
651 /* signal hrtimers about time change */
652 clock_was_set();
653}
654
655
8524070b
JS
656/**
657 * timekeeping_resume - Resumes the generic timekeeping subsystem.
8524070b
JS
658 *
659 * This is for the generic clocksource timekeeping.
660 * xtime/wall_to_monotonic/jiffies/etc are
661 * still managed by arch specific suspend/resume code.
662 */
e1a85b2c 663static void timekeeping_resume(void)
8524070b
JS
664{
665 unsigned long flags;
d4f587c6
MS
666 struct timespec ts;
667
668 read_persistent_clock(&ts);
8524070b 669
d10ff3fb
TG
670 clocksource_resume();
671
8524070b
JS
672 write_seqlock_irqsave(&xtime_lock, flags);
673
d4f587c6
MS
674 if (timespec_compare(&ts, &timekeeping_suspend_time) > 0) {
675 ts = timespec_sub(ts, timekeeping_suspend_time);
304529b1 676 __timekeeping_inject_sleeptime(&ts);
8524070b
JS
677 }
678 /* re-base the last cycle value */
155ec602
MS
679 timekeeper.clock->cycle_last = timekeeper.clock->read(timekeeper.clock);
680 timekeeper.ntp_error = 0;
8524070b
JS
681 timekeeping_suspended = 0;
682 write_sequnlock_irqrestore(&xtime_lock, flags);
683
684 touch_softlockup_watchdog();
685
686 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
687
688 /* Resume hrtimers */
b12a03ce 689 hrtimers_resume();
8524070b
JS
690}
691
e1a85b2c 692static int timekeeping_suspend(void)
8524070b
JS
693{
694 unsigned long flags;
695
d4f587c6 696 read_persistent_clock(&timekeeping_suspend_time);
3be90950 697
8524070b 698 write_seqlock_irqsave(&xtime_lock, flags);
155ec602 699 timekeeping_forward_now();
8524070b 700 timekeeping_suspended = 1;
8524070b
JS
701 write_sequnlock_irqrestore(&xtime_lock, flags);
702
703 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
c54a42b1 704 clocksource_suspend();
8524070b
JS
705
706 return 0;
707}
708
709/* sysfs resume/suspend bits for timekeeping */
e1a85b2c 710static struct syscore_ops timekeeping_syscore_ops = {
8524070b
JS
711 .resume = timekeeping_resume,
712 .suspend = timekeeping_suspend,
8524070b
JS
713};
714
e1a85b2c 715static int __init timekeeping_init_ops(void)
8524070b 716{
e1a85b2c
RW
717 register_syscore_ops(&timekeeping_syscore_ops);
718 return 0;
8524070b
JS
719}
720
e1a85b2c 721device_initcall(timekeeping_init_ops);
8524070b
JS
722
723/*
724 * If the error is already larger, we look ahead even further
725 * to compensate for late or lost adjustments.
726 */
155ec602 727static __always_inline int timekeeping_bigadjust(s64 error, s64 *interval,
8524070b
JS
728 s64 *offset)
729{
730 s64 tick_error, i;
731 u32 look_ahead, adj;
732 s32 error2, mult;
733
734 /*
735 * Use the current error value to determine how much to look ahead.
736 * The larger the error the slower we adjust for it to avoid problems
737 * with losing too many ticks, otherwise we would overadjust and
738 * produce an even larger error. The smaller the adjustment the
739 * faster we try to adjust for it, as lost ticks can do less harm
3eb05676 740 * here. This is tuned so that an error of about 1 msec is adjusted
8524070b
JS
741 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
742 */
155ec602 743 error2 = timekeeper.ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
8524070b
JS
744 error2 = abs(error2);
745 for (look_ahead = 0; error2 > 0; look_ahead++)
746 error2 >>= 2;
747
748 /*
749 * Now calculate the error in (1 << look_ahead) ticks, but first
750 * remove the single look ahead already included in the error.
751 */
23ce7211 752 tick_error = tick_length >> (timekeeper.ntp_error_shift + 1);
155ec602 753 tick_error -= timekeeper.xtime_interval >> 1;
8524070b
JS
754 error = ((error - tick_error) >> look_ahead) + tick_error;
755
756 /* Finally calculate the adjustment shift value. */
757 i = *interval;
758 mult = 1;
759 if (error < 0) {
760 error = -error;
761 *interval = -*interval;
762 *offset = -*offset;
763 mult = -1;
764 }
765 for (adj = 0; error > i; adj++)
766 error >>= 1;
767
768 *interval <<= adj;
769 *offset <<= adj;
770 return mult << adj;
771}
772
773/*
774 * Adjust the multiplier to reduce the error value,
775 * this is optimized for the most common adjustments of -1,0,1,
776 * for other values we can do a bit more work.
777 */
155ec602 778static void timekeeping_adjust(s64 offset)
8524070b 779{
155ec602 780 s64 error, interval = timekeeper.cycle_interval;
8524070b
JS
781 int adj;
782
23ce7211 783 error = timekeeper.ntp_error >> (timekeeper.ntp_error_shift - 1);
8524070b
JS
784 if (error > interval) {
785 error >>= 2;
786 if (likely(error <= interval))
787 adj = 1;
788 else
155ec602 789 adj = timekeeping_bigadjust(error, &interval, &offset);
8524070b
JS
790 } else if (error < -interval) {
791 error >>= 2;
792 if (likely(error >= -interval)) {
793 adj = -1;
794 interval = -interval;
795 offset = -offset;
796 } else
155ec602 797 adj = timekeeping_bigadjust(error, &interval, &offset);
8524070b
JS
798 } else
799 return;
800
0a544198 801 timekeeper.mult += adj;
155ec602
MS
802 timekeeper.xtime_interval += interval;
803 timekeeper.xtime_nsec -= offset;
804 timekeeper.ntp_error -= (interval - offset) <<
23ce7211 805 timekeeper.ntp_error_shift;
8524070b
JS
806}
807
83f57a11 808
a092ff0f
JS
809/**
810 * logarithmic_accumulation - shifted accumulation of cycles
811 *
812 * This functions accumulates a shifted interval of cycles into
813 * into a shifted interval nanoseconds. Allows for O(log) accumulation
814 * loop.
815 *
816 * Returns the unconsumed cycles.
817 */
818static cycle_t logarithmic_accumulation(cycle_t offset, int shift)
819{
820 u64 nsecps = (u64)NSEC_PER_SEC << timekeeper.shift;
deda2e81 821 u64 raw_nsecs;
a092ff0f
JS
822
823 /* If the offset is smaller then a shifted interval, do nothing */
824 if (offset < timekeeper.cycle_interval<<shift)
825 return offset;
826
827 /* Accumulate one shifted interval */
828 offset -= timekeeper.cycle_interval << shift;
829 timekeeper.clock->cycle_last += timekeeper.cycle_interval << shift;
830
831 timekeeper.xtime_nsec += timekeeper.xtime_interval << shift;
832 while (timekeeper.xtime_nsec >= nsecps) {
833 timekeeper.xtime_nsec -= nsecps;
834 xtime.tv_sec++;
835 second_overflow();
836 }
837
deda2e81
JW
838 /* Accumulate raw time */
839 raw_nsecs = timekeeper.raw_interval << shift;
840 raw_nsecs += raw_time.tv_nsec;
c7dcf87a
JS
841 if (raw_nsecs >= NSEC_PER_SEC) {
842 u64 raw_secs = raw_nsecs;
843 raw_nsecs = do_div(raw_secs, NSEC_PER_SEC);
844 raw_time.tv_sec += raw_secs;
a092ff0f 845 }
deda2e81 846 raw_time.tv_nsec = raw_nsecs;
a092ff0f
JS
847
848 /* Accumulate error between NTP and clock interval */
849 timekeeper.ntp_error += tick_length << shift;
a386b5af
KP
850 timekeeper.ntp_error -=
851 (timekeeper.xtime_interval + timekeeper.xtime_remainder) <<
a092ff0f
JS
852 (timekeeper.ntp_error_shift + shift);
853
854 return offset;
855}
856
83f57a11 857
8524070b
JS
858/**
859 * update_wall_time - Uses the current clocksource to increment the wall time
860 *
861 * Called from the timer interrupt, must hold a write on xtime_lock.
862 */
871cf1e5 863static void update_wall_time(void)
8524070b 864{
155ec602 865 struct clocksource *clock;
8524070b 866 cycle_t offset;
a092ff0f 867 int shift = 0, maxshift;
8524070b
JS
868
869 /* Make sure we're fully resumed: */
870 if (unlikely(timekeeping_suspended))
871 return;
872
155ec602 873 clock = timekeeper.clock;
592913ec
JS
874
875#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
155ec602 876 offset = timekeeper.cycle_interval;
592913ec
JS
877#else
878 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
8524070b 879#endif
23ce7211 880 timekeeper.xtime_nsec = (s64)xtime.tv_nsec << timekeeper.shift;
8524070b 881
a092ff0f
JS
882 /*
883 * With NO_HZ we may have to accumulate many cycle_intervals
884 * (think "ticks") worth of time at once. To do this efficiently,
885 * we calculate the largest doubling multiple of cycle_intervals
886 * that is smaller then the offset. We then accumulate that
887 * chunk in one go, and then try to consume the next smaller
888 * doubled multiple.
8524070b 889 */
a092ff0f
JS
890 shift = ilog2(offset) - ilog2(timekeeper.cycle_interval);
891 shift = max(0, shift);
892 /* Bound shift to one less then what overflows tick_length */
893 maxshift = (8*sizeof(tick_length) - (ilog2(tick_length)+1)) - 1;
894 shift = min(shift, maxshift);
155ec602 895 while (offset >= timekeeper.cycle_interval) {
a092ff0f 896 offset = logarithmic_accumulation(offset, shift);
830ec045
JS
897 if(offset < timekeeper.cycle_interval<<shift)
898 shift--;
8524070b
JS
899 }
900
901 /* correct the clock when NTP error is too big */
155ec602 902 timekeeping_adjust(offset);
8524070b 903
6c9bacb4
JS
904 /*
905 * Since in the loop above, we accumulate any amount of time
906 * in xtime_nsec over a second into xtime.tv_sec, its possible for
907 * xtime_nsec to be fairly small after the loop. Further, if we're
155ec602 908 * slightly speeding the clocksource up in timekeeping_adjust(),
6c9bacb4
JS
909 * its possible the required corrective factor to xtime_nsec could
910 * cause it to underflow.
911 *
912 * Now, we cannot simply roll the accumulated second back, since
913 * the NTP subsystem has been notified via second_overflow. So
914 * instead we push xtime_nsec forward by the amount we underflowed,
915 * and add that amount into the error.
916 *
917 * We'll correct this error next time through this function, when
918 * xtime_nsec is not as small.
919 */
155ec602
MS
920 if (unlikely((s64)timekeeper.xtime_nsec < 0)) {
921 s64 neg = -(s64)timekeeper.xtime_nsec;
922 timekeeper.xtime_nsec = 0;
23ce7211 923 timekeeper.ntp_error += neg << timekeeper.ntp_error_shift;
6c9bacb4
JS
924 }
925
6a867a39
JS
926
927 /*
928 * Store full nanoseconds into xtime after rounding it up and
5cd1c9c5
RZ
929 * add the remainder to the error difference.
930 */
23ce7211
MS
931 xtime.tv_nsec = ((s64) timekeeper.xtime_nsec >> timekeeper.shift) + 1;
932 timekeeper.xtime_nsec -= (s64) xtime.tv_nsec << timekeeper.shift;
933 timekeeper.ntp_error += timekeeper.xtime_nsec <<
934 timekeeper.ntp_error_shift;
8524070b 935
6a867a39
JS
936 /*
937 * Finally, make sure that after the rounding
938 * xtime.tv_nsec isn't larger then NSEC_PER_SEC
939 */
940 if (unlikely(xtime.tv_nsec >= NSEC_PER_SEC)) {
941 xtime.tv_nsec -= NSEC_PER_SEC;
942 xtime.tv_sec++;
943 second_overflow();
944 }
83f57a11 945
8524070b 946 /* check to see if there is a new clocksource to use */
7615856e
JS
947 update_vsyscall(&xtime, &wall_to_monotonic, timekeeper.clock,
948 timekeeper.mult);
8524070b 949}
7c3f1a57
TJ
950
951/**
952 * getboottime - Return the real time of system boot.
953 * @ts: pointer to the timespec to be set
954 *
abb3a4ea 955 * Returns the wall-time of boot in a timespec.
7c3f1a57
TJ
956 *
957 * This is based on the wall_to_monotonic offset and the total suspend
958 * time. Calls to settimeofday will affect the value returned (which
959 * basically means that however wrong your real time clock is at boot time,
960 * you get the right time here).
961 */
962void getboottime(struct timespec *ts)
963{
36d47481
HS
964 struct timespec boottime = {
965 .tv_sec = wall_to_monotonic.tv_sec + total_sleep_time.tv_sec,
966 .tv_nsec = wall_to_monotonic.tv_nsec + total_sleep_time.tv_nsec
967 };
d4f587c6 968
d4f587c6 969 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
7c3f1a57 970}
c93d89f3 971EXPORT_SYMBOL_GPL(getboottime);
7c3f1a57 972
abb3a4ea
JS
973
974/**
975 * get_monotonic_boottime - Returns monotonic time since boot
976 * @ts: pointer to the timespec to be set
977 *
978 * Returns the monotonic time since boot in a timespec.
979 *
980 * This is similar to CLOCK_MONTONIC/ktime_get_ts, but also
981 * includes the time spent in suspend.
982 */
983void get_monotonic_boottime(struct timespec *ts)
984{
985 struct timespec tomono, sleep;
986 unsigned int seq;
987 s64 nsecs;
988
989 WARN_ON(timekeeping_suspended);
990
991 do {
992 seq = read_seqbegin(&xtime_lock);
993 *ts = xtime;
994 tomono = wall_to_monotonic;
995 sleep = total_sleep_time;
996 nsecs = timekeeping_get_ns();
997
998 } while (read_seqretry(&xtime_lock, seq));
999
1000 set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec + sleep.tv_sec,
1001 ts->tv_nsec + tomono.tv_nsec + sleep.tv_nsec + nsecs);
1002}
1003EXPORT_SYMBOL_GPL(get_monotonic_boottime);
1004
1005/**
1006 * ktime_get_boottime - Returns monotonic time since boot in a ktime
1007 *
1008 * Returns the monotonic time since boot in a ktime
1009 *
1010 * This is similar to CLOCK_MONTONIC/ktime_get, but also
1011 * includes the time spent in suspend.
1012 */
1013ktime_t ktime_get_boottime(void)
1014{
1015 struct timespec ts;
1016
1017 get_monotonic_boottime(&ts);
1018 return timespec_to_ktime(ts);
1019}
1020EXPORT_SYMBOL_GPL(ktime_get_boottime);
1021
7c3f1a57
TJ
1022/**
1023 * monotonic_to_bootbased - Convert the monotonic time to boot based.
1024 * @ts: pointer to the timespec to be converted
1025 */
1026void monotonic_to_bootbased(struct timespec *ts)
1027{
ce3bf7ab 1028 *ts = timespec_add(*ts, total_sleep_time);
7c3f1a57 1029}
c93d89f3 1030EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
2c6b47de 1031
17c38b74
JS
1032unsigned long get_seconds(void)
1033{
6a867a39 1034 return xtime.tv_sec;
17c38b74
JS
1035}
1036EXPORT_SYMBOL(get_seconds);
1037
da15cfda
JS
1038struct timespec __current_kernel_time(void)
1039{
6a867a39 1040 return xtime;
da15cfda 1041}
17c38b74 1042
2c6b47de
JS
1043struct timespec current_kernel_time(void)
1044{
1045 struct timespec now;
1046 unsigned long seq;
1047
1048 do {
1049 seq = read_seqbegin(&xtime_lock);
83f57a11 1050
6a867a39 1051 now = xtime;
2c6b47de
JS
1052 } while (read_seqretry(&xtime_lock, seq));
1053
1054 return now;
1055}
2c6b47de 1056EXPORT_SYMBOL(current_kernel_time);
da15cfda
JS
1057
1058struct timespec get_monotonic_coarse(void)
1059{
1060 struct timespec now, mono;
1061 unsigned long seq;
1062
1063 do {
1064 seq = read_seqbegin(&xtime_lock);
83f57a11 1065
6a867a39 1066 now = xtime;
da15cfda
JS
1067 mono = wall_to_monotonic;
1068 } while (read_seqretry(&xtime_lock, seq));
1069
1070 set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
1071 now.tv_nsec + mono.tv_nsec);
1072 return now;
1073}
871cf1e5
TH
1074
1075/*
1076 * The 64-bit jiffies value is not atomic - you MUST NOT read it
1077 * without sampling the sequence number in xtime_lock.
1078 * jiffies is defined in the linker script...
1079 */
1080void do_timer(unsigned long ticks)
1081{
1082 jiffies_64 += ticks;
1083 update_wall_time();
1084 calc_global_load(ticks);
1085}
48cf76f7
TH
1086
1087/**
314ac371
JS
1088 * get_xtime_and_monotonic_and_sleep_offset() - get xtime, wall_to_monotonic,
1089 * and sleep offsets.
48cf76f7
TH
1090 * @xtim: pointer to timespec to be set with xtime
1091 * @wtom: pointer to timespec to be set with wall_to_monotonic
314ac371 1092 * @sleep: pointer to timespec to be set with time in suspend
48cf76f7 1093 */
314ac371
JS
1094void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
1095 struct timespec *wtom, struct timespec *sleep)
48cf76f7
TH
1096{
1097 unsigned long seq;
1098
1099 do {
1100 seq = read_seqbegin(&xtime_lock);
1101 *xtim = xtime;
1102 *wtom = wall_to_monotonic;
314ac371 1103 *sleep = total_sleep_time;
48cf76f7
TH
1104 } while (read_seqretry(&xtime_lock, seq));
1105}
f0af911a 1106
99ee5315
TG
1107/**
1108 * ktime_get_monotonic_offset() - get wall_to_monotonic in ktime_t format
1109 */
1110ktime_t ktime_get_monotonic_offset(void)
1111{
1112 unsigned long seq;
1113 struct timespec wtom;
1114
1115 do {
1116 seq = read_seqbegin(&xtime_lock);
1117 wtom = wall_to_monotonic;
1118 } while (read_seqretry(&xtime_lock, seq));
1119 return timespec_to_ktime(wtom);
1120}
1121
f0af911a
TH
1122/**
1123 * xtime_update() - advances the timekeeping infrastructure
1124 * @ticks: number of ticks, that have elapsed since the last call.
1125 *
1126 * Must be called with interrupts disabled.
1127 */
1128void xtime_update(unsigned long ticks)
1129{
1130 write_seqlock(&xtime_lock);
1131 do_timer(ticks);
1132 write_sequnlock(&xtime_lock);
1133}