]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - kernel/time/timekeeping.c
timerfd: Add alarm timers
[mirror_ubuntu-zesty-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);
4e8f8b34 610 clock_was_set();
cc244dda
JS
611}
612
8524070b
JS
613/**
614 * change_clocksource - Swaps clocksources if a new one is available
615 *
616 * Accumulates current time interval and initializes new clocksource
617 */
75c5158f 618static int change_clocksource(void *data)
8524070b 619{
4e250fdd 620 struct timekeeper *tk = &timekeeper;
4614e6ad 621 struct clocksource *new, *old;
f695cf94 622 unsigned long flags;
8524070b 623
75c5158f 624 new = (struct clocksource *) data;
8524070b 625
9a7a71b1
TG
626 raw_spin_lock_irqsave(&timekeeper_lock, flags);
627 write_seqcount_begin(&timekeeper_seq);
f695cf94 628
4e250fdd 629 timekeeping_forward_now(tk);
09ac369c
TG
630 /*
631 * If the cs is in module, get a module reference. Succeeds
632 * for built-in code (owner == NULL) as well.
633 */
634 if (try_module_get(new->owner)) {
635 if (!new->enable || new->enable(new) == 0) {
636 old = tk->clock;
637 tk_setup_internals(tk, new);
638 if (old->disable)
639 old->disable(old);
640 module_put(old->owner);
641 } else {
642 module_put(new->owner);
643 }
75c5158f 644 }
48cdc135 645 timekeeping_update(tk, true, true);
f695cf94 646
9a7a71b1
TG
647 write_seqcount_end(&timekeeper_seq);
648 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
f695cf94 649
75c5158f
MS
650 return 0;
651}
8524070b 652
75c5158f
MS
653/**
654 * timekeeping_notify - Install a new clock source
655 * @clock: pointer to the clock source
656 *
657 * This function is called from clocksource.c after a new, better clock
658 * source has been registered. The caller holds the clocksource_mutex.
659 */
ba919d1c 660int timekeeping_notify(struct clocksource *clock)
75c5158f 661{
4e250fdd
JS
662 struct timekeeper *tk = &timekeeper;
663
664 if (tk->clock == clock)
ba919d1c 665 return 0;
75c5158f 666 stop_machine(change_clocksource, clock, NULL);
8524070b 667 tick_clock_notify();
ba919d1c 668 return tk->clock == clock ? 0 : -1;
8524070b 669}
75c5158f 670
a40f262c
TG
671/**
672 * ktime_get_real - get the real (wall-) time in ktime_t format
673 *
674 * returns the time in ktime_t format
675 */
676ktime_t ktime_get_real(void)
677{
678 struct timespec now;
679
680 getnstimeofday(&now);
681
682 return timespec_to_ktime(now);
683}
684EXPORT_SYMBOL_GPL(ktime_get_real);
8524070b 685
2d42244a
JS
686/**
687 * getrawmonotonic - Returns the raw monotonic time in a timespec
688 * @ts: pointer to the timespec to be set
689 *
690 * Returns the raw monotonic time (completely un-modified by ntp)
691 */
692void getrawmonotonic(struct timespec *ts)
693{
4e250fdd 694 struct timekeeper *tk = &timekeeper;
2d42244a
JS
695 unsigned long seq;
696 s64 nsecs;
2d42244a
JS
697
698 do {
9a7a71b1 699 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd
JS
700 nsecs = timekeeping_get_ns_raw(tk);
701 *ts = tk->raw_time;
2d42244a 702
9a7a71b1 703 } while (read_seqcount_retry(&timekeeper_seq, seq));
2d42244a
JS
704
705 timespec_add_ns(ts, nsecs);
706}
707EXPORT_SYMBOL(getrawmonotonic);
708
8524070b 709/**
cf4fc6cb 710 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
8524070b 711 */
cf4fc6cb 712int timekeeping_valid_for_hres(void)
8524070b 713{
4e250fdd 714 struct timekeeper *tk = &timekeeper;
8524070b
JS
715 unsigned long seq;
716 int ret;
717
718 do {
9a7a71b1 719 seq = read_seqcount_begin(&timekeeper_seq);
8524070b 720
4e250fdd 721 ret = tk->clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
8524070b 722
9a7a71b1 723 } while (read_seqcount_retry(&timekeeper_seq, seq));
8524070b
JS
724
725 return ret;
726}
727
98962465
JH
728/**
729 * timekeeping_max_deferment - Returns max time the clocksource can be deferred
98962465
JH
730 */
731u64 timekeeping_max_deferment(void)
732{
4e250fdd 733 struct timekeeper *tk = &timekeeper;
70471f2f
JS
734 unsigned long seq;
735 u64 ret;
42e71e81 736
70471f2f 737 do {
9a7a71b1 738 seq = read_seqcount_begin(&timekeeper_seq);
70471f2f 739
4e250fdd 740 ret = tk->clock->max_idle_ns;
70471f2f 741
9a7a71b1 742 } while (read_seqcount_retry(&timekeeper_seq, seq));
70471f2f
JS
743
744 return ret;
98962465
JH
745}
746
8524070b 747/**
d4f587c6 748 * read_persistent_clock - Return time from the persistent clock.
8524070b
JS
749 *
750 * Weak dummy function for arches that do not yet support it.
d4f587c6
MS
751 * Reads the time from the battery backed persistent clock.
752 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
8524070b
JS
753 *
754 * XXX - Do be sure to remove it once all arches implement it.
755 */
d4f587c6 756void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
8524070b 757{
d4f587c6
MS
758 ts->tv_sec = 0;
759 ts->tv_nsec = 0;
8524070b
JS
760}
761
23970e38
MS
762/**
763 * read_boot_clock - Return time of the system start.
764 *
765 * Weak dummy function for arches that do not yet support it.
766 * Function to read the exact time the system has been started.
767 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
768 *
769 * XXX - Do be sure to remove it once all arches implement it.
770 */
771void __attribute__((weak)) read_boot_clock(struct timespec *ts)
772{
773 ts->tv_sec = 0;
774 ts->tv_nsec = 0;
775}
776
8524070b
JS
777/*
778 * timekeeping_init - Initializes the clocksource and common timekeeping values
779 */
780void __init timekeeping_init(void)
781{
4e250fdd 782 struct timekeeper *tk = &timekeeper;
155ec602 783 struct clocksource *clock;
8524070b 784 unsigned long flags;
6d0ef903 785 struct timespec now, boot, tmp;
d4f587c6
MS
786
787 read_persistent_clock(&now);
31ade306 788
cee58483 789 if (!timespec_valid_strict(&now)) {
4e8b1452
JS
790 pr_warn("WARNING: Persistent clock returned invalid value!\n"
791 " Check your CMOS/BIOS settings.\n");
792 now.tv_sec = 0;
793 now.tv_nsec = 0;
31ade306
FT
794 } else if (now.tv_sec || now.tv_nsec)
795 persistent_clock_exist = true;
4e8b1452 796
23970e38 797 read_boot_clock(&boot);
cee58483 798 if (!timespec_valid_strict(&boot)) {
4e8b1452
JS
799 pr_warn("WARNING: Boot clock returned invalid value!\n"
800 " Check your CMOS/BIOS settings.\n");
801 boot.tv_sec = 0;
802 boot.tv_nsec = 0;
803 }
8524070b 804
9a7a71b1
TG
805 raw_spin_lock_irqsave(&timekeeper_lock, flags);
806 write_seqcount_begin(&timekeeper_seq);
06c017fd
JS
807 ntp_init();
808
f1b82746 809 clock = clocksource_default_clock();
a0f7d48b
MS
810 if (clock->enable)
811 clock->enable(clock);
4e250fdd 812 tk_setup_internals(tk, clock);
8524070b 813
4e250fdd
JS
814 tk_set_xtime(tk, &now);
815 tk->raw_time.tv_sec = 0;
816 tk->raw_time.tv_nsec = 0;
1e75fa8b 817 if (boot.tv_sec == 0 && boot.tv_nsec == 0)
4e250fdd 818 boot = tk_xtime(tk);
1e75fa8b 819
6d0ef903 820 set_normalized_timespec(&tmp, -boot.tv_sec, -boot.tv_nsec);
4e250fdd 821 tk_set_wall_to_mono(tk, tmp);
6d0ef903
JS
822
823 tmp.tv_sec = 0;
824 tmp.tv_nsec = 0;
4e250fdd 825 tk_set_sleep_time(tk, tmp);
6d0ef903 826
48cdc135
TG
827 memcpy(&shadow_timekeeper, &timekeeper, sizeof(timekeeper));
828
9a7a71b1
TG
829 write_seqcount_end(&timekeeper_seq);
830 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
831}
832
8524070b 833/* time in seconds when suspend began */
d4f587c6 834static struct timespec timekeeping_suspend_time;
8524070b 835
304529b1
JS
836/**
837 * __timekeeping_inject_sleeptime - Internal function to add sleep interval
838 * @delta: pointer to a timespec delta value
839 *
840 * Takes a timespec offset measuring a suspend interval and properly
841 * adds the sleep offset to the timekeeping variables.
842 */
f726a697
JS
843static void __timekeeping_inject_sleeptime(struct timekeeper *tk,
844 struct timespec *delta)
304529b1 845{
cee58483 846 if (!timespec_valid_strict(delta)) {
cbaa5152 847 printk(KERN_WARNING "__timekeeping_inject_sleeptime: Invalid "
cb5de2f8
JS
848 "sleep delta value!\n");
849 return;
850 }
f726a697 851 tk_xtime_add(tk, delta);
6d0ef903
JS
852 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, *delta));
853 tk_set_sleep_time(tk, timespec_add(tk->total_sleep_time, *delta));
304529b1
JS
854}
855
304529b1
JS
856/**
857 * timekeeping_inject_sleeptime - Adds suspend interval to timeekeeping values
858 * @delta: pointer to a timespec delta value
859 *
860 * This hook is for architectures that cannot support read_persistent_clock
861 * because their RTC/persistent clock is only accessible when irqs are enabled.
862 *
863 * This function should only be called by rtc_resume(), and allows
864 * a suspend offset to be injected into the timekeeping values.
865 */
866void timekeeping_inject_sleeptime(struct timespec *delta)
867{
4e250fdd 868 struct timekeeper *tk = &timekeeper;
92c1d3ed 869 unsigned long flags;
304529b1 870
31ade306
FT
871 /*
872 * Make sure we don't set the clock twice, as timekeeping_resume()
873 * already did it
874 */
875 if (has_persistent_clock())
304529b1
JS
876 return;
877
9a7a71b1
TG
878 raw_spin_lock_irqsave(&timekeeper_lock, flags);
879 write_seqcount_begin(&timekeeper_seq);
70471f2f 880
4e250fdd 881 timekeeping_forward_now(tk);
304529b1 882
4e250fdd 883 __timekeeping_inject_sleeptime(tk, delta);
304529b1 884
48cdc135 885 timekeeping_update(tk, true, true);
304529b1 886
9a7a71b1
TG
887 write_seqcount_end(&timekeeper_seq);
888 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
304529b1
JS
889
890 /* signal hrtimers about time change */
891 clock_was_set();
892}
893
8524070b
JS
894/**
895 * timekeeping_resume - Resumes the generic timekeeping subsystem.
8524070b
JS
896 *
897 * This is for the generic clocksource timekeeping.
898 * xtime/wall_to_monotonic/jiffies/etc are
899 * still managed by arch specific suspend/resume code.
900 */
e1a85b2c 901static void timekeeping_resume(void)
8524070b 902{
4e250fdd 903 struct timekeeper *tk = &timekeeper;
e445cf1c 904 struct clocksource *clock = tk->clock;
92c1d3ed 905 unsigned long flags;
e445cf1c
FT
906 struct timespec ts_new, ts_delta;
907 cycle_t cycle_now, cycle_delta;
908 bool suspendtime_found = false;
d4f587c6 909
e445cf1c 910 read_persistent_clock(&ts_new);
8524070b 911
adc78e6b 912 clockevents_resume();
d10ff3fb
TG
913 clocksource_resume();
914
9a7a71b1
TG
915 raw_spin_lock_irqsave(&timekeeper_lock, flags);
916 write_seqcount_begin(&timekeeper_seq);
8524070b 917
e445cf1c
FT
918 /*
919 * After system resumes, we need to calculate the suspended time and
920 * compensate it for the OS time. There are 3 sources that could be
921 * used: Nonstop clocksource during suspend, persistent clock and rtc
922 * device.
923 *
924 * One specific platform may have 1 or 2 or all of them, and the
925 * preference will be:
926 * suspend-nonstop clocksource -> persistent clock -> rtc
927 * The less preferred source will only be tried if there is no better
928 * usable source. The rtc part is handled separately in rtc core code.
929 */
930 cycle_now = clock->read(clock);
931 if ((clock->flags & CLOCK_SOURCE_SUSPEND_NONSTOP) &&
932 cycle_now > clock->cycle_last) {
933 u64 num, max = ULLONG_MAX;
934 u32 mult = clock->mult;
935 u32 shift = clock->shift;
936 s64 nsec = 0;
937
938 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
939
940 /*
941 * "cycle_delta * mutl" may cause 64 bits overflow, if the
942 * suspended time is too long. In that case we need do the
943 * 64 bits math carefully
944 */
945 do_div(max, mult);
946 if (cycle_delta > max) {
947 num = div64_u64(cycle_delta, max);
948 nsec = (((u64) max * mult) >> shift) * num;
949 cycle_delta -= num * max;
950 }
951 nsec += ((u64) cycle_delta * mult) >> shift;
952
953 ts_delta = ns_to_timespec(nsec);
954 suspendtime_found = true;
955 } else if (timespec_compare(&ts_new, &timekeeping_suspend_time) > 0) {
956 ts_delta = timespec_sub(ts_new, timekeeping_suspend_time);
957 suspendtime_found = true;
8524070b 958 }
e445cf1c
FT
959
960 if (suspendtime_found)
961 __timekeeping_inject_sleeptime(tk, &ts_delta);
962
963 /* Re-base the last cycle value */
77c675ba 964 tk->cycle_last = clock->cycle_last = cycle_now;
4e250fdd 965 tk->ntp_error = 0;
8524070b 966 timekeeping_suspended = 0;
48cdc135 967 timekeeping_update(tk, false, true);
9a7a71b1
TG
968 write_seqcount_end(&timekeeper_seq);
969 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
970
971 touch_softlockup_watchdog();
972
973 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
974
975 /* Resume hrtimers */
b12a03ce 976 hrtimers_resume();
8524070b
JS
977}
978
e1a85b2c 979static int timekeeping_suspend(void)
8524070b 980{
4e250fdd 981 struct timekeeper *tk = &timekeeper;
92c1d3ed 982 unsigned long flags;
cb33217b
JS
983 struct timespec delta, delta_delta;
984 static struct timespec old_delta;
8524070b 985
d4f587c6 986 read_persistent_clock(&timekeeping_suspend_time);
3be90950 987
9a7a71b1
TG
988 raw_spin_lock_irqsave(&timekeeper_lock, flags);
989 write_seqcount_begin(&timekeeper_seq);
4e250fdd 990 timekeeping_forward_now(tk);
8524070b 991 timekeeping_suspended = 1;
cb33217b
JS
992
993 /*
994 * To avoid drift caused by repeated suspend/resumes,
995 * which each can add ~1 second drift error,
996 * try to compensate so the difference in system time
997 * and persistent_clock time stays close to constant.
998 */
4e250fdd 999 delta = timespec_sub(tk_xtime(tk), timekeeping_suspend_time);
cb33217b
JS
1000 delta_delta = timespec_sub(delta, old_delta);
1001 if (abs(delta_delta.tv_sec) >= 2) {
1002 /*
1003 * if delta_delta is too large, assume time correction
1004 * has occured and set old_delta to the current delta.
1005 */
1006 old_delta = delta;
1007 } else {
1008 /* Otherwise try to adjust old_system to compensate */
1009 timekeeping_suspend_time =
1010 timespec_add(timekeeping_suspend_time, delta_delta);
1011 }
9a7a71b1
TG
1012 write_seqcount_end(&timekeeper_seq);
1013 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b
JS
1014
1015 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
c54a42b1 1016 clocksource_suspend();
adc78e6b 1017 clockevents_suspend();
8524070b
JS
1018
1019 return 0;
1020}
1021
1022/* sysfs resume/suspend bits for timekeeping */
e1a85b2c 1023static struct syscore_ops timekeeping_syscore_ops = {
8524070b
JS
1024 .resume = timekeeping_resume,
1025 .suspend = timekeeping_suspend,
8524070b
JS
1026};
1027
e1a85b2c 1028static int __init timekeeping_init_ops(void)
8524070b 1029{
e1a85b2c
RW
1030 register_syscore_ops(&timekeeping_syscore_ops);
1031 return 0;
8524070b
JS
1032}
1033
e1a85b2c 1034device_initcall(timekeeping_init_ops);
8524070b
JS
1035
1036/*
1037 * If the error is already larger, we look ahead even further
1038 * to compensate for late or lost adjustments.
1039 */
f726a697
JS
1040static __always_inline int timekeeping_bigadjust(struct timekeeper *tk,
1041 s64 error, s64 *interval,
8524070b
JS
1042 s64 *offset)
1043{
1044 s64 tick_error, i;
1045 u32 look_ahead, adj;
1046 s32 error2, mult;
1047
1048 /*
1049 * Use the current error value to determine how much to look ahead.
1050 * The larger the error the slower we adjust for it to avoid problems
1051 * with losing too many ticks, otherwise we would overadjust and
1052 * produce an even larger error. The smaller the adjustment the
1053 * faster we try to adjust for it, as lost ticks can do less harm
3eb05676 1054 * here. This is tuned so that an error of about 1 msec is adjusted
8524070b
JS
1055 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
1056 */
f726a697 1057 error2 = tk->ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
8524070b
JS
1058 error2 = abs(error2);
1059 for (look_ahead = 0; error2 > 0; look_ahead++)
1060 error2 >>= 2;
1061
1062 /*
1063 * Now calculate the error in (1 << look_ahead) ticks, but first
1064 * remove the single look ahead already included in the error.
1065 */
f726a697
JS
1066 tick_error = ntp_tick_length() >> (tk->ntp_error_shift + 1);
1067 tick_error -= tk->xtime_interval >> 1;
8524070b
JS
1068 error = ((error - tick_error) >> look_ahead) + tick_error;
1069
1070 /* Finally calculate the adjustment shift value. */
1071 i = *interval;
1072 mult = 1;
1073 if (error < 0) {
1074 error = -error;
1075 *interval = -*interval;
1076 *offset = -*offset;
1077 mult = -1;
1078 }
1079 for (adj = 0; error > i; adj++)
1080 error >>= 1;
1081
1082 *interval <<= adj;
1083 *offset <<= adj;
1084 return mult << adj;
1085}
1086
1087/*
1088 * Adjust the multiplier to reduce the error value,
1089 * this is optimized for the most common adjustments of -1,0,1,
1090 * for other values we can do a bit more work.
1091 */
f726a697 1092static void timekeeping_adjust(struct timekeeper *tk, s64 offset)
8524070b 1093{
f726a697 1094 s64 error, interval = tk->cycle_interval;
8524070b
JS
1095 int adj;
1096
c2bc1111 1097 /*
88b28adf 1098 * The point of this is to check if the error is greater than half
c2bc1111
JS
1099 * an interval.
1100 *
1101 * First we shift it down from NTP_SHIFT to clocksource->shifted nsecs.
1102 *
1103 * Note we subtract one in the shift, so that error is really error*2.
3f86f28f
JS
1104 * This "saves" dividing(shifting) interval twice, but keeps the
1105 * (error > interval) comparison as still measuring if error is
88b28adf 1106 * larger than half an interval.
c2bc1111 1107 *
3f86f28f 1108 * Note: It does not "save" on aggravation when reading the code.
c2bc1111 1109 */
f726a697 1110 error = tk->ntp_error >> (tk->ntp_error_shift - 1);
8524070b 1111 if (error > interval) {
c2bc1111
JS
1112 /*
1113 * We now divide error by 4(via shift), which checks if
88b28adf 1114 * the error is greater than twice the interval.
c2bc1111
JS
1115 * If it is greater, we need a bigadjust, if its smaller,
1116 * we can adjust by 1.
1117 */
8524070b 1118 error >>= 2;
c2bc1111
JS
1119 /*
1120 * XXX - In update_wall_time, we round up to the next
1121 * nanosecond, and store the amount rounded up into
1122 * the error. This causes the likely below to be unlikely.
1123 *
3f86f28f 1124 * The proper fix is to avoid rounding up by using
4e250fdd 1125 * the high precision tk->xtime_nsec instead of
c2bc1111
JS
1126 * xtime.tv_nsec everywhere. Fixing this will take some
1127 * time.
1128 */
8524070b
JS
1129 if (likely(error <= interval))
1130 adj = 1;
1131 else
1d17d174
IM
1132 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1133 } else {
1134 if (error < -interval) {
1135 /* See comment above, this is just switched for the negative */
1136 error >>= 2;
1137 if (likely(error >= -interval)) {
1138 adj = -1;
1139 interval = -interval;
1140 offset = -offset;
1141 } else {
1142 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1143 }
1144 } else {
1145 goto out_adjust;
1146 }
1147 }
8524070b 1148
f726a697
JS
1149 if (unlikely(tk->clock->maxadj &&
1150 (tk->mult + adj > tk->clock->mult + tk->clock->maxadj))) {
e919cfd4
JS
1151 printk_once(KERN_WARNING
1152 "Adjusting %s more than 11%% (%ld vs %ld)\n",
f726a697
JS
1153 tk->clock->name, (long)tk->mult + adj,
1154 (long)tk->clock->mult + tk->clock->maxadj);
e919cfd4 1155 }
c2bc1111
JS
1156 /*
1157 * So the following can be confusing.
1158 *
1159 * To keep things simple, lets assume adj == 1 for now.
1160 *
1161 * When adj != 1, remember that the interval and offset values
1162 * have been appropriately scaled so the math is the same.
1163 *
1164 * The basic idea here is that we're increasing the multiplier
1165 * by one, this causes the xtime_interval to be incremented by
1166 * one cycle_interval. This is because:
1167 * xtime_interval = cycle_interval * mult
1168 * So if mult is being incremented by one:
1169 * xtime_interval = cycle_interval * (mult + 1)
1170 * Its the same as:
1171 * xtime_interval = (cycle_interval * mult) + cycle_interval
1172 * Which can be shortened to:
1173 * xtime_interval += cycle_interval
1174 *
1175 * So offset stores the non-accumulated cycles. Thus the current
1176 * time (in shifted nanoseconds) is:
1177 * now = (offset * adj) + xtime_nsec
1178 * Now, even though we're adjusting the clock frequency, we have
1179 * to keep time consistent. In other words, we can't jump back
1180 * in time, and we also want to avoid jumping forward in time.
1181 *
1182 * So given the same offset value, we need the time to be the same
1183 * both before and after the freq adjustment.
1184 * now = (offset * adj_1) + xtime_nsec_1
1185 * now = (offset * adj_2) + xtime_nsec_2
1186 * So:
1187 * (offset * adj_1) + xtime_nsec_1 =
1188 * (offset * adj_2) + xtime_nsec_2
1189 * And we know:
1190 * adj_2 = adj_1 + 1
1191 * So:
1192 * (offset * adj_1) + xtime_nsec_1 =
1193 * (offset * (adj_1+1)) + xtime_nsec_2
1194 * (offset * adj_1) + xtime_nsec_1 =
1195 * (offset * adj_1) + offset + xtime_nsec_2
1196 * Canceling the sides:
1197 * xtime_nsec_1 = offset + xtime_nsec_2
1198 * Which gives us:
1199 * xtime_nsec_2 = xtime_nsec_1 - offset
1200 * Which simplfies to:
1201 * xtime_nsec -= offset
1202 *
1203 * XXX - TODO: Doc ntp_error calculation.
1204 */
f726a697
JS
1205 tk->mult += adj;
1206 tk->xtime_interval += interval;
1207 tk->xtime_nsec -= offset;
1208 tk->ntp_error -= (interval - offset) << tk->ntp_error_shift;
2a8c0883 1209
1d17d174 1210out_adjust:
2a8c0883
JS
1211 /*
1212 * It may be possible that when we entered this function, xtime_nsec
1213 * was very small. Further, if we're slightly speeding the clocksource
1214 * in the code above, its possible the required corrective factor to
1215 * xtime_nsec could cause it to underflow.
1216 *
1217 * Now, since we already accumulated the second, cannot simply roll
1218 * the accumulated second back, since the NTP subsystem has been
1219 * notified via second_overflow. So instead we push xtime_nsec forward
1220 * by the amount we underflowed, and add that amount into the error.
1221 *
1222 * We'll correct this error next time through this function, when
1223 * xtime_nsec is not as small.
1224 */
f726a697
JS
1225 if (unlikely((s64)tk->xtime_nsec < 0)) {
1226 s64 neg = -(s64)tk->xtime_nsec;
1227 tk->xtime_nsec = 0;
1228 tk->ntp_error += neg << tk->ntp_error_shift;
2a8c0883
JS
1229 }
1230
8524070b
JS
1231}
1232
1f4f9487
JS
1233/**
1234 * accumulate_nsecs_to_secs - Accumulates nsecs into secs
1235 *
1236 * Helper function that accumulates a the nsecs greater then a second
1237 * from the xtime_nsec field to the xtime_secs field.
1238 * It also calls into the NTP code to handle leapsecond processing.
1239 *
1240 */
1241static inline void accumulate_nsecs_to_secs(struct timekeeper *tk)
1242{
1243 u64 nsecps = (u64)NSEC_PER_SEC << tk->shift;
1244
1245 while (tk->xtime_nsec >= nsecps) {
1246 int leap;
1247
1248 tk->xtime_nsec -= nsecps;
1249 tk->xtime_sec++;
1250
1251 /* Figure out if its a leap sec and apply if needed */
1252 leap = second_overflow(tk->xtime_sec);
6d0ef903
JS
1253 if (unlikely(leap)) {
1254 struct timespec ts;
1255
1256 tk->xtime_sec += leap;
1f4f9487 1257
6d0ef903
JS
1258 ts.tv_sec = leap;
1259 ts.tv_nsec = 0;
1260 tk_set_wall_to_mono(tk,
1261 timespec_sub(tk->wall_to_monotonic, ts));
1262
cc244dda
JS
1263 __timekeeping_set_tai_offset(tk, tk->tai_offset - leap);
1264
6d0ef903
JS
1265 clock_was_set_delayed();
1266 }
1f4f9487
JS
1267 }
1268}
1269
a092ff0f
JS
1270/**
1271 * logarithmic_accumulation - shifted accumulation of cycles
1272 *
1273 * This functions accumulates a shifted interval of cycles into
1274 * into a shifted interval nanoseconds. Allows for O(log) accumulation
1275 * loop.
1276 *
1277 * Returns the unconsumed cycles.
1278 */
f726a697
JS
1279static cycle_t logarithmic_accumulation(struct timekeeper *tk, cycle_t offset,
1280 u32 shift)
a092ff0f 1281{
23a9537a 1282 cycle_t interval = tk->cycle_interval << shift;
deda2e81 1283 u64 raw_nsecs;
a092ff0f 1284
f726a697 1285 /* If the offset is smaller then a shifted interval, do nothing */
23a9537a 1286 if (offset < interval)
a092ff0f
JS
1287 return offset;
1288
1289 /* Accumulate one shifted interval */
23a9537a 1290 offset -= interval;
7ec98e15 1291 tk->cycle_last += interval;
a092ff0f 1292
f726a697
JS
1293 tk->xtime_nsec += tk->xtime_interval << shift;
1294 accumulate_nsecs_to_secs(tk);
a092ff0f 1295
deda2e81 1296 /* Accumulate raw time */
5b3900cd 1297 raw_nsecs = (u64)tk->raw_interval << shift;
f726a697 1298 raw_nsecs += tk->raw_time.tv_nsec;
c7dcf87a
JS
1299 if (raw_nsecs >= NSEC_PER_SEC) {
1300 u64 raw_secs = raw_nsecs;
1301 raw_nsecs = do_div(raw_secs, NSEC_PER_SEC);
f726a697 1302 tk->raw_time.tv_sec += raw_secs;
a092ff0f 1303 }
f726a697 1304 tk->raw_time.tv_nsec = raw_nsecs;
a092ff0f
JS
1305
1306 /* Accumulate error between NTP and clock interval */
f726a697
JS
1307 tk->ntp_error += ntp_tick_length() << shift;
1308 tk->ntp_error -= (tk->xtime_interval + tk->xtime_remainder) <<
1309 (tk->ntp_error_shift + shift);
a092ff0f
JS
1310
1311 return offset;
1312}
1313
92bb1fcf
JS
1314#ifdef CONFIG_GENERIC_TIME_VSYSCALL_OLD
1315static inline void old_vsyscall_fixup(struct timekeeper *tk)
1316{
1317 s64 remainder;
1318
1319 /*
1320 * Store only full nanoseconds into xtime_nsec after rounding
1321 * it up and add the remainder to the error difference.
1322 * XXX - This is necessary to avoid small 1ns inconsistnecies caused
1323 * by truncating the remainder in vsyscalls. However, it causes
1324 * additional work to be done in timekeeping_adjust(). Once
1325 * the vsyscall implementations are converted to use xtime_nsec
1326 * (shifted nanoseconds), and CONFIG_GENERIC_TIME_VSYSCALL_OLD
1327 * users are removed, this can be killed.
1328 */
1329 remainder = tk->xtime_nsec & ((1ULL << tk->shift) - 1);
1330 tk->xtime_nsec -= remainder;
1331 tk->xtime_nsec += 1ULL << tk->shift;
1332 tk->ntp_error += remainder << tk->ntp_error_shift;
1333
1334}
1335#else
1336#define old_vsyscall_fixup(tk)
1337#endif
1338
1339
1340
8524070b
JS
1341/**
1342 * update_wall_time - Uses the current clocksource to increment the wall time
1343 *
8524070b 1344 */
871cf1e5 1345static void update_wall_time(void)
8524070b 1346{
155ec602 1347 struct clocksource *clock;
48cdc135
TG
1348 struct timekeeper *real_tk = &timekeeper;
1349 struct timekeeper *tk = &shadow_timekeeper;
8524070b 1350 cycle_t offset;
a092ff0f 1351 int shift = 0, maxshift;
70471f2f
JS
1352 unsigned long flags;
1353
9a7a71b1 1354 raw_spin_lock_irqsave(&timekeeper_lock, flags);
8524070b
JS
1355
1356 /* Make sure we're fully resumed: */
1357 if (unlikely(timekeeping_suspended))
70471f2f 1358 goto out;
8524070b 1359
48cdc135 1360 clock = real_tk->clock;
592913ec
JS
1361
1362#ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
48cdc135 1363 offset = real_tk->cycle_interval;
592913ec
JS
1364#else
1365 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
8524070b 1366#endif
8524070b 1367
bf2ac312 1368 /* Check if there's really nothing to do */
48cdc135 1369 if (offset < real_tk->cycle_interval)
bf2ac312
JS
1370 goto out;
1371
a092ff0f
JS
1372 /*
1373 * With NO_HZ we may have to accumulate many cycle_intervals
1374 * (think "ticks") worth of time at once. To do this efficiently,
1375 * we calculate the largest doubling multiple of cycle_intervals
88b28adf 1376 * that is smaller than the offset. We then accumulate that
a092ff0f
JS
1377 * chunk in one go, and then try to consume the next smaller
1378 * doubled multiple.
8524070b 1379 */
4e250fdd 1380 shift = ilog2(offset) - ilog2(tk->cycle_interval);
a092ff0f 1381 shift = max(0, shift);
88b28adf 1382 /* Bound shift to one less than what overflows tick_length */
ea7cf49a 1383 maxshift = (64 - (ilog2(ntp_tick_length())+1)) - 1;
a092ff0f 1384 shift = min(shift, maxshift);
4e250fdd
JS
1385 while (offset >= tk->cycle_interval) {
1386 offset = logarithmic_accumulation(tk, offset, shift);
1387 if (offset < tk->cycle_interval<<shift)
830ec045 1388 shift--;
8524070b
JS
1389 }
1390
1391 /* correct the clock when NTP error is too big */
4e250fdd 1392 timekeeping_adjust(tk, offset);
8524070b 1393
6a867a39 1394 /*
92bb1fcf
JS
1395 * XXX This can be killed once everyone converts
1396 * to the new update_vsyscall.
1397 */
1398 old_vsyscall_fixup(tk);
8524070b 1399
6a867a39
JS
1400 /*
1401 * Finally, make sure that after the rounding
1e75fa8b 1402 * xtime_nsec isn't larger than NSEC_PER_SEC
6a867a39 1403 */
4e250fdd 1404 accumulate_nsecs_to_secs(tk);
83f57a11 1405
ca4523cd 1406 write_seqcount_begin(&timekeeper_seq);
7ec98e15
TG
1407 /* Update clock->cycle_last with the new value */
1408 clock->cycle_last = tk->cycle_last;
48cdc135
TG
1409 /*
1410 * Update the real timekeeper.
1411 *
1412 * We could avoid this memcpy by switching pointers, but that
1413 * requires changes to all other timekeeper usage sites as
1414 * well, i.e. move the timekeeper pointer getter into the
1415 * spinlocked/seqcount protected sections. And we trade this
1416 * memcpy under the timekeeper_seq against one before we start
1417 * updating.
1418 */
1419 memcpy(real_tk, tk, sizeof(*tk));
1420 timekeeping_update(real_tk, false, false);
9a7a71b1 1421 write_seqcount_end(&timekeeper_seq);
ca4523cd 1422out:
9a7a71b1 1423 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
8524070b 1424}
7c3f1a57
TJ
1425
1426/**
1427 * getboottime - Return the real time of system boot.
1428 * @ts: pointer to the timespec to be set
1429 *
abb3a4ea 1430 * Returns the wall-time of boot in a timespec.
7c3f1a57
TJ
1431 *
1432 * This is based on the wall_to_monotonic offset and the total suspend
1433 * time. Calls to settimeofday will affect the value returned (which
1434 * basically means that however wrong your real time clock is at boot time,
1435 * you get the right time here).
1436 */
1437void getboottime(struct timespec *ts)
1438{
4e250fdd 1439 struct timekeeper *tk = &timekeeper;
36d47481 1440 struct timespec boottime = {
4e250fdd
JS
1441 .tv_sec = tk->wall_to_monotonic.tv_sec +
1442 tk->total_sleep_time.tv_sec,
1443 .tv_nsec = tk->wall_to_monotonic.tv_nsec +
1444 tk->total_sleep_time.tv_nsec
36d47481 1445 };
d4f587c6 1446
d4f587c6 1447 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
7c3f1a57 1448}
c93d89f3 1449EXPORT_SYMBOL_GPL(getboottime);
7c3f1a57 1450
abb3a4ea
JS
1451/**
1452 * get_monotonic_boottime - Returns monotonic time since boot
1453 * @ts: pointer to the timespec to be set
1454 *
1455 * Returns the monotonic time since boot in a timespec.
1456 *
1457 * This is similar to CLOCK_MONTONIC/ktime_get_ts, but also
1458 * includes the time spent in suspend.
1459 */
1460void get_monotonic_boottime(struct timespec *ts)
1461{
4e250fdd 1462 struct timekeeper *tk = &timekeeper;
abb3a4ea 1463 struct timespec tomono, sleep;
ec145bab 1464 s64 nsec;
abb3a4ea 1465 unsigned int seq;
abb3a4ea
JS
1466
1467 WARN_ON(timekeeping_suspended);
1468
1469 do {
9a7a71b1 1470 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd 1471 ts->tv_sec = tk->xtime_sec;
ec145bab 1472 nsec = timekeeping_get_ns(tk);
4e250fdd
JS
1473 tomono = tk->wall_to_monotonic;
1474 sleep = tk->total_sleep_time;
abb3a4ea 1475
9a7a71b1 1476 } while (read_seqcount_retry(&timekeeper_seq, seq));
abb3a4ea 1477
ec145bab
JS
1478 ts->tv_sec += tomono.tv_sec + sleep.tv_sec;
1479 ts->tv_nsec = 0;
1480 timespec_add_ns(ts, nsec + tomono.tv_nsec + sleep.tv_nsec);
abb3a4ea
JS
1481}
1482EXPORT_SYMBOL_GPL(get_monotonic_boottime);
1483
1484/**
1485 * ktime_get_boottime - Returns monotonic time since boot in a ktime
1486 *
1487 * Returns the monotonic time since boot in a ktime
1488 *
1489 * This is similar to CLOCK_MONTONIC/ktime_get, but also
1490 * includes the time spent in suspend.
1491 */
1492ktime_t ktime_get_boottime(void)
1493{
1494 struct timespec ts;
1495
1496 get_monotonic_boottime(&ts);
1497 return timespec_to_ktime(ts);
1498}
1499EXPORT_SYMBOL_GPL(ktime_get_boottime);
1500
7c3f1a57
TJ
1501/**
1502 * monotonic_to_bootbased - Convert the monotonic time to boot based.
1503 * @ts: pointer to the timespec to be converted
1504 */
1505void monotonic_to_bootbased(struct timespec *ts)
1506{
4e250fdd
JS
1507 struct timekeeper *tk = &timekeeper;
1508
1509 *ts = timespec_add(*ts, tk->total_sleep_time);
7c3f1a57 1510}
c93d89f3 1511EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
2c6b47de 1512
17c38b74
JS
1513unsigned long get_seconds(void)
1514{
4e250fdd
JS
1515 struct timekeeper *tk = &timekeeper;
1516
1517 return tk->xtime_sec;
17c38b74
JS
1518}
1519EXPORT_SYMBOL(get_seconds);
1520
da15cfda
JS
1521struct timespec __current_kernel_time(void)
1522{
4e250fdd
JS
1523 struct timekeeper *tk = &timekeeper;
1524
1525 return tk_xtime(tk);
da15cfda 1526}
17c38b74 1527
2c6b47de
JS
1528struct timespec current_kernel_time(void)
1529{
4e250fdd 1530 struct timekeeper *tk = &timekeeper;
2c6b47de
JS
1531 struct timespec now;
1532 unsigned long seq;
1533
1534 do {
9a7a71b1 1535 seq = read_seqcount_begin(&timekeeper_seq);
83f57a11 1536
4e250fdd 1537 now = tk_xtime(tk);
9a7a71b1 1538 } while (read_seqcount_retry(&timekeeper_seq, seq));
2c6b47de
JS
1539
1540 return now;
1541}
2c6b47de 1542EXPORT_SYMBOL(current_kernel_time);
da15cfda
JS
1543
1544struct timespec get_monotonic_coarse(void)
1545{
4e250fdd 1546 struct timekeeper *tk = &timekeeper;
da15cfda
JS
1547 struct timespec now, mono;
1548 unsigned long seq;
1549
1550 do {
9a7a71b1 1551 seq = read_seqcount_begin(&timekeeper_seq);
83f57a11 1552
4e250fdd
JS
1553 now = tk_xtime(tk);
1554 mono = tk->wall_to_monotonic;
9a7a71b1 1555 } while (read_seqcount_retry(&timekeeper_seq, seq));
da15cfda
JS
1556
1557 set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
1558 now.tv_nsec + mono.tv_nsec);
1559 return now;
1560}
871cf1e5
TH
1561
1562/*
d6ad4187 1563 * Must hold jiffies_lock
871cf1e5
TH
1564 */
1565void do_timer(unsigned long ticks)
1566{
1567 jiffies_64 += ticks;
1568 update_wall_time();
1569 calc_global_load(ticks);
1570}
48cf76f7
TH
1571
1572/**
314ac371
JS
1573 * get_xtime_and_monotonic_and_sleep_offset() - get xtime, wall_to_monotonic,
1574 * and sleep offsets.
48cf76f7
TH
1575 * @xtim: pointer to timespec to be set with xtime
1576 * @wtom: pointer to timespec to be set with wall_to_monotonic
314ac371 1577 * @sleep: pointer to timespec to be set with time in suspend
48cf76f7 1578 */
314ac371
JS
1579void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
1580 struct timespec *wtom, struct timespec *sleep)
48cf76f7 1581{
4e250fdd 1582 struct timekeeper *tk = &timekeeper;
48cf76f7
TH
1583 unsigned long seq;
1584
1585 do {
9a7a71b1 1586 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd
JS
1587 *xtim = tk_xtime(tk);
1588 *wtom = tk->wall_to_monotonic;
1589 *sleep = tk->total_sleep_time;
9a7a71b1 1590 } while (read_seqcount_retry(&timekeeper_seq, seq));
48cf76f7 1591}
f0af911a 1592
f6c06abf
TG
1593#ifdef CONFIG_HIGH_RES_TIMERS
1594/**
1595 * ktime_get_update_offsets - hrtimer helper
1596 * @offs_real: pointer to storage for monotonic -> realtime offset
1597 * @offs_boot: pointer to storage for monotonic -> boottime offset
1598 *
1599 * Returns current monotonic time and updates the offsets
1600 * Called from hrtimer_interupt() or retrigger_next_event()
1601 */
90adda98
JS
1602ktime_t ktime_get_update_offsets(ktime_t *offs_real, ktime_t *offs_boot,
1603 ktime_t *offs_tai)
f6c06abf 1604{
4e250fdd 1605 struct timekeeper *tk = &timekeeper;
f6c06abf
TG
1606 ktime_t now;
1607 unsigned int seq;
1608 u64 secs, nsecs;
1609
1610 do {
9a7a71b1 1611 seq = read_seqcount_begin(&timekeeper_seq);
f6c06abf 1612
4e250fdd
JS
1613 secs = tk->xtime_sec;
1614 nsecs = timekeeping_get_ns(tk);
f6c06abf 1615
4e250fdd
JS
1616 *offs_real = tk->offs_real;
1617 *offs_boot = tk->offs_boot;
90adda98 1618 *offs_tai = tk->offs_tai;
9a7a71b1 1619 } while (read_seqcount_retry(&timekeeper_seq, seq));
f6c06abf
TG
1620
1621 now = ktime_add_ns(ktime_set(secs, 0), nsecs);
1622 now = ktime_sub(now, *offs_real);
1623 return now;
1624}
1625#endif
1626
99ee5315
TG
1627/**
1628 * ktime_get_monotonic_offset() - get wall_to_monotonic in ktime_t format
1629 */
1630ktime_t ktime_get_monotonic_offset(void)
1631{
4e250fdd 1632 struct timekeeper *tk = &timekeeper;
99ee5315
TG
1633 unsigned long seq;
1634 struct timespec wtom;
1635
1636 do {
9a7a71b1 1637 seq = read_seqcount_begin(&timekeeper_seq);
4e250fdd 1638 wtom = tk->wall_to_monotonic;
9a7a71b1 1639 } while (read_seqcount_retry(&timekeeper_seq, seq));
70471f2f 1640
99ee5315
TG
1641 return timespec_to_ktime(wtom);
1642}
a80b83b7
JS
1643EXPORT_SYMBOL_GPL(ktime_get_monotonic_offset);
1644
aa6f9c59
JS
1645/**
1646 * do_adjtimex() - Accessor function to NTP __do_adjtimex function
1647 */
1648int do_adjtimex(struct timex *txc)
1649{
0b5154fb 1650 struct timekeeper *tk = &timekeeper;
06c017fd 1651 unsigned long flags;
87ace39b 1652 struct timespec ts;
4e8f8b34 1653 s32 orig_tai, tai;
e4085693
JS
1654 int ret;
1655
1656 /* Validate the data before disabling interrupts */
1657 ret = ntp_validate_timex(txc);
1658 if (ret)
1659 return ret;
1660
cef90377
JS
1661 if (txc->modes & ADJ_SETOFFSET) {
1662 struct timespec delta;
1663 delta.tv_sec = txc->time.tv_sec;
1664 delta.tv_nsec = txc->time.tv_usec;
1665 if (!(txc->modes & ADJ_NANO))
1666 delta.tv_nsec *= 1000;
1667 ret = timekeeping_inject_offset(&delta);
1668 if (ret)
1669 return ret;
1670 }
1671
87ace39b 1672 getnstimeofday(&ts);
87ace39b 1673
06c017fd
JS
1674 raw_spin_lock_irqsave(&timekeeper_lock, flags);
1675 write_seqcount_begin(&timekeeper_seq);
1676
4e8f8b34 1677 orig_tai = tai = tk->tai_offset;
87ace39b 1678 ret = __do_adjtimex(txc, &ts, &tai);
aa6f9c59 1679
4e8f8b34
JS
1680 if (tai != orig_tai) {
1681 __timekeeping_set_tai_offset(tk, tai);
1682 clock_was_set_delayed();
1683 }
06c017fd
JS
1684 write_seqcount_end(&timekeeper_seq);
1685 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
1686
87ace39b
JS
1687 return ret;
1688}
aa6f9c59
JS
1689
1690#ifdef CONFIG_NTP_PPS
1691/**
1692 * hardpps() - Accessor function to NTP __hardpps function
1693 */
1694void hardpps(const struct timespec *phase_ts, const struct timespec *raw_ts)
1695{
06c017fd
JS
1696 unsigned long flags;
1697
1698 raw_spin_lock_irqsave(&timekeeper_lock, flags);
1699 write_seqcount_begin(&timekeeper_seq);
1700
aa6f9c59 1701 __hardpps(phase_ts, raw_ts);
06c017fd
JS
1702
1703 write_seqcount_end(&timekeeper_seq);
1704 raw_spin_unlock_irqrestore(&timekeeper_lock, flags);
aa6f9c59
JS
1705}
1706EXPORT_SYMBOL(hardpps);
1707#endif
1708
f0af911a
TH
1709/**
1710 * xtime_update() - advances the timekeeping infrastructure
1711 * @ticks: number of ticks, that have elapsed since the last call.
1712 *
1713 * Must be called with interrupts disabled.
1714 */
1715void xtime_update(unsigned long ticks)
1716{
d6ad4187 1717 write_seqlock(&jiffies_lock);
f0af911a 1718 do_timer(ticks);
d6ad4187 1719 write_sequnlock(&jiffies_lock);
f0af911a 1720}