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