2 * linux/kernel/time/timekeeping.c
4 * Kernel timekeeping code and accessor functions
6 * This code was moved from linux/kernel/timer.c.
7 * Please see that file for copyright and history logs.
11 #include <linux/timekeeper_internal.h>
12 #include <linux/module.h>
13 #include <linux/interrupt.h>
14 #include <linux/percpu.h>
15 #include <linux/init.h>
17 #include <linux/sched.h>
18 #include <linux/syscore_ops.h>
19 #include <linux/clocksource.h>
20 #include <linux/jiffies.h>
21 #include <linux/time.h>
22 #include <linux/tick.h>
23 #include <linux/stop_machine.h>
24 #include <linux/pvclock_gtod.h>
27 static struct timekeeper timekeeper;
29 /* flag for if timekeeping is suspended */
30 int __read_mostly timekeeping_suspended;
32 /* Flag for if there is a persistent clock on this platform */
33 bool __read_mostly persistent_clock_exist = false;
35 static inline void tk_normalize_xtime(struct timekeeper *tk)
37 while (tk->xtime_nsec >= ((u64)NSEC_PER_SEC << tk->shift)) {
38 tk->xtime_nsec -= (u64)NSEC_PER_SEC << tk->shift;
43 static void tk_set_xtime(struct timekeeper *tk, const struct timespec *ts)
45 tk->xtime_sec = ts->tv_sec;
46 tk->xtime_nsec = (u64)ts->tv_nsec << tk->shift;
49 static void tk_xtime_add(struct timekeeper *tk, const struct timespec *ts)
51 tk->xtime_sec += ts->tv_sec;
52 tk->xtime_nsec += (u64)ts->tv_nsec << tk->shift;
53 tk_normalize_xtime(tk);
56 static void tk_set_wall_to_mono(struct timekeeper *tk, struct timespec wtm)
61 * Verify consistency of: offset_real = -wall_to_monotonic
62 * before modifying anything
64 set_normalized_timespec(&tmp, -tk->wall_to_monotonic.tv_sec,
65 -tk->wall_to_monotonic.tv_nsec);
66 WARN_ON_ONCE(tk->offs_real.tv64 != timespec_to_ktime(tmp).tv64);
67 tk->wall_to_monotonic = wtm;
68 set_normalized_timespec(&tmp, -wtm.tv_sec, -wtm.tv_nsec);
69 tk->offs_real = timespec_to_ktime(tmp);
72 static void tk_set_sleep_time(struct timekeeper *tk, struct timespec t)
74 /* Verify consistency before modifying */
75 WARN_ON_ONCE(tk->offs_boot.tv64 != timespec_to_ktime(tk->total_sleep_time).tv64);
77 tk->total_sleep_time = t;
78 tk->offs_boot = timespec_to_ktime(t);
82 * timekeeper_setup_internals - Set up internals to use clocksource clock.
84 * @clock: Pointer to clocksource.
86 * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
87 * pair and interval request.
89 * Unless you're the timekeeping code, you should not be using this!
91 static void tk_setup_internals(struct timekeeper *tk, struct clocksource *clock)
95 struct clocksource *old_clock;
97 old_clock = tk->clock;
99 clock->cycle_last = clock->read(clock);
101 /* Do the ns -> cycle conversion first, using original mult */
102 tmp = NTP_INTERVAL_LENGTH;
103 tmp <<= clock->shift;
105 tmp += clock->mult/2;
106 do_div(tmp, clock->mult);
110 interval = (cycle_t) tmp;
111 tk->cycle_interval = interval;
113 /* Go back from cycles -> shifted ns */
114 tk->xtime_interval = (u64) interval * clock->mult;
115 tk->xtime_remainder = ntpinterval - tk->xtime_interval;
117 ((u64) interval * clock->mult) >> clock->shift;
119 /* if changing clocks, convert xtime_nsec shift units */
121 int shift_change = clock->shift - old_clock->shift;
122 if (shift_change < 0)
123 tk->xtime_nsec >>= -shift_change;
125 tk->xtime_nsec <<= shift_change;
127 tk->shift = clock->shift;
130 tk->ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
133 * The timekeeper keeps its own mult values for the currently
134 * active clocksource. These value will be adjusted via NTP
135 * to counteract clock drifting.
137 tk->mult = clock->mult;
140 /* Timekeeper helper functions. */
142 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
143 u32 (*arch_gettimeoffset)(void);
145 u32 get_arch_timeoffset(void)
147 if (likely(arch_gettimeoffset))
148 return arch_gettimeoffset();
152 static inline u32 get_arch_timeoffset(void) { return 0; }
155 static inline s64 timekeeping_get_ns(struct timekeeper *tk)
157 cycle_t cycle_now, cycle_delta;
158 struct clocksource *clock;
161 /* read clocksource: */
163 cycle_now = clock->read(clock);
165 /* calculate the delta since the last update_wall_time: */
166 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
168 nsec = cycle_delta * tk->mult + tk->xtime_nsec;
171 /* If arch requires, add in get_arch_timeoffset() */
172 return nsec + get_arch_timeoffset();
175 static inline s64 timekeeping_get_ns_raw(struct timekeeper *tk)
177 cycle_t cycle_now, cycle_delta;
178 struct clocksource *clock;
181 /* read clocksource: */
183 cycle_now = clock->read(clock);
185 /* calculate the delta since the last update_wall_time: */
186 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
188 /* convert delta to nanoseconds. */
189 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
191 /* If arch requires, add in get_arch_timeoffset() */
192 return nsec + get_arch_timeoffset();
195 static RAW_NOTIFIER_HEAD(pvclock_gtod_chain);
197 static void update_pvclock_gtod(struct timekeeper *tk)
199 raw_notifier_call_chain(&pvclock_gtod_chain, 0, tk);
203 * pvclock_gtod_register_notifier - register a pvclock timedata update listener
205 * Must hold write on timekeeper.lock
207 int pvclock_gtod_register_notifier(struct notifier_block *nb)
209 struct timekeeper *tk = &timekeeper;
213 write_seqlock_irqsave(&tk->lock, flags);
214 ret = raw_notifier_chain_register(&pvclock_gtod_chain, nb);
215 /* update timekeeping data */
216 update_pvclock_gtod(tk);
217 write_sequnlock_irqrestore(&tk->lock, flags);
221 EXPORT_SYMBOL_GPL(pvclock_gtod_register_notifier);
224 * pvclock_gtod_unregister_notifier - unregister a pvclock
225 * timedata update listener
227 * Must hold write on timekeeper.lock
229 int pvclock_gtod_unregister_notifier(struct notifier_block *nb)
231 struct timekeeper *tk = &timekeeper;
235 write_seqlock_irqsave(&tk->lock, flags);
236 ret = raw_notifier_chain_unregister(&pvclock_gtod_chain, nb);
237 write_sequnlock_irqrestore(&tk->lock, flags);
241 EXPORT_SYMBOL_GPL(pvclock_gtod_unregister_notifier);
243 /* must hold write on timekeeper.lock */
244 static void timekeeping_update(struct timekeeper *tk, bool clearntp)
251 update_pvclock_gtod(tk);
255 * timekeeping_forward_now - update clock to the current time
257 * Forward the current clock to update its state since the last call to
258 * update_wall_time(). This is useful before significant clock changes,
259 * as it avoids having to deal with this time offset explicitly.
261 static void timekeeping_forward_now(struct timekeeper *tk)
263 cycle_t cycle_now, cycle_delta;
264 struct clocksource *clock;
268 cycle_now = clock->read(clock);
269 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
270 clock->cycle_last = cycle_now;
272 tk->xtime_nsec += cycle_delta * tk->mult;
274 /* If arch requires, add in get_arch_timeoffset() */
275 tk->xtime_nsec += (u64)get_arch_timeoffset() << tk->shift;
277 tk_normalize_xtime(tk);
279 nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
280 timespec_add_ns(&tk->raw_time, nsec);
284 * __getnstimeofday - Returns the time of day in a timespec.
285 * @ts: pointer to the timespec to be set
287 * Updates the time of day in the timespec.
288 * Returns 0 on success, or -ve when suspended (timespec will be undefined).
290 int __getnstimeofday(struct timespec *ts)
292 struct timekeeper *tk = &timekeeper;
297 seq = read_seqbegin(&tk->lock);
299 ts->tv_sec = tk->xtime_sec;
300 nsecs = timekeeping_get_ns(tk);
302 } while (read_seqretry(&tk->lock, seq));
305 timespec_add_ns(ts, nsecs);
308 * Do not bail out early, in case there were callers still using
309 * the value, even in the face of the WARN_ON.
311 if (unlikely(timekeeping_suspended))
315 EXPORT_SYMBOL(__getnstimeofday);
318 * getnstimeofday - Returns the time of day in a timespec.
319 * @ts: pointer to the timespec to be set
321 * Returns the time of day in a timespec (WARN if suspended).
323 void getnstimeofday(struct timespec *ts)
325 WARN_ON(__getnstimeofday(ts));
327 EXPORT_SYMBOL(getnstimeofday);
329 ktime_t ktime_get(void)
331 struct timekeeper *tk = &timekeeper;
335 WARN_ON(timekeeping_suspended);
338 seq = read_seqbegin(&tk->lock);
339 secs = tk->xtime_sec + tk->wall_to_monotonic.tv_sec;
340 nsecs = timekeeping_get_ns(tk) + tk->wall_to_monotonic.tv_nsec;
342 } while (read_seqretry(&tk->lock, seq));
344 * Use ktime_set/ktime_add_ns to create a proper ktime on
345 * 32-bit architectures without CONFIG_KTIME_SCALAR.
347 return ktime_add_ns(ktime_set(secs, 0), nsecs);
349 EXPORT_SYMBOL_GPL(ktime_get);
352 * ktime_get_ts - get the monotonic clock in timespec format
353 * @ts: pointer to timespec variable
355 * The function calculates the monotonic clock from the realtime
356 * clock and the wall_to_monotonic offset and stores the result
357 * in normalized timespec format in the variable pointed to by @ts.
359 void ktime_get_ts(struct timespec *ts)
361 struct timekeeper *tk = &timekeeper;
362 struct timespec tomono;
366 WARN_ON(timekeeping_suspended);
369 seq = read_seqbegin(&tk->lock);
370 ts->tv_sec = tk->xtime_sec;
371 nsec = timekeeping_get_ns(tk);
372 tomono = tk->wall_to_monotonic;
374 } while (read_seqretry(&tk->lock, seq));
376 ts->tv_sec += tomono.tv_sec;
378 timespec_add_ns(ts, nsec + tomono.tv_nsec);
380 EXPORT_SYMBOL_GPL(ktime_get_ts);
384 * timekeeping_clocktai - Returns the TAI time of day in a timespec
385 * @ts: pointer to the timespec to be set
387 * Returns the time of day in a timespec.
389 void timekeeping_clocktai(struct timespec *ts)
391 struct timekeeper *tk = &timekeeper;
395 WARN_ON(timekeeping_suspended);
398 seq = read_seqbegin(&tk->lock);
400 ts->tv_sec = tk->xtime_sec + tk->tai_offset;
401 nsecs = timekeeping_get_ns(tk);
403 } while (read_seqretry(&tk->lock, seq));
406 timespec_add_ns(ts, nsecs);
409 EXPORT_SYMBOL(timekeeping_clocktai);
412 #ifdef CONFIG_NTP_PPS
415 * getnstime_raw_and_real - get day and raw monotonic time in timespec format
416 * @ts_raw: pointer to the timespec to be set to raw monotonic time
417 * @ts_real: pointer to the timespec to be set to the time of day
419 * This function reads both the time of day and raw monotonic time at the
420 * same time atomically and stores the resulting timestamps in timespec
423 void getnstime_raw_and_real(struct timespec *ts_raw, struct timespec *ts_real)
425 struct timekeeper *tk = &timekeeper;
427 s64 nsecs_raw, nsecs_real;
429 WARN_ON_ONCE(timekeeping_suspended);
432 seq = read_seqbegin(&tk->lock);
434 *ts_raw = tk->raw_time;
435 ts_real->tv_sec = tk->xtime_sec;
436 ts_real->tv_nsec = 0;
438 nsecs_raw = timekeeping_get_ns_raw(tk);
439 nsecs_real = timekeeping_get_ns(tk);
441 } while (read_seqretry(&tk->lock, seq));
443 timespec_add_ns(ts_raw, nsecs_raw);
444 timespec_add_ns(ts_real, nsecs_real);
446 EXPORT_SYMBOL(getnstime_raw_and_real);
448 #endif /* CONFIG_NTP_PPS */
451 * do_gettimeofday - Returns the time of day in a timeval
452 * @tv: pointer to the timeval to be set
454 * NOTE: Users should be converted to using getnstimeofday()
456 void do_gettimeofday(struct timeval *tv)
460 getnstimeofday(&now);
461 tv->tv_sec = now.tv_sec;
462 tv->tv_usec = now.tv_nsec/1000;
464 EXPORT_SYMBOL(do_gettimeofday);
467 * do_settimeofday - Sets the time of day
468 * @tv: pointer to the timespec variable containing the new time
470 * Sets the time of day to the new time and update NTP and notify hrtimers
472 int do_settimeofday(const struct timespec *tv)
474 struct timekeeper *tk = &timekeeper;
475 struct timespec ts_delta, xt;
478 if (!timespec_valid_strict(tv))
481 write_seqlock_irqsave(&tk->lock, flags);
483 timekeeping_forward_now(tk);
486 ts_delta.tv_sec = tv->tv_sec - xt.tv_sec;
487 ts_delta.tv_nsec = tv->tv_nsec - xt.tv_nsec;
489 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, ts_delta));
491 tk_set_xtime(tk, tv);
493 timekeeping_update(tk, true);
495 write_sequnlock_irqrestore(&tk->lock, flags);
497 /* signal hrtimers about time change */
502 EXPORT_SYMBOL(do_settimeofday);
505 * timekeeping_inject_offset - Adds or subtracts from the current time.
506 * @tv: pointer to the timespec variable containing the offset
508 * Adds or subtracts an offset value from the current time.
510 int timekeeping_inject_offset(struct timespec *ts)
512 struct timekeeper *tk = &timekeeper;
517 if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
520 write_seqlock_irqsave(&tk->lock, flags);
522 timekeeping_forward_now(tk);
524 /* Make sure the proposed value is valid */
525 tmp = timespec_add(tk_xtime(tk), *ts);
526 if (!timespec_valid_strict(&tmp)) {
531 tk_xtime_add(tk, ts);
532 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, *ts));
534 error: /* even if we error out, we forwarded the time, so call update */
535 timekeeping_update(tk, true);
537 write_sequnlock_irqrestore(&tk->lock, flags);
539 /* signal hrtimers about time change */
544 EXPORT_SYMBOL(timekeeping_inject_offset);
548 * timekeeping_get_tai_offset - Returns current TAI offset from UTC
551 s32 timekeeping_get_tai_offset(void)
553 struct timekeeper *tk = &timekeeper;
558 seq = read_seqbegin(&tk->lock);
559 ret = tk->tai_offset;
560 } while (read_seqretry(&tk->lock, seq));
566 * __timekeeping_set_tai_offset - Lock free worker function
569 void __timekeeping_set_tai_offset(struct timekeeper *tk, s32 tai_offset)
571 tk->tai_offset = tai_offset;
575 * timekeeping_set_tai_offset - Sets the current TAI offset from UTC
578 void timekeeping_set_tai_offset(s32 tai_offset)
580 struct timekeeper *tk = &timekeeper;
583 write_seqlock_irqsave(&tk->lock, flags);
584 __timekeeping_set_tai_offset(tk, tai_offset);
585 write_sequnlock_irqrestore(&tk->lock, flags);
589 * change_clocksource - Swaps clocksources if a new one is available
591 * Accumulates current time interval and initializes new clocksource
593 static int change_clocksource(void *data)
595 struct timekeeper *tk = &timekeeper;
596 struct clocksource *new, *old;
599 new = (struct clocksource *) data;
601 write_seqlock_irqsave(&tk->lock, flags);
603 timekeeping_forward_now(tk);
604 if (!new->enable || new->enable(new) == 0) {
606 tk_setup_internals(tk, new);
610 timekeeping_update(tk, true);
612 write_sequnlock_irqrestore(&tk->lock, flags);
618 * timekeeping_notify - Install a new clock source
619 * @clock: pointer to the clock source
621 * This function is called from clocksource.c after a new, better clock
622 * source has been registered. The caller holds the clocksource_mutex.
624 void timekeeping_notify(struct clocksource *clock)
626 struct timekeeper *tk = &timekeeper;
628 if (tk->clock == clock)
630 stop_machine(change_clocksource, clock, NULL);
635 * ktime_get_real - get the real (wall-) time in ktime_t format
637 * returns the time in ktime_t format
639 ktime_t ktime_get_real(void)
643 getnstimeofday(&now);
645 return timespec_to_ktime(now);
647 EXPORT_SYMBOL_GPL(ktime_get_real);
650 * getrawmonotonic - Returns the raw monotonic time in a timespec
651 * @ts: pointer to the timespec to be set
653 * Returns the raw monotonic time (completely un-modified by ntp)
655 void getrawmonotonic(struct timespec *ts)
657 struct timekeeper *tk = &timekeeper;
662 seq = read_seqbegin(&tk->lock);
663 nsecs = timekeeping_get_ns_raw(tk);
666 } while (read_seqretry(&tk->lock, seq));
668 timespec_add_ns(ts, nsecs);
670 EXPORT_SYMBOL(getrawmonotonic);
673 * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
675 int timekeeping_valid_for_hres(void)
677 struct timekeeper *tk = &timekeeper;
682 seq = read_seqbegin(&tk->lock);
684 ret = tk->clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
686 } while (read_seqretry(&tk->lock, seq));
692 * timekeeping_max_deferment - Returns max time the clocksource can be deferred
694 u64 timekeeping_max_deferment(void)
696 struct timekeeper *tk = &timekeeper;
701 seq = read_seqbegin(&tk->lock);
703 ret = tk->clock->max_idle_ns;
705 } while (read_seqretry(&tk->lock, seq));
711 * read_persistent_clock - Return time from the persistent clock.
713 * Weak dummy function for arches that do not yet support it.
714 * Reads the time from the battery backed persistent clock.
715 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
717 * XXX - Do be sure to remove it once all arches implement it.
719 void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
726 * read_boot_clock - Return time of the system start.
728 * Weak dummy function for arches that do not yet support it.
729 * Function to read the exact time the system has been started.
730 * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
732 * XXX - Do be sure to remove it once all arches implement it.
734 void __attribute__((weak)) read_boot_clock(struct timespec *ts)
741 * timekeeping_init - Initializes the clocksource and common timekeeping values
743 void __init timekeeping_init(void)
745 struct timekeeper *tk = &timekeeper;
746 struct clocksource *clock;
748 struct timespec now, boot, tmp;
750 read_persistent_clock(&now);
752 if (!timespec_valid_strict(&now)) {
753 pr_warn("WARNING: Persistent clock returned invalid value!\n"
754 " Check your CMOS/BIOS settings.\n");
757 } else if (now.tv_sec || now.tv_nsec)
758 persistent_clock_exist = true;
760 read_boot_clock(&boot);
761 if (!timespec_valid_strict(&boot)) {
762 pr_warn("WARNING: Boot clock returned invalid value!\n"
763 " Check your CMOS/BIOS settings.\n");
768 seqlock_init(&tk->lock);
772 write_seqlock_irqsave(&tk->lock, flags);
773 clock = clocksource_default_clock();
775 clock->enable(clock);
776 tk_setup_internals(tk, clock);
778 tk_set_xtime(tk, &now);
779 tk->raw_time.tv_sec = 0;
780 tk->raw_time.tv_nsec = 0;
781 if (boot.tv_sec == 0 && boot.tv_nsec == 0)
784 set_normalized_timespec(&tmp, -boot.tv_sec, -boot.tv_nsec);
785 tk_set_wall_to_mono(tk, tmp);
789 tk_set_sleep_time(tk, tmp);
791 write_sequnlock_irqrestore(&tk->lock, flags);
794 /* time in seconds when suspend began */
795 static struct timespec timekeeping_suspend_time;
798 * __timekeeping_inject_sleeptime - Internal function to add sleep interval
799 * @delta: pointer to a timespec delta value
801 * Takes a timespec offset measuring a suspend interval and properly
802 * adds the sleep offset to the timekeeping variables.
804 static void __timekeeping_inject_sleeptime(struct timekeeper *tk,
805 struct timespec *delta)
807 if (!timespec_valid_strict(delta)) {
808 printk(KERN_WARNING "__timekeeping_inject_sleeptime: Invalid "
809 "sleep delta value!\n");
812 tk_xtime_add(tk, delta);
813 tk_set_wall_to_mono(tk, timespec_sub(tk->wall_to_monotonic, *delta));
814 tk_set_sleep_time(tk, timespec_add(tk->total_sleep_time, *delta));
818 * timekeeping_inject_sleeptime - Adds suspend interval to timeekeeping values
819 * @delta: pointer to a timespec delta value
821 * This hook is for architectures that cannot support read_persistent_clock
822 * because their RTC/persistent clock is only accessible when irqs are enabled.
824 * This function should only be called by rtc_resume(), and allows
825 * a suspend offset to be injected into the timekeeping values.
827 void timekeeping_inject_sleeptime(struct timespec *delta)
829 struct timekeeper *tk = &timekeeper;
833 * Make sure we don't set the clock twice, as timekeeping_resume()
836 if (has_persistent_clock())
839 write_seqlock_irqsave(&tk->lock, flags);
841 timekeeping_forward_now(tk);
843 __timekeeping_inject_sleeptime(tk, delta);
845 timekeeping_update(tk, true);
847 write_sequnlock_irqrestore(&tk->lock, flags);
849 /* signal hrtimers about time change */
854 * timekeeping_resume - Resumes the generic timekeeping subsystem.
856 * This is for the generic clocksource timekeeping.
857 * xtime/wall_to_monotonic/jiffies/etc are
858 * still managed by arch specific suspend/resume code.
860 static void timekeeping_resume(void)
862 struct timekeeper *tk = &timekeeper;
863 struct clocksource *clock = tk->clock;
865 struct timespec ts_new, ts_delta;
866 cycle_t cycle_now, cycle_delta;
867 bool suspendtime_found = false;
869 read_persistent_clock(&ts_new);
871 clockevents_resume();
872 clocksource_resume();
874 write_seqlock_irqsave(&tk->lock, flags);
877 * After system resumes, we need to calculate the suspended time and
878 * compensate it for the OS time. There are 3 sources that could be
879 * used: Nonstop clocksource during suspend, persistent clock and rtc
882 * One specific platform may have 1 or 2 or all of them, and the
883 * preference will be:
884 * suspend-nonstop clocksource -> persistent clock -> rtc
885 * The less preferred source will only be tried if there is no better
886 * usable source. The rtc part is handled separately in rtc core code.
888 cycle_now = clock->read(clock);
889 if ((clock->flags & CLOCK_SOURCE_SUSPEND_NONSTOP) &&
890 cycle_now > clock->cycle_last) {
891 u64 num, max = ULLONG_MAX;
892 u32 mult = clock->mult;
893 u32 shift = clock->shift;
896 cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
899 * "cycle_delta * mutl" may cause 64 bits overflow, if the
900 * suspended time is too long. In that case we need do the
901 * 64 bits math carefully
904 if (cycle_delta > max) {
905 num = div64_u64(cycle_delta, max);
906 nsec = (((u64) max * mult) >> shift) * num;
907 cycle_delta -= num * max;
909 nsec += ((u64) cycle_delta * mult) >> shift;
911 ts_delta = ns_to_timespec(nsec);
912 suspendtime_found = true;
913 } else if (timespec_compare(&ts_new, &timekeeping_suspend_time) > 0) {
914 ts_delta = timespec_sub(ts_new, timekeeping_suspend_time);
915 suspendtime_found = true;
918 if (suspendtime_found)
919 __timekeeping_inject_sleeptime(tk, &ts_delta);
921 /* Re-base the last cycle value */
922 clock->cycle_last = cycle_now;
924 timekeeping_suspended = 0;
925 timekeeping_update(tk, false);
926 write_sequnlock_irqrestore(&tk->lock, flags);
928 touch_softlockup_watchdog();
930 clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
932 /* Resume hrtimers */
936 static int timekeeping_suspend(void)
938 struct timekeeper *tk = &timekeeper;
940 struct timespec delta, delta_delta;
941 static struct timespec old_delta;
943 read_persistent_clock(&timekeeping_suspend_time);
945 write_seqlock_irqsave(&tk->lock, flags);
946 timekeeping_forward_now(tk);
947 timekeeping_suspended = 1;
950 * To avoid drift caused by repeated suspend/resumes,
951 * which each can add ~1 second drift error,
952 * try to compensate so the difference in system time
953 * and persistent_clock time stays close to constant.
955 delta = timespec_sub(tk_xtime(tk), timekeeping_suspend_time);
956 delta_delta = timespec_sub(delta, old_delta);
957 if (abs(delta_delta.tv_sec) >= 2) {
959 * if delta_delta is too large, assume time correction
960 * has occured and set old_delta to the current delta.
964 /* Otherwise try to adjust old_system to compensate */
965 timekeeping_suspend_time =
966 timespec_add(timekeeping_suspend_time, delta_delta);
968 write_sequnlock_irqrestore(&tk->lock, flags);
970 clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
971 clocksource_suspend();
972 clockevents_suspend();
977 /* sysfs resume/suspend bits for timekeeping */
978 static struct syscore_ops timekeeping_syscore_ops = {
979 .resume = timekeeping_resume,
980 .suspend = timekeeping_suspend,
983 static int __init timekeeping_init_ops(void)
985 register_syscore_ops(&timekeeping_syscore_ops);
989 device_initcall(timekeeping_init_ops);
992 * If the error is already larger, we look ahead even further
993 * to compensate for late or lost adjustments.
995 static __always_inline int timekeeping_bigadjust(struct timekeeper *tk,
996 s64 error, s64 *interval,
1000 u32 look_ahead, adj;
1004 * Use the current error value to determine how much to look ahead.
1005 * The larger the error the slower we adjust for it to avoid problems
1006 * with losing too many ticks, otherwise we would overadjust and
1007 * produce an even larger error. The smaller the adjustment the
1008 * faster we try to adjust for it, as lost ticks can do less harm
1009 * here. This is tuned so that an error of about 1 msec is adjusted
1010 * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
1012 error2 = tk->ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
1013 error2 = abs(error2);
1014 for (look_ahead = 0; error2 > 0; look_ahead++)
1018 * Now calculate the error in (1 << look_ahead) ticks, but first
1019 * remove the single look ahead already included in the error.
1021 tick_error = ntp_tick_length() >> (tk->ntp_error_shift + 1);
1022 tick_error -= tk->xtime_interval >> 1;
1023 error = ((error - tick_error) >> look_ahead) + tick_error;
1025 /* Finally calculate the adjustment shift value. */
1030 *interval = -*interval;
1034 for (adj = 0; error > i; adj++)
1043 * Adjust the multiplier to reduce the error value,
1044 * this is optimized for the most common adjustments of -1,0,1,
1045 * for other values we can do a bit more work.
1047 static void timekeeping_adjust(struct timekeeper *tk, s64 offset)
1049 s64 error, interval = tk->cycle_interval;
1053 * The point of this is to check if the error is greater than half
1056 * First we shift it down from NTP_SHIFT to clocksource->shifted nsecs.
1058 * Note we subtract one in the shift, so that error is really error*2.
1059 * This "saves" dividing(shifting) interval twice, but keeps the
1060 * (error > interval) comparison as still measuring if error is
1061 * larger than half an interval.
1063 * Note: It does not "save" on aggravation when reading the code.
1065 error = tk->ntp_error >> (tk->ntp_error_shift - 1);
1066 if (error > interval) {
1068 * We now divide error by 4(via shift), which checks if
1069 * the error is greater than twice the interval.
1070 * If it is greater, we need a bigadjust, if its smaller,
1071 * we can adjust by 1.
1075 * XXX - In update_wall_time, we round up to the next
1076 * nanosecond, and store the amount rounded up into
1077 * the error. This causes the likely below to be unlikely.
1079 * The proper fix is to avoid rounding up by using
1080 * the high precision tk->xtime_nsec instead of
1081 * xtime.tv_nsec everywhere. Fixing this will take some
1084 if (likely(error <= interval))
1087 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1089 if (error < -interval) {
1090 /* See comment above, this is just switched for the negative */
1092 if (likely(error >= -interval)) {
1094 interval = -interval;
1097 adj = timekeeping_bigadjust(tk, error, &interval, &offset);
1104 if (unlikely(tk->clock->maxadj &&
1105 (tk->mult + adj > tk->clock->mult + tk->clock->maxadj))) {
1106 printk_once(KERN_WARNING
1107 "Adjusting %s more than 11%% (%ld vs %ld)\n",
1108 tk->clock->name, (long)tk->mult + adj,
1109 (long)tk->clock->mult + tk->clock->maxadj);
1112 * So the following can be confusing.
1114 * To keep things simple, lets assume adj == 1 for now.
1116 * When adj != 1, remember that the interval and offset values
1117 * have been appropriately scaled so the math is the same.
1119 * The basic idea here is that we're increasing the multiplier
1120 * by one, this causes the xtime_interval to be incremented by
1121 * one cycle_interval. This is because:
1122 * xtime_interval = cycle_interval * mult
1123 * So if mult is being incremented by one:
1124 * xtime_interval = cycle_interval * (mult + 1)
1126 * xtime_interval = (cycle_interval * mult) + cycle_interval
1127 * Which can be shortened to:
1128 * xtime_interval += cycle_interval
1130 * So offset stores the non-accumulated cycles. Thus the current
1131 * time (in shifted nanoseconds) is:
1132 * now = (offset * adj) + xtime_nsec
1133 * Now, even though we're adjusting the clock frequency, we have
1134 * to keep time consistent. In other words, we can't jump back
1135 * in time, and we also want to avoid jumping forward in time.
1137 * So given the same offset value, we need the time to be the same
1138 * both before and after the freq adjustment.
1139 * now = (offset * adj_1) + xtime_nsec_1
1140 * now = (offset * adj_2) + xtime_nsec_2
1142 * (offset * adj_1) + xtime_nsec_1 =
1143 * (offset * adj_2) + xtime_nsec_2
1147 * (offset * adj_1) + xtime_nsec_1 =
1148 * (offset * (adj_1+1)) + xtime_nsec_2
1149 * (offset * adj_1) + xtime_nsec_1 =
1150 * (offset * adj_1) + offset + xtime_nsec_2
1151 * Canceling the sides:
1152 * xtime_nsec_1 = offset + xtime_nsec_2
1154 * xtime_nsec_2 = xtime_nsec_1 - offset
1155 * Which simplfies to:
1156 * xtime_nsec -= offset
1158 * XXX - TODO: Doc ntp_error calculation.
1161 tk->xtime_interval += interval;
1162 tk->xtime_nsec -= offset;
1163 tk->ntp_error -= (interval - offset) << tk->ntp_error_shift;
1167 * It may be possible that when we entered this function, xtime_nsec
1168 * was very small. Further, if we're slightly speeding the clocksource
1169 * in the code above, its possible the required corrective factor to
1170 * xtime_nsec could cause it to underflow.
1172 * Now, since we already accumulated the second, cannot simply roll
1173 * the accumulated second back, since the NTP subsystem has been
1174 * notified via second_overflow. So instead we push xtime_nsec forward
1175 * by the amount we underflowed, and add that amount into the error.
1177 * We'll correct this error next time through this function, when
1178 * xtime_nsec is not as small.
1180 if (unlikely((s64)tk->xtime_nsec < 0)) {
1181 s64 neg = -(s64)tk->xtime_nsec;
1183 tk->ntp_error += neg << tk->ntp_error_shift;
1189 * accumulate_nsecs_to_secs - Accumulates nsecs into secs
1191 * Helper function that accumulates a the nsecs greater then a second
1192 * from the xtime_nsec field to the xtime_secs field.
1193 * It also calls into the NTP code to handle leapsecond processing.
1196 static inline void accumulate_nsecs_to_secs(struct timekeeper *tk)
1198 u64 nsecps = (u64)NSEC_PER_SEC << tk->shift;
1200 while (tk->xtime_nsec >= nsecps) {
1203 tk->xtime_nsec -= nsecps;
1206 /* Figure out if its a leap sec and apply if needed */
1207 leap = second_overflow(tk->xtime_sec);
1208 if (unlikely(leap)) {
1211 tk->xtime_sec += leap;
1215 tk_set_wall_to_mono(tk,
1216 timespec_sub(tk->wall_to_monotonic, ts));
1218 __timekeeping_set_tai_offset(tk, tk->tai_offset - leap);
1220 clock_was_set_delayed();
1226 * logarithmic_accumulation - shifted accumulation of cycles
1228 * This functions accumulates a shifted interval of cycles into
1229 * into a shifted interval nanoseconds. Allows for O(log) accumulation
1232 * Returns the unconsumed cycles.
1234 static cycle_t logarithmic_accumulation(struct timekeeper *tk, cycle_t offset,
1239 /* If the offset is smaller then a shifted interval, do nothing */
1240 if (offset < tk->cycle_interval<<shift)
1243 /* Accumulate one shifted interval */
1244 offset -= tk->cycle_interval << shift;
1245 tk->clock->cycle_last += tk->cycle_interval << shift;
1247 tk->xtime_nsec += tk->xtime_interval << shift;
1248 accumulate_nsecs_to_secs(tk);
1250 /* Accumulate raw time */
1251 raw_nsecs = (u64)tk->raw_interval << shift;
1252 raw_nsecs += tk->raw_time.tv_nsec;
1253 if (raw_nsecs >= NSEC_PER_SEC) {
1254 u64 raw_secs = raw_nsecs;
1255 raw_nsecs = do_div(raw_secs, NSEC_PER_SEC);
1256 tk->raw_time.tv_sec += raw_secs;
1258 tk->raw_time.tv_nsec = raw_nsecs;
1260 /* Accumulate error between NTP and clock interval */
1261 tk->ntp_error += ntp_tick_length() << shift;
1262 tk->ntp_error -= (tk->xtime_interval + tk->xtime_remainder) <<
1263 (tk->ntp_error_shift + shift);
1268 #ifdef CONFIG_GENERIC_TIME_VSYSCALL_OLD
1269 static inline void old_vsyscall_fixup(struct timekeeper *tk)
1274 * Store only full nanoseconds into xtime_nsec after rounding
1275 * it up and add the remainder to the error difference.
1276 * XXX - This is necessary to avoid small 1ns inconsistnecies caused
1277 * by truncating the remainder in vsyscalls. However, it causes
1278 * additional work to be done in timekeeping_adjust(). Once
1279 * the vsyscall implementations are converted to use xtime_nsec
1280 * (shifted nanoseconds), and CONFIG_GENERIC_TIME_VSYSCALL_OLD
1281 * users are removed, this can be killed.
1283 remainder = tk->xtime_nsec & ((1ULL << tk->shift) - 1);
1284 tk->xtime_nsec -= remainder;
1285 tk->xtime_nsec += 1ULL << tk->shift;
1286 tk->ntp_error += remainder << tk->ntp_error_shift;
1290 #define old_vsyscall_fixup(tk)
1296 * update_wall_time - Uses the current clocksource to increment the wall time
1299 static void update_wall_time(void)
1301 struct clocksource *clock;
1302 struct timekeeper *tk = &timekeeper;
1304 int shift = 0, maxshift;
1305 unsigned long flags;
1307 write_seqlock_irqsave(&tk->lock, flags);
1309 /* Make sure we're fully resumed: */
1310 if (unlikely(timekeeping_suspended))
1315 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
1316 offset = tk->cycle_interval;
1318 offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
1321 /* Check if there's really nothing to do */
1322 if (offset < tk->cycle_interval)
1326 * With NO_HZ we may have to accumulate many cycle_intervals
1327 * (think "ticks") worth of time at once. To do this efficiently,
1328 * we calculate the largest doubling multiple of cycle_intervals
1329 * that is smaller than the offset. We then accumulate that
1330 * chunk in one go, and then try to consume the next smaller
1333 shift = ilog2(offset) - ilog2(tk->cycle_interval);
1334 shift = max(0, shift);
1335 /* Bound shift to one less than what overflows tick_length */
1336 maxshift = (64 - (ilog2(ntp_tick_length())+1)) - 1;
1337 shift = min(shift, maxshift);
1338 while (offset >= tk->cycle_interval) {
1339 offset = logarithmic_accumulation(tk, offset, shift);
1340 if (offset < tk->cycle_interval<<shift)
1344 /* correct the clock when NTP error is too big */
1345 timekeeping_adjust(tk, offset);
1348 * XXX This can be killed once everyone converts
1349 * to the new update_vsyscall.
1351 old_vsyscall_fixup(tk);
1354 * Finally, make sure that after the rounding
1355 * xtime_nsec isn't larger than NSEC_PER_SEC
1357 accumulate_nsecs_to_secs(tk);
1359 timekeeping_update(tk, false);
1362 write_sequnlock_irqrestore(&tk->lock, flags);
1367 * getboottime - Return the real time of system boot.
1368 * @ts: pointer to the timespec to be set
1370 * Returns the wall-time of boot in a timespec.
1372 * This is based on the wall_to_monotonic offset and the total suspend
1373 * time. Calls to settimeofday will affect the value returned (which
1374 * basically means that however wrong your real time clock is at boot time,
1375 * you get the right time here).
1377 void getboottime(struct timespec *ts)
1379 struct timekeeper *tk = &timekeeper;
1380 struct timespec boottime = {
1381 .tv_sec = tk->wall_to_monotonic.tv_sec +
1382 tk->total_sleep_time.tv_sec,
1383 .tv_nsec = tk->wall_to_monotonic.tv_nsec +
1384 tk->total_sleep_time.tv_nsec
1387 set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
1389 EXPORT_SYMBOL_GPL(getboottime);
1392 * get_monotonic_boottime - Returns monotonic time since boot
1393 * @ts: pointer to the timespec to be set
1395 * Returns the monotonic time since boot in a timespec.
1397 * This is similar to CLOCK_MONTONIC/ktime_get_ts, but also
1398 * includes the time spent in suspend.
1400 void get_monotonic_boottime(struct timespec *ts)
1402 struct timekeeper *tk = &timekeeper;
1403 struct timespec tomono, sleep;
1407 WARN_ON(timekeeping_suspended);
1410 seq = read_seqbegin(&tk->lock);
1411 ts->tv_sec = tk->xtime_sec;
1412 nsec = timekeeping_get_ns(tk);
1413 tomono = tk->wall_to_monotonic;
1414 sleep = tk->total_sleep_time;
1416 } while (read_seqretry(&tk->lock, seq));
1418 ts->tv_sec += tomono.tv_sec + sleep.tv_sec;
1420 timespec_add_ns(ts, nsec + tomono.tv_nsec + sleep.tv_nsec);
1422 EXPORT_SYMBOL_GPL(get_monotonic_boottime);
1425 * ktime_get_boottime - Returns monotonic time since boot in a ktime
1427 * Returns the monotonic time since boot in a ktime
1429 * This is similar to CLOCK_MONTONIC/ktime_get, but also
1430 * includes the time spent in suspend.
1432 ktime_t ktime_get_boottime(void)
1436 get_monotonic_boottime(&ts);
1437 return timespec_to_ktime(ts);
1439 EXPORT_SYMBOL_GPL(ktime_get_boottime);
1442 * monotonic_to_bootbased - Convert the monotonic time to boot based.
1443 * @ts: pointer to the timespec to be converted
1445 void monotonic_to_bootbased(struct timespec *ts)
1447 struct timekeeper *tk = &timekeeper;
1449 *ts = timespec_add(*ts, tk->total_sleep_time);
1451 EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
1453 unsigned long get_seconds(void)
1455 struct timekeeper *tk = &timekeeper;
1457 return tk->xtime_sec;
1459 EXPORT_SYMBOL(get_seconds);
1461 struct timespec __current_kernel_time(void)
1463 struct timekeeper *tk = &timekeeper;
1465 return tk_xtime(tk);
1468 struct timespec current_kernel_time(void)
1470 struct timekeeper *tk = &timekeeper;
1471 struct timespec now;
1475 seq = read_seqbegin(&tk->lock);
1478 } while (read_seqretry(&tk->lock, seq));
1482 EXPORT_SYMBOL(current_kernel_time);
1484 struct timespec get_monotonic_coarse(void)
1486 struct timekeeper *tk = &timekeeper;
1487 struct timespec now, mono;
1491 seq = read_seqbegin(&tk->lock);
1494 mono = tk->wall_to_monotonic;
1495 } while (read_seqretry(&tk->lock, seq));
1497 set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
1498 now.tv_nsec + mono.tv_nsec);
1503 * Must hold jiffies_lock
1505 void do_timer(unsigned long ticks)
1507 jiffies_64 += ticks;
1509 calc_global_load(ticks);
1513 * get_xtime_and_monotonic_and_sleep_offset() - get xtime, wall_to_monotonic,
1514 * and sleep offsets.
1515 * @xtim: pointer to timespec to be set with xtime
1516 * @wtom: pointer to timespec to be set with wall_to_monotonic
1517 * @sleep: pointer to timespec to be set with time in suspend
1519 void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
1520 struct timespec *wtom, struct timespec *sleep)
1522 struct timekeeper *tk = &timekeeper;
1526 seq = read_seqbegin(&tk->lock);
1527 *xtim = tk_xtime(tk);
1528 *wtom = tk->wall_to_monotonic;
1529 *sleep = tk->total_sleep_time;
1530 } while (read_seqretry(&tk->lock, seq));
1533 #ifdef CONFIG_HIGH_RES_TIMERS
1535 * ktime_get_update_offsets - hrtimer helper
1536 * @offs_real: pointer to storage for monotonic -> realtime offset
1537 * @offs_boot: pointer to storage for monotonic -> boottime offset
1539 * Returns current monotonic time and updates the offsets
1540 * Called from hrtimer_interupt() or retrigger_next_event()
1542 ktime_t ktime_get_update_offsets(ktime_t *offs_real, ktime_t *offs_boot)
1544 struct timekeeper *tk = &timekeeper;
1550 seq = read_seqbegin(&tk->lock);
1552 secs = tk->xtime_sec;
1553 nsecs = timekeeping_get_ns(tk);
1555 *offs_real = tk->offs_real;
1556 *offs_boot = tk->offs_boot;
1557 } while (read_seqretry(&tk->lock, seq));
1559 now = ktime_add_ns(ktime_set(secs, 0), nsecs);
1560 now = ktime_sub(now, *offs_real);
1566 * ktime_get_monotonic_offset() - get wall_to_monotonic in ktime_t format
1568 ktime_t ktime_get_monotonic_offset(void)
1570 struct timekeeper *tk = &timekeeper;
1572 struct timespec wtom;
1575 seq = read_seqbegin(&tk->lock);
1576 wtom = tk->wall_to_monotonic;
1577 } while (read_seqretry(&tk->lock, seq));
1579 return timespec_to_ktime(wtom);
1581 EXPORT_SYMBOL_GPL(ktime_get_monotonic_offset);
1584 * xtime_update() - advances the timekeeping infrastructure
1585 * @ticks: number of ticks, that have elapsed since the last call.
1587 * Must be called with interrupts disabled.
1589 void xtime_update(unsigned long ticks)
1591 write_seqlock(&jiffies_lock);
1593 write_sequnlock(&jiffies_lock);