]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - kernel/time/timekeeping.c
hrtimer: Fix ktime_add_ns() overflow on 32bit architectures
[mirror_ubuntu-bionic-kernel.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
d7b4202e 11#include <linux/timekeeper_internal.h>
8524070b
JS
12#include <linux/module.h>
13#include <linux/interrupt.h>
14#include <linux/percpu.h>
15#include <linux/init.h>
16#include <linux/mm.h>
d43c36dc 17#include <linux/sched.h>
e1a85b2c 18#include <linux/syscore_ops.h>
8524070b
JS
19#include <linux/clocksource.h>
20#include <linux/jiffies.h>
21#include <linux/time.h>
22#include <linux/tick.h>
75c5158f 23#include <linux/stop_machine.h>
e0b306fe 24#include <linux/pvclock_gtod.h>
8524070b 25
eb93e4d9 26#include "tick-internal.h"
aa6f9c59 27#include "ntp_internal.h"
155ec602 28
afa14e7c 29static struct timekeeper timekeeper;
9a7a71b1
TG
30static DEFINE_RAW_SPINLOCK(timekeeper_lock);
31static seqcount_t timekeeper_seq;
48cdc135 32static struct timekeeper shadow_timekeeper;
155ec602 33
8fcce546
JS
34/* flag for if timekeeping is suspended */
35int __read_mostly timekeeping_suspended;
36
31ade306
FT
37/* Flag for if there is a persistent clock on this platform */
38bool __read_mostly persistent_clock_exist = false;
39
1e75fa8b
JS
40static inline void tk_normalize_xtime(struct timekeeper *tk)
41{
42 while (tk->xtime_nsec >= ((u64)NSEC_PER_SEC << tk->shift)) {
43 tk->xtime_nsec -= (u64)NSEC_PER_SEC << tk->shift;
44 tk->xtime_sec++;
45 }
46}
47
1e75fa8b
JS
48static void tk_set_xtime(struct timekeeper *tk, const struct timespec *ts)
49{
50 tk->xtime_sec = ts->tv_sec;
b44d50dc 51 tk->xtime_nsec = (u64)ts->tv_nsec << tk->shift;
1e75fa8b
JS
52}
53
54static void tk_xtime_add(struct timekeeper *tk, const struct timespec *ts)
55{
56 tk->xtime_sec += ts->tv_sec;
b44d50dc 57 tk->xtime_nsec += (u64)ts->tv_nsec << tk->shift;
784ffcbb 58 tk_normalize_xtime(tk);
1e75fa8b 59}
8fcce546 60
6d0ef903
JS
61static void tk_set_wall_to_mono(struct timekeeper *tk, struct timespec wtm)
62{
63 struct timespec tmp;
64
65 /*
66 * Verify consistency of: offset_real = -wall_to_monotonic
67 * before modifying anything
68 */
69 set_normalized_timespec(&tmp, -tk->wall_to_monotonic.tv_sec,
70 -tk->wall_to_monotonic.tv_nsec);
71 WARN_ON_ONCE(tk->offs_real.tv64 != timespec_to_ktime(tmp).tv64);
72 tk->wall_to_monotonic = wtm;
73 set_normalized_timespec(&tmp, -wtm.tv_sec, -wtm.tv_nsec);
74 tk->offs_real = timespec_to_ktime(tmp);
90adda98 75 tk->offs_tai = ktime_sub(tk->offs_real, ktime_set(tk->tai_offset, 0));
6d0ef903
JS
76}
77
78static void tk_set_sleep_time(struct timekeeper *tk, struct timespec t)
79{
80 /* Verify consistency before modifying */
81 WARN_ON_ONCE(tk->offs_boot.tv64 != timespec_to_ktime(tk->total_sleep_time).tv64);
82
83 tk->total_sleep_time = t;
84 tk->offs_boot = timespec_to_ktime(t);
85}
86
155ec602
MS
87/**
88 * timekeeper_setup_internals - Set up internals to use clocksource clock.
89 *
90 * @clock: Pointer to clocksource.
91 *
92 * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
93 * pair and interval request.
94 *
95 * Unless you're the timekeeping code, you should not be using this!
96 */
f726a697 97static void tk_setup_internals(struct timekeeper *tk, struct clocksource *clock)
155ec602
MS
98{
99 cycle_t interval;
a386b5af 100 u64 tmp, ntpinterval;
1e75fa8b 101 struct clocksource *old_clock;
155ec602 102
f726a697
JS
103 old_clock = tk->clock;
104 tk->clock = clock;
14a3b6ab 105 tk->cycle_last = clock->cycle_last = clock->read(clock);
155ec602
MS
106
107 /* Do the ns -> cycle conversion first, using original mult */
108 tmp = NTP_INTERVAL_LENGTH;
109 tmp <<= clock->shift;
a386b5af 110 ntpinterval = tmp;
0a544198
MS
111 tmp += clock->mult/2;
112 do_div(tmp, clock->mult);
155ec602
MS
113 if (tmp == 0)
114 tmp = 1;
115
116 interval = (cycle_t) tmp;
f726a697 117 tk->cycle_interval = interval;
155ec602
MS
118
119 /* Go back from cycles -> shifted ns */
f726a697
JS
120 tk->xtime_interval = (u64) interval * clock->mult;
121 tk->xtime_remainder = ntpinterval - tk->xtime_interval;
122 tk->raw_interval =
0a544198 123 ((u64) interval * clock->mult) >> clock->shift;
155ec602 124
1e75fa8b
JS
125 /* if changing clocks, convert xtime_nsec shift units */
126 if (old_clock) {
127 int shift_change = clock->shift - old_clock->shift;
128 if (shift_change < 0)
f726a697 129 tk->xtime_nsec >>= -shift_change;
1e75fa8b 130 else
f726a697 131 tk->xtime_nsec <<= shift_change;
1e75fa8b 132 }
f726a697 133 tk->shift = clock->shift;
155ec602 134
f726a697
JS
135 tk->ntp_error = 0;
136 tk->ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
0a544198
MS
137
138 /*
139 * The timekeeper keeps its own mult values for the currently
140 * active clocksource. These value will be adjusted via NTP
141 * to counteract clock drifting.
142 */
f726a697 143 tk->mult = clock->mult;
155ec602 144}
8524070b 145
2ba2a305 146/* Timekeeper helper functions. */
7b1f6207
SW
147
148#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
149u32 (*arch_gettimeoffset)(void);
150
151u32 get_arch_timeoffset(void)
152{
153 if (likely(arch_gettimeoffset))
154 return arch_gettimeoffset();
155 return 0;
156}
157#else
158static inline u32 get_arch_timeoffset(void) { return 0; }
159#endif
160
f726a697 161static inline s64 timekeeping_get_ns(struct timekeeper *tk)
2ba2a305
MS
162{
163 cycle_t cycle_now, cycle_delta;
164 struct clocksource *clock;
1e75fa8b 165 s64 nsec;
2ba2a305
MS
166
167 /* read clocksource: */
f726a697 168 clock = tk->clock;
2ba2a305
MS
169 cycle_now = clock->read(clock);
170
171 /* calculate the delta since the last update_wall_time: */
172 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
173
f726a697
JS
174 nsec = cycle_delta * tk->mult + tk->xtime_nsec;
175 nsec >>= tk->shift;
f2a5a085 176
7b1f6207
SW
177 /* If arch requires, add in get_arch_timeoffset() */
178 return nsec + get_arch_timeoffset();
2ba2a305
MS
179}
180
f726a697 181static inline s64 timekeeping_get_ns_raw(struct timekeeper *tk)
2ba2a305
MS
182{
183 cycle_t cycle_now, cycle_delta;
184 struct clocksource *clock;
f2a5a085 185 s64 nsec;
2ba2a305
MS
186
187 /* read clocksource: */
f726a697 188 clock = tk->clock;
2ba2a305
MS
189 cycle_now = clock->read(clock);
190
191 /* calculate the delta since the last update_wall_time: */
192 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
193
f2a5a085
JS
194 /* convert delta to nanoseconds. */
195 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
196
7b1f6207
SW
197 /* If arch requires, add in get_arch_timeoffset() */
198 return nsec + get_arch_timeoffset();
2ba2a305
MS
199}
200
e0b306fe
MT
201static RAW_NOTIFIER_HEAD(pvclock_gtod_chain);
202
203static void update_pvclock_gtod(struct timekeeper *tk)
204{
205 raw_notifier_call_chain(&pvclock_gtod_chain, 0, tk);
206}
207
208/**
209 * pvclock_gtod_register_notifier - register a pvclock timedata update listener
e0b306fe
MT
210 */
211int pvclock_gtod_register_notifier(struct notifier_block *nb)
212{
213 struct timekeeper *tk = &timekeeper;
214 unsigned long flags;
215 int ret;
216
9a7a71b1 217 raw_spin_lock_irqsave(&timekeeper_lock, flags);
e0b306fe 218 ret = raw_notifier_chain_register(&pvclock_gtod_chain, nb);
e0b306fe 219 update_pvclock_gtod(tk);
9a7a71b1 220 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
e0b306fe
MT
221
222 return ret;
223}
224EXPORT_SYMBOL_GPL(pvclock_gtod_register_notifier);
225
226/**
227 * pvclock_gtod_unregister_notifier - unregister a pvclock
228 * timedata update listener
e0b306fe
MT
229 */
230int pvclock_gtod_unregister_notifier(struct notifier_block *nb)
231{
e0b306fe
MT
232 unsigned long flags;
233 int ret;
234
9a7a71b1 235 raw_spin_lock_irqsave(&timekeeper_lock, flags);
e0b306fe 236 ret = raw_notifier_chain_unregister(&pvclock_gtod_chain, nb);
9a7a71b1 237 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
e0b306fe
MT
238
239 return ret;
240}
241EXPORT_SYMBOL_GPL(pvclock_gtod_unregister_notifier);
242
9a7a71b1 243/* must hold timekeeper_lock */
48cdc135 244static void timekeeping_update(struct timekeeper *tk, bool clearntp, bool mirror)
cc06268c
TG
245{
246 if (clearntp) {
f726a697 247 tk->ntp_error = 0;
cc06268c
TG
248 ntp_clear();
249 }
576094b7 250 update_vsyscall(tk);
e0b306fe 251 update_pvclock_gtod(tk);
48cdc135
TG
252
253 if (mirror)
254 memcpy(&shadow_timekeeper, &timekeeper, sizeof(timekeeper));
cc06268c
TG
255}
256
8524070b 257/**
155ec602 258 * timekeeping_forward_now - update clock to the current time
8524070b 259 *
9a055117
RZ
260 * Forward the current clock to update its state since the last call to
261 * update_wall_time(). This is useful before significant clock changes,
262 * as it avoids having to deal with this time offset explicitly.
8524070b 263 */
f726a697 264static void timekeeping_forward_now(struct timekeeper *tk)
8524070b
JS
265{
266 cycle_t cycle_now, cycle_delta;
155ec602 267 struct clocksource *clock;
9a055117 268 s64 nsec;
8524070b 269
f726a697 270 clock = tk->clock;
a0f7d48b 271 cycle_now = clock->read(clock);
8524070b 272 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
14a3b6ab 273 tk->cycle_last = clock->cycle_last = cycle_now;
8524070b 274
f726a697 275 tk->xtime_nsec += cycle_delta * tk->mult;
7d27558c 276
7b1f6207
SW
277 /* If arch requires, add in get_arch_timeoffset() */
278 tk->xtime_nsec += (u64)get_arch_timeoffset() << tk->shift;
7d27558c 279
f726a697 280 tk_normalize_xtime(tk);
2d42244a 281
0a544198 282 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
f726a697 283 timespec_add_ns(&tk->raw_time, nsec);
8524070b
JS
284}
285
286/**
1e817fb6 287 * __getnstimeofday - Returns the time of day in a timespec.
8524070b
JS
288 * @ts: pointer to the timespec to be set
289 *
1e817fb6
KC
290 * Updates the time of day in the timespec.
291 * Returns 0 on success, or -ve when suspended (timespec will be undefined).
8524070b 292 */
1e817fb6 293int __getnstimeofday(struct timespec *ts)
8524070b 294{
4e250fdd 295 struct timekeeper *tk = &timekeeper;
8524070b 296 unsigned long seq;
1e75fa8b 297 s64 nsecs = 0;
8524070b
JS
298
299 do {
9a7a71b1 300 seq = read_seqcount_begin(&timekeeper_seq);
8524070b 301
4e250fdd 302 ts->tv_sec = tk->xtime_sec;
ec145bab 303 nsecs = timekeeping_get_ns(tk);
8524070b 304
9a7a71b1 305 } while (read_seqcount_retry(&timekeeper_seq, seq));
8524070b 306
ec145bab 307 ts->tv_nsec = 0;
8524070b 308 timespec_add_ns(ts, nsecs);
1e817fb6
KC
309
310 /*
311 * Do not bail out early, in case there were callers still using
312 * the value, even in the face of the WARN_ON.
313 */
314 if (unlikely(timekeeping_suspended))
315 return -EAGAIN;
316 return 0;
317}
318EXPORT_SYMBOL(__getnstimeofday);
319
320/**
321 * getnstimeofday - Returns the time of day in a timespec.
322 * @ts: pointer to the timespec to be set
323 *
324 * Returns the time of day in a timespec (WARN if suspended).
325 */
326void getnstimeofday(struct timespec *ts)
327{
328 WARN_ON(__getnstimeofday(ts));
8524070b 329}
8524070b
JS
330EXPORT_SYMBOL(getnstimeofday);
331
951ed4d3
MS
332ktime_t ktime_get(void)
333{
4e250fdd 334 struct timekeeper *tk = &timekeeper;
951ed4d3
MS
335 unsigned int seq;
336 s64 secs, nsecs;
337
338 WARN_ON(timekeeping_suspended);
339
340 do {
9a7a71b1 341 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd
JS
342 secs = tk->xtime_sec + tk->wall_to_monotonic.tv_sec;
343 nsecs = timekeeping_get_ns(tk) + tk->wall_to_monotonic.tv_nsec;
951ed4d3 344
9a7a71b1 345 } while (read_seqcount_retry(&timekeeper_seq, seq));
951ed4d3
MS
346 /*
347 * Use ktime_set/ktime_add_ns to create a proper ktime on
348 * 32-bit architectures without CONFIG_KTIME_SCALAR.
349 */
350 return ktime_add_ns(ktime_set(secs, 0), nsecs);
351}
352EXPORT_SYMBOL_GPL(ktime_get);
353
354/**
355 * ktime_get_ts - get the monotonic clock in timespec format
356 * @ts: pointer to timespec variable
357 *
358 * The function calculates the monotonic clock from the realtime
359 * clock and the wall_to_monotonic offset and stores the result
360 * in normalized timespec format in the variable pointed to by @ts.
361 */
362void ktime_get_ts(struct timespec *ts)
363{
4e250fdd 364 struct timekeeper *tk = &timekeeper;
951ed4d3 365 struct timespec tomono;
ec145bab 366 s64 nsec;
951ed4d3 367 unsigned int seq;
951ed4d3
MS
368
369 WARN_ON(timekeeping_suspended);
370
371 do {
9a7a71b1 372 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd 373 ts->tv_sec = tk->xtime_sec;
ec145bab 374 nsec = timekeeping_get_ns(tk);
4e250fdd 375 tomono = tk->wall_to_monotonic;
951ed4d3 376
9a7a71b1 377 } while (read_seqcount_retry(&timekeeper_seq, seq));
951ed4d3 378
ec145bab
JS
379 ts->tv_sec += tomono.tv_sec;
380 ts->tv_nsec = 0;
381 timespec_add_ns(ts, nsec + tomono.tv_nsec);
951ed4d3
MS
382}
383EXPORT_SYMBOL_GPL(ktime_get_ts);
384
1ff3c967
JS
385
386/**
387 * timekeeping_clocktai - Returns the TAI time of day in a timespec
388 * @ts: pointer to the timespec to be set
389 *
390 * Returns the time of day in a timespec.
391 */
392void timekeeping_clocktai(struct timespec *ts)
393{
394 struct timekeeper *tk = &timekeeper;
395 unsigned long seq;
396 u64 nsecs;
397
398 WARN_ON(timekeeping_suspended);
399
400 do {
9a7a71b1 401 seq = read_seqcount_begin(&timekeeper_seq);
1ff3c967
JS
402
403 ts->tv_sec = tk->xtime_sec + tk->tai_offset;
404 nsecs = timekeeping_get_ns(tk);
405
9a7a71b1 406 } while (read_seqcount_retry(&timekeeper_seq, seq));
1ff3c967
JS
407
408 ts->tv_nsec = 0;
409 timespec_add_ns(ts, nsecs);
410
411}
412EXPORT_SYMBOL(timekeeping_clocktai);
413
414
90adda98
JS
415/**
416 * ktime_get_clocktai - Returns the TAI time of day in a ktime
417 *
418 * Returns the time of day in a ktime.
419 */
420ktime_t ktime_get_clocktai(void)
421{
422 struct timespec ts;
423
424 timekeeping_clocktai(&ts);
425 return timespec_to_ktime(ts);
426}
427EXPORT_SYMBOL(ktime_get_clocktai);
428
e2c18e49
AG
429#ifdef CONFIG_NTP_PPS
430
431/**
432 * getnstime_raw_and_real - get day and raw monotonic time in timespec format
433 * @ts_raw: pointer to the timespec to be set to raw monotonic time
434 * @ts_real: pointer to the timespec to be set to the time of day
435 *
436 * This function reads both the time of day and raw monotonic time at the
437 * same time atomically and stores the resulting timestamps in timespec
438 * format.
439 */
440void getnstime_raw_and_real(struct timespec *ts_raw, struct timespec *ts_real)
441{
4e250fdd 442 struct timekeeper *tk = &timekeeper;
e2c18e49
AG
443 unsigned long seq;
444 s64 nsecs_raw, nsecs_real;
445
446 WARN_ON_ONCE(timekeeping_suspended);
447
448 do {
9a7a71b1 449 seq = read_seqcount_begin(&timekeeper_seq);
e2c18e49 450
4e250fdd
JS
451 *ts_raw = tk->raw_time;
452 ts_real->tv_sec = tk->xtime_sec;
1e75fa8b 453 ts_real->tv_nsec = 0;
e2c18e49 454
4e250fdd
JS
455 nsecs_raw = timekeeping_get_ns_raw(tk);
456 nsecs_real = timekeeping_get_ns(tk);
e2c18e49 457
9a7a71b1 458 } while (read_seqcount_retry(&timekeeper_seq, seq));
e2c18e49
AG
459
460 timespec_add_ns(ts_raw, nsecs_raw);
461 timespec_add_ns(ts_real, nsecs_real);
462}
463EXPORT_SYMBOL(getnstime_raw_and_real);
464
465#endif /* CONFIG_NTP_PPS */
466
8524070b
JS
467/**
468 * do_gettimeofday - Returns the time of day in a timeval
469 * @tv: pointer to the timeval to be set
470 *
efd9ac86 471 * NOTE: Users should be converted to using getnstimeofday()
8524070b
JS
472 */
473void do_gettimeofday(struct timeval *tv)
474{
475 struct timespec now;
476
efd9ac86 477 getnstimeofday(&now);
8524070b
JS
478 tv->tv_sec = now.tv_sec;
479 tv->tv_usec = now.tv_nsec/1000;
480}
8524070b 481EXPORT_SYMBOL(do_gettimeofday);
d239f49d 482
8524070b
JS
483/**
484 * do_settimeofday - Sets the time of day
485 * @tv: pointer to the timespec variable containing the new time
486 *
487 * Sets the time of day to the new time and update NTP and notify hrtimers
488 */
1e6d7679 489int do_settimeofday(const struct timespec *tv)
8524070b 490{
4e250fdd 491 struct timekeeper *tk = &timekeeper;
1e75fa8b 492 struct timespec ts_delta, xt;
92c1d3ed 493 unsigned long flags;
8524070b 494
cee58483 495 if (!timespec_valid_strict(tv))
8524070b
JS
496 return -EINVAL;
497
9a7a71b1
TG
498 raw_spin_lock_irqsave(&timekeeper_lock, flags);
499 write_seqcount_begin(&timekeeper_seq);
8524070b 500
4e250fdd 501 timekeeping_forward_now(tk);
9a055117 502
4e250fdd 503 xt = tk_xtime(tk);
1e75fa8b
JS
504 ts_delta.tv_sec = tv->tv_sec - xt.tv_sec;
505 ts_delta.tv_nsec = tv->tv_nsec - xt.tv_nsec;
506
4e250fdd 507 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, ts_delta));
8524070b 508
4e250fdd 509 tk_set_xtime(tk, tv);
1e75fa8b 510
48cdc135 511 timekeeping_update(tk, true, true);
8524070b 512
9a7a71b1
TG
513 write_seqcount_end(&timekeeper_seq);
514 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
515
516 /* signal hrtimers about time change */
517 clock_was_set();
518
519 return 0;
520}
8524070b
JS
521EXPORT_SYMBOL(do_settimeofday);
522
c528f7c6
JS
523/**
524 * timekeeping_inject_offset - Adds or subtracts from the current time.
525 * @tv: pointer to the timespec variable containing the offset
526 *
527 * Adds or subtracts an offset value from the current time.
528 */
529int timekeeping_inject_offset(struct timespec *ts)
530{
4e250fdd 531 struct timekeeper *tk = &timekeeper;
92c1d3ed 532 unsigned long flags;
4e8b1452
JS
533 struct timespec tmp;
534 int ret = 0;
c528f7c6
JS
535
536 if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
537 return -EINVAL;
538
9a7a71b1
TG
539 raw_spin_lock_irqsave(&timekeeper_lock, flags);
540 write_seqcount_begin(&timekeeper_seq);
c528f7c6 541
4e250fdd 542 timekeeping_forward_now(tk);
c528f7c6 543
4e8b1452
JS
544 /* Make sure the proposed value is valid */
545 tmp = timespec_add(tk_xtime(tk), *ts);
cee58483 546 if (!timespec_valid_strict(&tmp)) {
4e8b1452
JS
547 ret = -EINVAL;
548 goto error;
549 }
1e75fa8b 550
4e250fdd
JS
551 tk_xtime_add(tk, ts);
552 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, *ts));
c528f7c6 553
4e8b1452 554error: /* even if we error out, we forwarded the time, so call update */
48cdc135 555 timekeeping_update(tk, true, true);
c528f7c6 556
9a7a71b1
TG
557 write_seqcount_end(&timekeeper_seq);
558 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
c528f7c6
JS
559
560 /* signal hrtimers about time change */
561 clock_was_set();
562
4e8b1452 563 return ret;
c528f7c6
JS
564}
565EXPORT_SYMBOL(timekeeping_inject_offset);
566
cc244dda
JS
567
568/**
569 * timekeeping_get_tai_offset - Returns current TAI offset from UTC
570 *
571 */
572s32 timekeeping_get_tai_offset(void)
573{
574 struct timekeeper *tk = &timekeeper;
575 unsigned int seq;
576 s32 ret;
577
578 do {
9a7a71b1 579 seq = read_seqcount_begin(&timekeeper_seq);
cc244dda 580 ret = tk->tai_offset;
9a7a71b1 581 } while (read_seqcount_retry(&timekeeper_seq, seq));
cc244dda
JS
582
583 return ret;
584}
585
586/**
587 * __timekeeping_set_tai_offset - Lock free worker function
588 *
589 */
dd5d70e8 590static void __timekeeping_set_tai_offset(struct timekeeper *tk, s32 tai_offset)
cc244dda
JS
591{
592 tk->tai_offset = tai_offset;
90adda98 593 tk->offs_tai = ktime_sub(tk->offs_real, ktime_set(tai_offset, 0));
cc244dda
JS
594}
595
596/**
597 * timekeeping_set_tai_offset - Sets the current TAI offset from UTC
598 *
599 */
600void timekeeping_set_tai_offset(s32 tai_offset)
601{
602 struct timekeeper *tk = &timekeeper;
603 unsigned long flags;
604
9a7a71b1
TG
605 raw_spin_lock_irqsave(&timekeeper_lock, flags);
606 write_seqcount_begin(&timekeeper_seq);
cc244dda 607 __timekeeping_set_tai_offset(tk, tai_offset);
9a7a71b1
TG
608 write_seqcount_end(&timekeeper_seq);
609 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
cc244dda
JS
610}
611
8524070b
JS
612/**
613 * change_clocksource - Swaps clocksources if a new one is available
614 *
615 * Accumulates current time interval and initializes new clocksource
616 */
75c5158f 617static int change_clocksource(void *data)
8524070b 618{
4e250fdd 619 struct timekeeper *tk = &timekeeper;
4614e6ad 620 struct clocksource *new, *old;
f695cf94 621 unsigned long flags;
8524070b 622
75c5158f 623 new = (struct clocksource *) data;
8524070b 624
9a7a71b1
TG
625 raw_spin_lock_irqsave(&timekeeper_lock, flags);
626 write_seqcount_begin(&timekeeper_seq);
f695cf94 627
4e250fdd 628 timekeeping_forward_now(tk);
75c5158f 629 if (!new->enable || new->enable(new) == 0) {
4e250fdd
JS
630 old = tk->clock;
631 tk_setup_internals(tk, new);
75c5158f
MS
632 if (old->disable)
633 old->disable(old);
634 }
48cdc135 635 timekeeping_update(tk, true, true);
f695cf94 636
9a7a71b1
TG
637 write_seqcount_end(&timekeeper_seq);
638 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
f695cf94 639
75c5158f
MS
640 return 0;
641}
8524070b 642
75c5158f
MS
643/**
644 * timekeeping_notify - Install a new clock source
645 * @clock: pointer to the clock source
646 *
647 * This function is called from clocksource.c after a new, better clock
648 * source has been registered. The caller holds the clocksource_mutex.
649 */
650void timekeeping_notify(struct clocksource *clock)
651{
4e250fdd
JS
652 struct timekeeper *tk = &timekeeper;
653
654 if (tk->clock == clock)
4614e6ad 655 return;
75c5158f 656 stop_machine(change_clocksource, clock, NULL);
8524070b 657 tick_clock_notify();
8524070b 658}
75c5158f 659
a40f262c
TG
660/**
661 * ktime_get_real - get the real (wall-) time in ktime_t format
662 *
663 * returns the time in ktime_t format
664 */
665ktime_t ktime_get_real(void)
666{
667 struct timespec now;
668
669 getnstimeofday(&now);
670
671 return timespec_to_ktime(now);
672}
673EXPORT_SYMBOL_GPL(ktime_get_real);
8524070b 674
2d42244a
JS
675/**
676 * getrawmonotonic - Returns the raw monotonic time in a timespec
677 * @ts: pointer to the timespec to be set
678 *
679 * Returns the raw monotonic time (completely un-modified by ntp)
680 */
681void getrawmonotonic(struct timespec *ts)
682{
4e250fdd 683 struct timekeeper *tk = &timekeeper;
2d42244a
JS
684 unsigned long seq;
685 s64 nsecs;
2d42244a
JS
686
687 do {
9a7a71b1 688 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd
JS
689 nsecs = timekeeping_get_ns_raw(tk);
690 *ts = tk->raw_time;
2d42244a 691
9a7a71b1 692 } while (read_seqcount_retry(&timekeeper_seq, seq));
2d42244a
JS
693
694 timespec_add_ns(ts, nsecs);
695}
696EXPORT_SYMBOL(getrawmonotonic);
697
8524070b 698/**
cf4fc6cb 699 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
8524070b 700 */
cf4fc6cb 701int timekeeping_valid_for_hres(void)
8524070b 702{
4e250fdd 703 struct timekeeper *tk = &timekeeper;
8524070b
JS
704 unsigned long seq;
705 int ret;
706
707 do {
9a7a71b1 708 seq = read_seqcount_begin(&timekeeper_seq);
8524070b 709
4e250fdd 710 ret = tk->clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
8524070b 711
9a7a71b1 712 } while (read_seqcount_retry(&timekeeper_seq, seq));
8524070b
JS
713
714 return ret;
715}
716
98962465
JH
717/**
718 * timekeeping_max_deferment - Returns max time the clocksource can be deferred
98962465
JH
719 */
720u64 timekeeping_max_deferment(void)
721{
4e250fdd 722 struct timekeeper *tk = &timekeeper;
70471f2f
JS
723 unsigned long seq;
724 u64 ret;
42e71e81 725
70471f2f 726 do {
9a7a71b1 727 seq = read_seqcount_begin(&timekeeper_seq);
70471f2f 728
4e250fdd 729 ret = tk->clock->max_idle_ns;
70471f2f 730
9a7a71b1 731 } while (read_seqcount_retry(&timekeeper_seq, seq));
70471f2f
JS
732
733 return ret;
98962465
JH
734}
735
8524070b 736/**
d4f587c6 737 * read_persistent_clock - Return time from the persistent clock.
8524070b
JS
738 *
739 * Weak dummy function for arches that do not yet support it.
d4f587c6
MS
740 * Reads the time from the battery backed persistent clock.
741 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
8524070b
JS
742 *
743 * XXX - Do be sure to remove it once all arches implement it.
744 */
d4f587c6 745void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
8524070b 746{
d4f587c6
MS
747 ts->tv_sec = 0;
748 ts->tv_nsec = 0;
8524070b
JS
749}
750
23970e38
MS
751/**
752 * read_boot_clock - Return time of the system start.
753 *
754 * Weak dummy function for arches that do not yet support it.
755 * Function to read the exact time the system has been started.
756 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
757 *
758 * XXX - Do be sure to remove it once all arches implement it.
759 */
760void __attribute__((weak)) read_boot_clock(struct timespec *ts)
761{
762 ts->tv_sec = 0;
763 ts->tv_nsec = 0;
764}
765
8524070b
JS
766/*
767 * timekeeping_init - Initializes the clocksource and common timekeeping values
768 */
769void __init timekeeping_init(void)
770{
4e250fdd 771 struct timekeeper *tk = &timekeeper;
155ec602 772 struct clocksource *clock;
8524070b 773 unsigned long flags;
6d0ef903 774 struct timespec now, boot, tmp;
d4f587c6
MS
775
776 read_persistent_clock(&now);
31ade306 777
cee58483 778 if (!timespec_valid_strict(&now)) {
4e8b1452
JS
779 pr_warn("WARNING: Persistent clock returned invalid value!\n"
780 " Check your CMOS/BIOS settings.\n");
781 now.tv_sec = 0;
782 now.tv_nsec = 0;
31ade306
FT
783 } else if (now.tv_sec || now.tv_nsec)
784 persistent_clock_exist = true;
4e8b1452 785
23970e38 786 read_boot_clock(&boot);
cee58483 787 if (!timespec_valid_strict(&boot)) {
4e8b1452
JS
788 pr_warn("WARNING: Boot clock returned invalid value!\n"
789 " Check your CMOS/BIOS settings.\n");
790 boot.tv_sec = 0;
791 boot.tv_nsec = 0;
792 }
8524070b 793
9a7a71b1
TG
794 raw_spin_lock_irqsave(&timekeeper_lock, flags);
795 write_seqcount_begin(&timekeeper_seq);
06c017fd
JS
796 ntp_init();
797
f1b82746 798 clock = clocksource_default_clock();
a0f7d48b
MS
799 if (clock->enable)
800 clock->enable(clock);
4e250fdd 801 tk_setup_internals(tk, clock);
8524070b 802
4e250fdd
JS
803 tk_set_xtime(tk, &now);
804 tk->raw_time.tv_sec = 0;
805 tk->raw_time.tv_nsec = 0;
1e75fa8b 806 if (boot.tv_sec == 0 && boot.tv_nsec == 0)
4e250fdd 807 boot = tk_xtime(tk);
1e75fa8b 808
6d0ef903 809 set_normalized_timespec(&tmp, -boot.tv_sec, -boot.tv_nsec);
4e250fdd 810 tk_set_wall_to_mono(tk, tmp);
6d0ef903
JS
811
812 tmp.tv_sec = 0;
813 tmp.tv_nsec = 0;
4e250fdd 814 tk_set_sleep_time(tk, tmp);
6d0ef903 815
48cdc135
TG
816 memcpy(&shadow_timekeeper, &timekeeper, sizeof(timekeeper));
817
9a7a71b1
TG
818 write_seqcount_end(&timekeeper_seq);
819 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
820}
821
8524070b 822/* time in seconds when suspend began */
d4f587c6 823static struct timespec timekeeping_suspend_time;
8524070b 824
304529b1
JS
825/**
826 * __timekeeping_inject_sleeptime - Internal function to add sleep interval
827 * @delta: pointer to a timespec delta value
828 *
829 * Takes a timespec offset measuring a suspend interval and properly
830 * adds the sleep offset to the timekeeping variables.
831 */
f726a697
JS
832static void __timekeeping_inject_sleeptime(struct timekeeper *tk,
833 struct timespec *delta)
304529b1 834{
cee58483 835 if (!timespec_valid_strict(delta)) {
cbaa5152 836 printk(KERN_WARNING "__timekeeping_inject_sleeptime: Invalid "
cb5de2f8
JS
837 "sleep delta value!\n");
838 return;
839 }
f726a697 840 tk_xtime_add(tk, delta);
6d0ef903
JS
841 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, *delta));
842 tk_set_sleep_time(tk, timespec_add(tk->total_sleep_time, *delta));
304529b1
JS
843}
844
304529b1
JS
845/**
846 * timekeeping_inject_sleeptime - Adds suspend interval to timeekeeping values
847 * @delta: pointer to a timespec delta value
848 *
849 * This hook is for architectures that cannot support read_persistent_clock
850 * because their RTC/persistent clock is only accessible when irqs are enabled.
851 *
852 * This function should only be called by rtc_resume(), and allows
853 * a suspend offset to be injected into the timekeeping values.
854 */
855void timekeeping_inject_sleeptime(struct timespec *delta)
856{
4e250fdd 857 struct timekeeper *tk = &timekeeper;
92c1d3ed 858 unsigned long flags;
304529b1 859
31ade306
FT
860 /*
861 * Make sure we don't set the clock twice, as timekeeping_resume()
862 * already did it
863 */
864 if (has_persistent_clock())
304529b1
JS
865 return;
866
9a7a71b1
TG
867 raw_spin_lock_irqsave(&timekeeper_lock, flags);
868 write_seqcount_begin(&timekeeper_seq);
70471f2f 869
4e250fdd 870 timekeeping_forward_now(tk);
304529b1 871
4e250fdd 872 __timekeeping_inject_sleeptime(tk, delta);
304529b1 873
48cdc135 874 timekeeping_update(tk, true, true);
304529b1 875
9a7a71b1
TG
876 write_seqcount_end(&timekeeper_seq);
877 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
304529b1
JS
878
879 /* signal hrtimers about time change */
880 clock_was_set();
881}
882
8524070b
JS
883/**
884 * timekeeping_resume - Resumes the generic timekeeping subsystem.
8524070b
JS
885 *
886 * This is for the generic clocksource timekeeping.
887 * xtime/wall_to_monotonic/jiffies/etc are
888 * still managed by arch specific suspend/resume code.
889 */
e1a85b2c 890static void timekeeping_resume(void)
8524070b 891{
4e250fdd 892 struct timekeeper *tk = &timekeeper;
e445cf1c 893 struct clocksource *clock = tk->clock;
92c1d3ed 894 unsigned long flags;
e445cf1c
FT
895 struct timespec ts_new, ts_delta;
896 cycle_t cycle_now, cycle_delta;
897 bool suspendtime_found = false;
d4f587c6 898
e445cf1c 899 read_persistent_clock(&ts_new);
8524070b 900
adc78e6b 901 clockevents_resume();
d10ff3fb
TG
902 clocksource_resume();
903
9a7a71b1
TG
904 raw_spin_lock_irqsave(&timekeeper_lock, flags);
905 write_seqcount_begin(&timekeeper_seq);
8524070b 906
e445cf1c
FT
907 /*
908 * After system resumes, we need to calculate the suspended time and
909 * compensate it for the OS time. There are 3 sources that could be
910 * used: Nonstop clocksource during suspend, persistent clock and rtc
911 * device.
912 *
913 * One specific platform may have 1 or 2 or all of them, and the
914 * preference will be:
915 * suspend-nonstop clocksource -> persistent clock -> rtc
916 * The less preferred source will only be tried if there is no better
917 * usable source. The rtc part is handled separately in rtc core code.
918 */
919 cycle_now = clock->read(clock);
920 if ((clock->flags & CLOCK_SOURCE_SUSPEND_NONSTOP) &&
921 cycle_now > clock->cycle_last) {
922 u64 num, max = ULLONG_MAX;
923 u32 mult = clock->mult;
924 u32 shift = clock->shift;
925 s64 nsec = 0;
926
927 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
928
929 /*
930 * "cycle_delta * mutl" may cause 64 bits overflow, if the
931 * suspended time is too long. In that case we need do the
932 * 64 bits math carefully
933 */
934 do_div(max, mult);
935 if (cycle_delta > max) {
936 num = div64_u64(cycle_delta, max);
937 nsec = (((u64) max * mult) >> shift) * num;
938 cycle_delta -= num * max;
939 }
940 nsec += ((u64) cycle_delta * mult) >> shift;
941
942 ts_delta = ns_to_timespec(nsec);
943 suspendtime_found = true;
944 } else if (timespec_compare(&ts_new, &timekeeping_suspend_time) > 0) {
945 ts_delta = timespec_sub(ts_new, timekeeping_suspend_time);
946 suspendtime_found = true;
8524070b 947 }
e445cf1c
FT
948
949 if (suspendtime_found)
950 __timekeeping_inject_sleeptime(tk, &ts_delta);
951
952 /* Re-base the last cycle value */
953 clock->cycle_last = cycle_now;
4e250fdd 954 tk->ntp_error = 0;
8524070b 955 timekeeping_suspended = 0;
48cdc135 956 timekeeping_update(tk, false, true);
9a7a71b1
TG
957 write_seqcount_end(&timekeeper_seq);
958 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
959
960 touch_softlockup_watchdog();
961
962 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
963
964 /* Resume hrtimers */
b12a03ce 965 hrtimers_resume();
8524070b
JS
966}
967
e1a85b2c 968static int timekeeping_suspend(void)
8524070b 969{
4e250fdd 970 struct timekeeper *tk = &timekeeper;
92c1d3ed 971 unsigned long flags;
cb33217b
JS
972 struct timespec delta, delta_delta;
973 static struct timespec old_delta;
8524070b 974
d4f587c6 975 read_persistent_clock(&timekeeping_suspend_time);
3be90950 976
9a7a71b1
TG
977 raw_spin_lock_irqsave(&timekeeper_lock, flags);
978 write_seqcount_begin(&timekeeper_seq);
4e250fdd 979 timekeeping_forward_now(tk);
8524070b 980 timekeeping_suspended = 1;
cb33217b
JS
981
982 /*
983 * To avoid drift caused by repeated suspend/resumes,
984 * which each can add ~1 second drift error,
985 * try to compensate so the difference in system time
986 * and persistent_clock time stays close to constant.
987 */
4e250fdd 988 delta = timespec_sub(tk_xtime(tk), timekeeping_suspend_time);
cb33217b
JS
989 delta_delta = timespec_sub(delta, old_delta);
990 if (abs(delta_delta.tv_sec) >= 2) {
991 /*
992 * if delta_delta is too large, assume time correction
993 * has occured and set old_delta to the current delta.
994 */
995 old_delta = delta;
996 } else {
997 /* Otherwise try to adjust old_system to compensate */
998 timekeeping_suspend_time =
999 timespec_add(timekeeping_suspend_time, delta_delta);
1000 }
9a7a71b1
TG
1001 write_seqcount_end(&timekeeper_seq);
1002 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
1003
1004 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
c54a42b1 1005 clocksource_suspend();
adc78e6b 1006 clockevents_suspend();
8524070b
JS
1007
1008 return 0;
1009}
1010
1011/* sysfs resume/suspend bits for timekeeping */
e1a85b2c 1012static struct syscore_ops timekeeping_syscore_ops = {
8524070b
JS
1013 .resume = timekeeping_resume,
1014 .suspend = timekeeping_suspend,
8524070b
JS
1015};
1016
e1a85b2c 1017static int __init timekeeping_init_ops(void)
8524070b 1018{
e1a85b2c
RW
1019 register_syscore_ops(&timekeeping_syscore_ops);
1020 return 0;
8524070b
JS
1021}
1022
e1a85b2c 1023device_initcall(timekeeping_init_ops);
8524070b
JS
1024
1025/*
1026 * If the error is already larger, we look ahead even further
1027 * to compensate for late or lost adjustments.
1028 */
f726a697
JS
1029static __always_inline int timekeeping_bigadjust(struct timekeeper *tk,
1030 s64 error, s64 *interval,
8524070b
JS
1031 s64 *offset)
1032{
1033 s64 tick_error, i;
1034 u32 look_ahead, adj;
1035 s32 error2, mult;
1036
1037 /*
1038 * Use the current error value to determine how much to look ahead.
1039 * The larger the error the slower we adjust for it to avoid problems
1040 * with losing too many ticks, otherwise we would overadjust and
1041 * produce an even larger error. The smaller the adjustment the
1042 * faster we try to adjust for it, as lost ticks can do less harm
3eb05676 1043 * here. This is tuned so that an error of about 1 msec is adjusted
8524070b
JS
1044 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
1045 */
f726a697 1046 error2 = tk->ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
8524070b
JS
1047 error2 = abs(error2);
1048 for (look_ahead = 0; error2 > 0; look_ahead++)
1049 error2 >>= 2;
1050
1051 /*
1052 * Now calculate the error in (1 << look_ahead) ticks, but first
1053 * remove the single look ahead already included in the error.
1054 */
f726a697
JS
1055 tick_error = ntp_tick_length() >> (tk->ntp_error_shift + 1);
1056 tick_error -= tk->xtime_interval >> 1;
8524070b
JS
1057 error = ((error - tick_error) >> look_ahead) + tick_error;
1058
1059 /* Finally calculate the adjustment shift value. */
1060 i = *interval;
1061 mult = 1;
1062 if (error < 0) {
1063 error = -error;
1064 *interval = -*interval;
1065 *offset = -*offset;
1066 mult = -1;
1067 }
1068 for (adj = 0; error > i; adj++)
1069 error >>= 1;
1070
1071 *interval <<= adj;
1072 *offset <<= adj;
1073 return mult << adj;
1074}
1075
1076/*
1077 * Adjust the multiplier to reduce the error value,
1078 * this is optimized for the most common adjustments of -1,0,1,
1079 * for other values we can do a bit more work.
1080 */
f726a697 1081static void timekeeping_adjust(struct timekeeper *tk, s64 offset)
8524070b 1082{
f726a697 1083 s64 error, interval = tk->cycle_interval;
8524070b
JS
1084 int adj;
1085
c2bc1111 1086 /*
88b28adf 1087 * The point of this is to check if the error is greater than half
c2bc1111
JS
1088 * an interval.
1089 *
1090 * First we shift it down from NTP_SHIFT to clocksource->shifted nsecs.
1091 *
1092 * Note we subtract one in the shift, so that error is really error*2.
3f86f28f
JS
1093 * This "saves" dividing(shifting) interval twice, but keeps the
1094 * (error > interval) comparison as still measuring if error is
88b28adf 1095 * larger than half an interval.
c2bc1111 1096 *
3f86f28f 1097 * Note: It does not "save" on aggravation when reading the code.
c2bc1111 1098 */
f726a697 1099 error = tk->ntp_error >> (tk->ntp_error_shift - 1);
8524070b 1100 if (error > interval) {
c2bc1111
JS
1101 /*
1102 * We now divide error by 4(via shift), which checks if
88b28adf 1103 * the error is greater than twice the interval.
c2bc1111
JS
1104 * If it is greater, we need a bigadjust, if its smaller,
1105 * we can adjust by 1.
1106 */
8524070b 1107 error >>= 2;
c2bc1111
JS
1108 /*
1109 * XXX - In update_wall_time, we round up to the next
1110 * nanosecond, and store the amount rounded up into
1111 * the error. This causes the likely below to be unlikely.
1112 *
3f86f28f 1113 * The proper fix is to avoid rounding up by using
4e250fdd 1114 * the high precision tk->xtime_nsec instead of
c2bc1111
JS
1115 * xtime.tv_nsec everywhere. Fixing this will take some
1116 * time.
1117 */
8524070b
JS
1118 if (likely(error <= interval))
1119 adj = 1;
1120 else
1d17d174
IM
1121 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1122 } else {
1123 if (error < -interval) {
1124 /* See comment above, this is just switched for the negative */
1125 error >>= 2;
1126 if (likely(error >= -interval)) {
1127 adj = -1;
1128 interval = -interval;
1129 offset = -offset;
1130 } else {
1131 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1132 }
1133 } else {
1134 goto out_adjust;
1135 }
1136 }
8524070b 1137
f726a697
JS
1138 if (unlikely(tk->clock->maxadj &&
1139 (tk->mult + adj > tk->clock->mult + tk->clock->maxadj))) {
e919cfd4
JS
1140 printk_once(KERN_WARNING
1141 "Adjusting %s more than 11%% (%ld vs %ld)\n",
f726a697
JS
1142 tk->clock->name, (long)tk->mult + adj,
1143 (long)tk->clock->mult + tk->clock->maxadj);
e919cfd4 1144 }
c2bc1111
JS
1145 /*
1146 * So the following can be confusing.
1147 *
1148 * To keep things simple, lets assume adj == 1 for now.
1149 *
1150 * When adj != 1, remember that the interval and offset values
1151 * have been appropriately scaled so the math is the same.
1152 *
1153 * The basic idea here is that we're increasing the multiplier
1154 * by one, this causes the xtime_interval to be incremented by
1155 * one cycle_interval. This is because:
1156 * xtime_interval = cycle_interval * mult
1157 * So if mult is being incremented by one:
1158 * xtime_interval = cycle_interval * (mult + 1)
1159 * Its the same as:
1160 * xtime_interval = (cycle_interval * mult) + cycle_interval
1161 * Which can be shortened to:
1162 * xtime_interval += cycle_interval
1163 *
1164 * So offset stores the non-accumulated cycles. Thus the current
1165 * time (in shifted nanoseconds) is:
1166 * now = (offset * adj) + xtime_nsec
1167 * Now, even though we're adjusting the clock frequency, we have
1168 * to keep time consistent. In other words, we can't jump back
1169 * in time, and we also want to avoid jumping forward in time.
1170 *
1171 * So given the same offset value, we need the time to be the same
1172 * both before and after the freq adjustment.
1173 * now = (offset * adj_1) + xtime_nsec_1
1174 * now = (offset * adj_2) + xtime_nsec_2
1175 * So:
1176 * (offset * adj_1) + xtime_nsec_1 =
1177 * (offset * adj_2) + xtime_nsec_2
1178 * And we know:
1179 * adj_2 = adj_1 + 1
1180 * So:
1181 * (offset * adj_1) + xtime_nsec_1 =
1182 * (offset * (adj_1+1)) + xtime_nsec_2
1183 * (offset * adj_1) + xtime_nsec_1 =
1184 * (offset * adj_1) + offset + xtime_nsec_2
1185 * Canceling the sides:
1186 * xtime_nsec_1 = offset + xtime_nsec_2
1187 * Which gives us:
1188 * xtime_nsec_2 = xtime_nsec_1 - offset
1189 * Which simplfies to:
1190 * xtime_nsec -= offset
1191 *
1192 * XXX - TODO: Doc ntp_error calculation.
1193 */
f726a697
JS
1194 tk->mult += adj;
1195 tk->xtime_interval += interval;
1196 tk->xtime_nsec -= offset;
1197 tk->ntp_error -= (interval - offset) << tk->ntp_error_shift;
2a8c0883 1198
1d17d174 1199out_adjust:
2a8c0883
JS
1200 /*
1201 * It may be possible that when we entered this function, xtime_nsec
1202 * was very small. Further, if we're slightly speeding the clocksource
1203 * in the code above, its possible the required corrective factor to
1204 * xtime_nsec could cause it to underflow.
1205 *
1206 * Now, since we already accumulated the second, cannot simply roll
1207 * the accumulated second back, since the NTP subsystem has been
1208 * notified via second_overflow. So instead we push xtime_nsec forward
1209 * by the amount we underflowed, and add that amount into the error.
1210 *
1211 * We'll correct this error next time through this function, when
1212 * xtime_nsec is not as small.
1213 */
f726a697
JS
1214 if (unlikely((s64)tk->xtime_nsec < 0)) {
1215 s64 neg = -(s64)tk->xtime_nsec;
1216 tk->xtime_nsec = 0;
1217 tk->ntp_error += neg << tk->ntp_error_shift;
2a8c0883
JS
1218 }
1219
8524070b
JS
1220}
1221
1f4f9487
JS
1222/**
1223 * accumulate_nsecs_to_secs - Accumulates nsecs into secs
1224 *
1225 * Helper function that accumulates a the nsecs greater then a second
1226 * from the xtime_nsec field to the xtime_secs field.
1227 * It also calls into the NTP code to handle leapsecond processing.
1228 *
1229 */
1230static inline void accumulate_nsecs_to_secs(struct timekeeper *tk)
1231{
1232 u64 nsecps = (u64)NSEC_PER_SEC << tk->shift;
1233
1234 while (tk->xtime_nsec >= nsecps) {
1235 int leap;
1236
1237 tk->xtime_nsec -= nsecps;
1238 tk->xtime_sec++;
1239
1240 /* Figure out if its a leap sec and apply if needed */
1241 leap = second_overflow(tk->xtime_sec);
6d0ef903
JS
1242 if (unlikely(leap)) {
1243 struct timespec ts;
1244
1245 tk->xtime_sec += leap;
1f4f9487 1246
6d0ef903
JS
1247 ts.tv_sec = leap;
1248 ts.tv_nsec = 0;
1249 tk_set_wall_to_mono(tk,
1250 timespec_sub(tk->wall_to_monotonic, ts));
1251
cc244dda
JS
1252 __timekeeping_set_tai_offset(tk, tk->tai_offset - leap);
1253
6d0ef903
JS
1254 clock_was_set_delayed();
1255 }
1f4f9487
JS
1256 }
1257}
1258
a092ff0f
JS
1259/**
1260 * logarithmic_accumulation - shifted accumulation of cycles
1261 *
1262 * This functions accumulates a shifted interval of cycles into
1263 * into a shifted interval nanoseconds. Allows for O(log) accumulation
1264 * loop.
1265 *
1266 * Returns the unconsumed cycles.
1267 */
f726a697
JS
1268static cycle_t logarithmic_accumulation(struct timekeeper *tk, cycle_t offset,
1269 u32 shift)
a092ff0f 1270{
23a9537a 1271 cycle_t interval = tk->cycle_interval << shift;
deda2e81 1272 u64 raw_nsecs;
a092ff0f 1273
f726a697 1274 /* If the offset is smaller then a shifted interval, do nothing */
23a9537a 1275 if (offset < interval)
a092ff0f
JS
1276 return offset;
1277
1278 /* Accumulate one shifted interval */
23a9537a 1279 offset -= interval;
7ec98e15 1280 tk->cycle_last += interval;
a092ff0f 1281
f726a697
JS
1282 tk->xtime_nsec += tk->xtime_interval << shift;
1283 accumulate_nsecs_to_secs(tk);
a092ff0f 1284
deda2e81 1285 /* Accumulate raw time */
5b3900cd 1286 raw_nsecs = (u64)tk->raw_interval << shift;
f726a697 1287 raw_nsecs += tk->raw_time.tv_nsec;
c7dcf87a
JS
1288 if (raw_nsecs >= NSEC_PER_SEC) {
1289 u64 raw_secs = raw_nsecs;
1290 raw_nsecs = do_div(raw_secs, NSEC_PER_SEC);
f726a697 1291 tk->raw_time.tv_sec += raw_secs;
a092ff0f 1292 }
f726a697 1293 tk->raw_time.tv_nsec = raw_nsecs;
a092ff0f
JS
1294
1295 /* Accumulate error between NTP and clock interval */
f726a697
JS
1296 tk->ntp_error += ntp_tick_length() << shift;
1297 tk->ntp_error -= (tk->xtime_interval + tk->xtime_remainder) <<
1298 (tk->ntp_error_shift + shift);
a092ff0f
JS
1299
1300 return offset;
1301}
1302
92bb1fcf
JS
1303#ifdef CONFIG_GENERIC_TIME_VSYSCALL_OLD
1304static inline void old_vsyscall_fixup(struct timekeeper *tk)
1305{
1306 s64 remainder;
1307
1308 /*
1309 * Store only full nanoseconds into xtime_nsec after rounding
1310 * it up and add the remainder to the error difference.
1311 * XXX - This is necessary to avoid small 1ns inconsistnecies caused
1312 * by truncating the remainder in vsyscalls. However, it causes
1313 * additional work to be done in timekeeping_adjust(). Once
1314 * the vsyscall implementations are converted to use xtime_nsec
1315 * (shifted nanoseconds), and CONFIG_GENERIC_TIME_VSYSCALL_OLD
1316 * users are removed, this can be killed.
1317 */
1318 remainder = tk->xtime_nsec & ((1ULL << tk->shift) - 1);
1319 tk->xtime_nsec -= remainder;
1320 tk->xtime_nsec += 1ULL << tk->shift;
1321 tk->ntp_error += remainder << tk->ntp_error_shift;
1322
1323}
1324#else
1325#define old_vsyscall_fixup(tk)
1326#endif
1327
1328
1329
8524070b
JS
1330/**
1331 * update_wall_time - Uses the current clocksource to increment the wall time
1332 *
8524070b 1333 */
871cf1e5 1334static void update_wall_time(void)
8524070b 1335{
155ec602 1336 struct clocksource *clock;
48cdc135
TG
1337 struct timekeeper *real_tk = &timekeeper;
1338 struct timekeeper *tk = &shadow_timekeeper;
8524070b 1339 cycle_t offset;
a092ff0f 1340 int shift = 0, maxshift;
70471f2f
JS
1341 unsigned long flags;
1342
9a7a71b1 1343 raw_spin_lock_irqsave(&timekeeper_lock, flags);
8524070b
JS
1344
1345 /* Make sure we're fully resumed: */
1346 if (unlikely(timekeeping_suspended))
70471f2f 1347 goto out;
8524070b 1348
48cdc135 1349 clock = real_tk->clock;
592913ec
JS
1350
1351#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
48cdc135 1352 offset = real_tk->cycle_interval;
592913ec
JS
1353#else
1354 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
8524070b 1355#endif
8524070b 1356
bf2ac312 1357 /* Check if there's really nothing to do */
48cdc135 1358 if (offset < real_tk->cycle_interval)
bf2ac312
JS
1359 goto out;
1360
a092ff0f
JS
1361 /*
1362 * With NO_HZ we may have to accumulate many cycle_intervals
1363 * (think "ticks") worth of time at once. To do this efficiently,
1364 * we calculate the largest doubling multiple of cycle_intervals
88b28adf 1365 * that is smaller than the offset. We then accumulate that
a092ff0f
JS
1366 * chunk in one go, and then try to consume the next smaller
1367 * doubled multiple.
8524070b 1368 */
4e250fdd 1369 shift = ilog2(offset) - ilog2(tk->cycle_interval);
a092ff0f 1370 shift = max(0, shift);
88b28adf 1371 /* Bound shift to one less than what overflows tick_length */
ea7cf49a 1372 maxshift = (64 - (ilog2(ntp_tick_length())+1)) - 1;
a092ff0f 1373 shift = min(shift, maxshift);
4e250fdd
JS
1374 while (offset >= tk->cycle_interval) {
1375 offset = logarithmic_accumulation(tk, offset, shift);
1376 if (offset < tk->cycle_interval<<shift)
830ec045 1377 shift--;
8524070b
JS
1378 }
1379
1380 /* correct the clock when NTP error is too big */
4e250fdd 1381 timekeeping_adjust(tk, offset);
8524070b 1382
6a867a39 1383 /*
92bb1fcf
JS
1384 * XXX This can be killed once everyone converts
1385 * to the new update_vsyscall.
1386 */
1387 old_vsyscall_fixup(tk);
8524070b 1388
6a867a39
JS
1389 /*
1390 * Finally, make sure that after the rounding
1e75fa8b 1391 * xtime_nsec isn't larger than NSEC_PER_SEC
6a867a39 1392 */
4e250fdd 1393 accumulate_nsecs_to_secs(tk);
83f57a11 1394
ca4523cd 1395 write_seqcount_begin(&timekeeper_seq);
7ec98e15
TG
1396 /* Update clock->cycle_last with the new value */
1397 clock->cycle_last = tk->cycle_last;
48cdc135
TG
1398 /*
1399 * Update the real timekeeper.
1400 *
1401 * We could avoid this memcpy by switching pointers, but that
1402 * requires changes to all other timekeeper usage sites as
1403 * well, i.e. move the timekeeper pointer getter into the
1404 * spinlocked/seqcount protected sections. And we trade this
1405 * memcpy under the timekeeper_seq against one before we start
1406 * updating.
1407 */
1408 memcpy(real_tk, tk, sizeof(*tk));
1409 timekeeping_update(real_tk, false, false);
9a7a71b1 1410 write_seqcount_end(&timekeeper_seq);
ca4523cd 1411out:
9a7a71b1 1412 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b 1413}
7c3f1a57
TJ
1414
1415/**
1416 * getboottime - Return the real time of system boot.
1417 * @ts: pointer to the timespec to be set
1418 *
abb3a4ea 1419 * Returns the wall-time of boot in a timespec.
7c3f1a57
TJ
1420 *
1421 * This is based on the wall_to_monotonic offset and the total suspend
1422 * time. Calls to settimeofday will affect the value returned (which
1423 * basically means that however wrong your real time clock is at boot time,
1424 * you get the right time here).
1425 */
1426void getboottime(struct timespec *ts)
1427{
4e250fdd 1428 struct timekeeper *tk = &timekeeper;
36d47481 1429 struct timespec boottime = {
4e250fdd
JS
1430 .tv_sec = tk->wall_to_monotonic.tv_sec +
1431 tk->total_sleep_time.tv_sec,
1432 .tv_nsec = tk->wall_to_monotonic.tv_nsec +
1433 tk->total_sleep_time.tv_nsec
36d47481 1434 };
d4f587c6 1435
d4f587c6 1436 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
7c3f1a57 1437}
c93d89f3 1438EXPORT_SYMBOL_GPL(getboottime);
7c3f1a57 1439
abb3a4ea
JS
1440/**
1441 * get_monotonic_boottime - Returns monotonic time since boot
1442 * @ts: pointer to the timespec to be set
1443 *
1444 * Returns the monotonic time since boot in a timespec.
1445 *
1446 * This is similar to CLOCK_MONTONIC/ktime_get_ts, but also
1447 * includes the time spent in suspend.
1448 */
1449void get_monotonic_boottime(struct timespec *ts)
1450{
4e250fdd 1451 struct timekeeper *tk = &timekeeper;
abb3a4ea 1452 struct timespec tomono, sleep;
ec145bab 1453 s64 nsec;
abb3a4ea 1454 unsigned int seq;
abb3a4ea
JS
1455
1456 WARN_ON(timekeeping_suspended);
1457
1458 do {
9a7a71b1 1459 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd 1460 ts->tv_sec = tk->xtime_sec;
ec145bab 1461 nsec = timekeeping_get_ns(tk);
4e250fdd
JS
1462 tomono = tk->wall_to_monotonic;
1463 sleep = tk->total_sleep_time;
abb3a4ea 1464
9a7a71b1 1465 } while (read_seqcount_retry(&timekeeper_seq, seq));
abb3a4ea 1466
ec145bab
JS
1467 ts->tv_sec += tomono.tv_sec + sleep.tv_sec;
1468 ts->tv_nsec = 0;
1469 timespec_add_ns(ts, nsec + tomono.tv_nsec + sleep.tv_nsec);
abb3a4ea
JS
1470}
1471EXPORT_SYMBOL_GPL(get_monotonic_boottime);
1472
1473/**
1474 * ktime_get_boottime - Returns monotonic time since boot in a ktime
1475 *
1476 * Returns the monotonic time since boot in a ktime
1477 *
1478 * This is similar to CLOCK_MONTONIC/ktime_get, but also
1479 * includes the time spent in suspend.
1480 */
1481ktime_t ktime_get_boottime(void)
1482{
1483 struct timespec ts;
1484
1485 get_monotonic_boottime(&ts);
1486 return timespec_to_ktime(ts);
1487}
1488EXPORT_SYMBOL_GPL(ktime_get_boottime);
1489
7c3f1a57
TJ
1490/**
1491 * monotonic_to_bootbased - Convert the monotonic time to boot based.
1492 * @ts: pointer to the timespec to be converted
1493 */
1494void monotonic_to_bootbased(struct timespec *ts)
1495{
4e250fdd
JS
1496 struct timekeeper *tk = &timekeeper;
1497
1498 *ts = timespec_add(*ts, tk->total_sleep_time);
7c3f1a57 1499}
c93d89f3 1500EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
2c6b47de 1501
17c38b74
JS
1502unsigned long get_seconds(void)
1503{
4e250fdd
JS
1504 struct timekeeper *tk = &timekeeper;
1505
1506 return tk->xtime_sec;
17c38b74
JS
1507}
1508EXPORT_SYMBOL(get_seconds);
1509
da15cfda
JS
1510struct timespec __current_kernel_time(void)
1511{
4e250fdd
JS
1512 struct timekeeper *tk = &timekeeper;
1513
1514 return tk_xtime(tk);
da15cfda 1515}
17c38b74 1516
2c6b47de
JS
1517struct timespec current_kernel_time(void)
1518{
4e250fdd 1519 struct timekeeper *tk = &timekeeper;
2c6b47de
JS
1520 struct timespec now;
1521 unsigned long seq;
1522
1523 do {
9a7a71b1 1524 seq = read_seqcount_begin(&timekeeper_seq);
83f57a11 1525
4e250fdd 1526 now = tk_xtime(tk);
9a7a71b1 1527 } while (read_seqcount_retry(&timekeeper_seq, seq));
2c6b47de
JS
1528
1529 return now;
1530}
2c6b47de 1531EXPORT_SYMBOL(current_kernel_time);
da15cfda
JS
1532
1533struct timespec get_monotonic_coarse(void)
1534{
4e250fdd 1535 struct timekeeper *tk = &timekeeper;
da15cfda
JS
1536 struct timespec now, mono;
1537 unsigned long seq;
1538
1539 do {
9a7a71b1 1540 seq = read_seqcount_begin(&timekeeper_seq);
83f57a11 1541
4e250fdd
JS
1542 now = tk_xtime(tk);
1543 mono = tk->wall_to_monotonic;
9a7a71b1 1544 } while (read_seqcount_retry(&timekeeper_seq, seq));
da15cfda
JS
1545
1546 set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
1547 now.tv_nsec + mono.tv_nsec);
1548 return now;
1549}
871cf1e5
TH
1550
1551/*
d6ad4187 1552 * Must hold jiffies_lock
871cf1e5
TH
1553 */
1554void do_timer(unsigned long ticks)
1555{
1556 jiffies_64 += ticks;
1557 update_wall_time();
1558 calc_global_load(ticks);
1559}
48cf76f7
TH
1560
1561/**
314ac371
JS
1562 * get_xtime_and_monotonic_and_sleep_offset() - get xtime, wall_to_monotonic,
1563 * and sleep offsets.
48cf76f7
TH
1564 * @xtim: pointer to timespec to be set with xtime
1565 * @wtom: pointer to timespec to be set with wall_to_monotonic
314ac371 1566 * @sleep: pointer to timespec to be set with time in suspend
48cf76f7 1567 */
314ac371
JS
1568void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
1569 struct timespec *wtom, struct timespec *sleep)
48cf76f7 1570{
4e250fdd 1571 struct timekeeper *tk = &timekeeper;
48cf76f7
TH
1572 unsigned long seq;
1573
1574 do {
9a7a71b1 1575 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd
JS
1576 *xtim = tk_xtime(tk);
1577 *wtom = tk->wall_to_monotonic;
1578 *sleep = tk->total_sleep_time;
9a7a71b1 1579 } while (read_seqcount_retry(&timekeeper_seq, seq));
48cf76f7 1580}
f0af911a 1581
f6c06abf
TG
1582#ifdef CONFIG_HIGH_RES_TIMERS
1583/**
1584 * ktime_get_update_offsets - hrtimer helper
1585 * @offs_real: pointer to storage for monotonic -> realtime offset
1586 * @offs_boot: pointer to storage for monotonic -> boottime offset
1587 *
1588 * Returns current monotonic time and updates the offsets
1589 * Called from hrtimer_interupt() or retrigger_next_event()
1590 */
90adda98
JS
1591ktime_t ktime_get_update_offsets(ktime_t *offs_real, ktime_t *offs_boot,
1592 ktime_t *offs_tai)
f6c06abf 1593{
4e250fdd 1594 struct timekeeper *tk = &timekeeper;
f6c06abf
TG
1595 ktime_t now;
1596 unsigned int seq;
1597 u64 secs, nsecs;
1598
1599 do {
9a7a71b1 1600 seq = read_seqcount_begin(&timekeeper_seq);
f6c06abf 1601
4e250fdd
JS
1602 secs = tk->xtime_sec;
1603 nsecs = timekeeping_get_ns(tk);
f6c06abf 1604
4e250fdd
JS
1605 *offs_real = tk->offs_real;
1606 *offs_boot = tk->offs_boot;
90adda98 1607 *offs_tai = tk->offs_tai;
9a7a71b1 1608 } while (read_seqcount_retry(&timekeeper_seq, seq));
f6c06abf
TG
1609
1610 now = ktime_add_ns(ktime_set(secs, 0), nsecs);
1611 now = ktime_sub(now, *offs_real);
1612 return now;
1613}
1614#endif
1615
99ee5315
TG
1616/**
1617 * ktime_get_monotonic_offset() - get wall_to_monotonic in ktime_t format
1618 */
1619ktime_t ktime_get_monotonic_offset(void)
1620{
4e250fdd 1621 struct timekeeper *tk = &timekeeper;
99ee5315
TG
1622 unsigned long seq;
1623 struct timespec wtom;
1624
1625 do {
9a7a71b1 1626 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd 1627 wtom = tk->wall_to_monotonic;
9a7a71b1 1628 } while (read_seqcount_retry(&timekeeper_seq, seq));
70471f2f 1629
99ee5315
TG
1630 return timespec_to_ktime(wtom);
1631}
a80b83b7
JS
1632EXPORT_SYMBOL_GPL(ktime_get_monotonic_offset);
1633
aa6f9c59
JS
1634/**
1635 * do_adjtimex() - Accessor function to NTP __do_adjtimex function
1636 */
1637int do_adjtimex(struct timex *txc)
1638{
0b5154fb 1639 struct timekeeper *tk = &timekeeper;
06c017fd 1640 unsigned long flags;
87ace39b 1641 struct timespec ts;
0b5154fb 1642 s32 tai;
e4085693
JS
1643 int ret;
1644
1645 /* Validate the data before disabling interrupts */
1646 ret = ntp_validate_timex(txc);
1647 if (ret)
1648 return ret;
1649
cef90377
JS
1650 if (txc->modes & ADJ_SETOFFSET) {
1651 struct timespec delta;
1652 delta.tv_sec = txc->time.tv_sec;
1653 delta.tv_nsec = txc->time.tv_usec;
1654 if (!(txc->modes & ADJ_NANO))
1655 delta.tv_nsec *= 1000;
1656 ret = timekeeping_inject_offset(&delta);
1657 if (ret)
1658 return ret;
1659 }
1660
87ace39b 1661 getnstimeofday(&ts);
87ace39b 1662
06c017fd
JS
1663 raw_spin_lock_irqsave(&timekeeper_lock, flags);
1664 write_seqcount_begin(&timekeeper_seq);
1665
0b5154fb 1666 tai = tk->tai_offset;
87ace39b 1667 ret = __do_adjtimex(txc, &ts, &tai);
aa6f9c59 1668
0b5154fb 1669 __timekeeping_set_tai_offset(tk, tai);
06c017fd
JS
1670 write_seqcount_end(&timekeeper_seq);
1671 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
1672
87ace39b
JS
1673 return ret;
1674}
aa6f9c59
JS
1675
1676#ifdef CONFIG_NTP_PPS
1677/**
1678 * hardpps() - Accessor function to NTP __hardpps function
1679 */
1680void hardpps(const struct timespec *phase_ts, const struct timespec *raw_ts)
1681{
06c017fd
JS
1682 unsigned long flags;
1683
1684 raw_spin_lock_irqsave(&timekeeper_lock, flags);
1685 write_seqcount_begin(&timekeeper_seq);
1686
aa6f9c59 1687 __hardpps(phase_ts, raw_ts);
06c017fd
JS
1688
1689 write_seqcount_end(&timekeeper_seq);
1690 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
aa6f9c59
JS
1691}
1692EXPORT_SYMBOL(hardpps);
1693#endif
1694
f0af911a
TH
1695/**
1696 * xtime_update() - advances the timekeeping infrastructure
1697 * @ticks: number of ticks, that have elapsed since the last call.
1698 *
1699 * Must be called with interrupts disabled.
1700 */
1701void xtime_update(unsigned long ticks)
1702{
d6ad4187 1703 write_seqlock(&jiffies_lock);
f0af911a 1704 do_timer(ticks);
d6ad4187 1705 write_sequnlock(&jiffies_lock);
f0af911a 1706}