workqueue: CPU hotplug keep idle workers
[linux-2.6.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/module.h>
12 #include <linux/interrupt.h>
13 #include <linux/percpu.h>
14 #include <linux/init.h>
15 #include <linux/mm.h>
16 #include <linux/sched.h>
17 #include <linux/syscore_ops.h>
18 #include <linux/clocksource.h>
19 #include <linux/jiffies.h>
20 #include <linux/time.h>
21 #include <linux/tick.h>
22 #include <linux/stop_machine.h>
23
24 /* Structure holding internal timekeeping values. */
25 struct timekeeper {
26         /* Current clocksource used for timekeeping. */
27         struct clocksource *clock;
28         /* NTP adjusted clock multiplier */
29         u32     mult;
30         /* The shift value of the current clocksource. */
31         int     shift;
32
33         /* Number of clock cycles in one NTP interval. */
34         cycle_t cycle_interval;
35         /* Number of clock shifted nano seconds in one NTP interval. */
36         u64     xtime_interval;
37         /* shifted nano seconds left over when rounding cycle_interval */
38         s64     xtime_remainder;
39         /* Raw nano seconds accumulated per NTP interval. */
40         u32     raw_interval;
41
42         /* Clock shifted nano seconds remainder not stored in xtime.tv_nsec. */
43         u64     xtime_nsec;
44         /* Difference between accumulated time and NTP time in ntp
45          * shifted nano seconds. */
46         s64     ntp_error;
47         /* Shift conversion between clock shifted nano seconds and
48          * ntp shifted nano seconds. */
49         int     ntp_error_shift;
50
51         /* The current time */
52         struct timespec xtime;
53         /*
54          * wall_to_monotonic is what we need to add to xtime (or xtime corrected
55          * for sub jiffie times) to get to monotonic time.  Monotonic is pegged
56          * at zero at system boot time, so wall_to_monotonic will be negative,
57          * however, we will ALWAYS keep the tv_nsec part positive so we can use
58          * the usual normalization.
59          *
60          * wall_to_monotonic is moved after resume from suspend for the
61          * monotonic time not to jump. We need to add total_sleep_time to
62          * wall_to_monotonic to get the real boot based time offset.
63          *
64          * - wall_to_monotonic is no longer the boot time, getboottime must be
65          * used instead.
66          */
67         struct timespec wall_to_monotonic;
68         /* time spent in suspend */
69         struct timespec total_sleep_time;
70         /* The raw monotonic time for the CLOCK_MONOTONIC_RAW posix clock. */
71         struct timespec raw_time;
72
73         /* Offset clock monotonic -> clock realtime */
74         ktime_t offs_real;
75
76         /* Offset clock monotonic -> clock boottime */
77         ktime_t offs_boot;
78
79         /* Seqlock for all timekeeper values */
80         seqlock_t lock;
81 };
82
83 static struct timekeeper timekeeper;
84
85 /*
86  * This read-write spinlock protects us from races in SMP while
87  * playing with xtime.
88  */
89 __cacheline_aligned_in_smp DEFINE_SEQLOCK(xtime_lock);
90
91
92 /* flag for if timekeeping is suspended */
93 int __read_mostly timekeeping_suspended;
94
95
96
97 /**
98  * timekeeper_setup_internals - Set up internals to use clocksource clock.
99  *
100  * @clock:              Pointer to clocksource.
101  *
102  * Calculates a fixed cycle/nsec interval for a given clocksource/adjustment
103  * pair and interval request.
104  *
105  * Unless you're the timekeeping code, you should not be using this!
106  */
107 static void timekeeper_setup_internals(struct clocksource *clock)
108 {
109         cycle_t interval;
110         u64 tmp, ntpinterval;
111
112         timekeeper.clock = clock;
113         clock->cycle_last = clock->read(clock);
114
115         /* Do the ns -> cycle conversion first, using original mult */
116         tmp = NTP_INTERVAL_LENGTH;
117         tmp <<= clock->shift;
118         ntpinterval = tmp;
119         tmp += clock->mult/2;
120         do_div(tmp, clock->mult);
121         if (tmp == 0)
122                 tmp = 1;
123
124         interval = (cycle_t) tmp;
125         timekeeper.cycle_interval = interval;
126
127         /* Go back from cycles -> shifted ns */
128         timekeeper.xtime_interval = (u64) interval * clock->mult;
129         timekeeper.xtime_remainder = ntpinterval - timekeeper.xtime_interval;
130         timekeeper.raw_interval =
131                 ((u64) interval * clock->mult) >> clock->shift;
132
133         timekeeper.xtime_nsec = 0;
134         timekeeper.shift = clock->shift;
135
136         timekeeper.ntp_error = 0;
137         timekeeper.ntp_error_shift = NTP_SCALE_SHIFT - clock->shift;
138
139         /*
140          * The timekeeper keeps its own mult values for the currently
141          * active clocksource. These value will be adjusted via NTP
142          * to counteract clock drifting.
143          */
144         timekeeper.mult = clock->mult;
145 }
146
147 /* Timekeeper helper functions. */
148 static inline s64 timekeeping_get_ns(void)
149 {
150         cycle_t cycle_now, cycle_delta;
151         struct clocksource *clock;
152
153         /* read clocksource: */
154         clock = timekeeper.clock;
155         cycle_now = clock->read(clock);
156
157         /* calculate the delta since the last update_wall_time: */
158         cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
159
160         /* return delta convert to nanoseconds using ntp adjusted mult. */
161         return clocksource_cyc2ns(cycle_delta, timekeeper.mult,
162                                   timekeeper.shift);
163 }
164
165 static inline s64 timekeeping_get_ns_raw(void)
166 {
167         cycle_t cycle_now, cycle_delta;
168         struct clocksource *clock;
169
170         /* read clocksource: */
171         clock = timekeeper.clock;
172         cycle_now = clock->read(clock);
173
174         /* calculate the delta since the last update_wall_time: */
175         cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
176
177         /* return delta convert to nanoseconds. */
178         return clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
179 }
180
181 static void update_rt_offset(void)
182 {
183         struct timespec tmp, *wtm = &timekeeper.wall_to_monotonic;
184
185         set_normalized_timespec(&tmp, -wtm->tv_sec, -wtm->tv_nsec);
186         timekeeper.offs_real = timespec_to_ktime(tmp);
187 }
188
189 /* must hold write on timekeeper.lock */
190 static void timekeeping_update(bool clearntp)
191 {
192         if (clearntp) {
193                 timekeeper.ntp_error = 0;
194                 ntp_clear();
195         }
196         update_rt_offset();
197         update_vsyscall(&timekeeper.xtime, &timekeeper.wall_to_monotonic,
198                          timekeeper.clock, timekeeper.mult);
199 }
200
201
202 /**
203  * timekeeping_forward_now - update clock to the current time
204  *
205  * Forward the current clock to update its state since the last call to
206  * update_wall_time(). This is useful before significant clock changes,
207  * as it avoids having to deal with this time offset explicitly.
208  */
209 static void timekeeping_forward_now(void)
210 {
211         cycle_t cycle_now, cycle_delta;
212         struct clocksource *clock;
213         s64 nsec;
214
215         clock = timekeeper.clock;
216         cycle_now = clock->read(clock);
217         cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
218         clock->cycle_last = cycle_now;
219
220         nsec = clocksource_cyc2ns(cycle_delta, timekeeper.mult,
221                                   timekeeper.shift);
222
223         /* If arch requires, add in gettimeoffset() */
224         nsec += arch_gettimeoffset();
225
226         timespec_add_ns(&timekeeper.xtime, nsec);
227
228         nsec = clocksource_cyc2ns(cycle_delta, clock->mult, clock->shift);
229         timespec_add_ns(&timekeeper.raw_time, nsec);
230 }
231
232 /**
233  * getnstimeofday - Returns the time of day in a timespec
234  * @ts:         pointer to the timespec to be set
235  *
236  * Returns the time of day in a timespec.
237  */
238 void getnstimeofday(struct timespec *ts)
239 {
240         unsigned long seq;
241         s64 nsecs;
242
243         WARN_ON(timekeeping_suspended);
244
245         do {
246                 seq = read_seqbegin(&timekeeper.lock);
247
248                 *ts = timekeeper.xtime;
249                 nsecs = timekeeping_get_ns();
250
251                 /* If arch requires, add in gettimeoffset() */
252                 nsecs += arch_gettimeoffset();
253
254         } while (read_seqretry(&timekeeper.lock, seq));
255
256         timespec_add_ns(ts, nsecs);
257 }
258
259 EXPORT_SYMBOL(getnstimeofday);
260
261 ktime_t ktime_get(void)
262 {
263         unsigned int seq;
264         s64 secs, nsecs;
265
266         WARN_ON(timekeeping_suspended);
267
268         do {
269                 seq = read_seqbegin(&timekeeper.lock);
270                 secs = timekeeper.xtime.tv_sec +
271                                 timekeeper.wall_to_monotonic.tv_sec;
272                 nsecs = timekeeper.xtime.tv_nsec +
273                                 timekeeper.wall_to_monotonic.tv_nsec;
274                 nsecs += timekeeping_get_ns();
275                 /* If arch requires, add in gettimeoffset() */
276                 nsecs += arch_gettimeoffset();
277
278         } while (read_seqretry(&timekeeper.lock, seq));
279         /*
280          * Use ktime_set/ktime_add_ns to create a proper ktime on
281          * 32-bit architectures without CONFIG_KTIME_SCALAR.
282          */
283         return ktime_add_ns(ktime_set(secs, 0), nsecs);
284 }
285 EXPORT_SYMBOL_GPL(ktime_get);
286
287 /**
288  * ktime_get_ts - get the monotonic clock in timespec format
289  * @ts:         pointer to timespec variable
290  *
291  * The function calculates the monotonic clock from the realtime
292  * clock and the wall_to_monotonic offset and stores the result
293  * in normalized timespec format in the variable pointed to by @ts.
294  */
295 void ktime_get_ts(struct timespec *ts)
296 {
297         struct timespec tomono;
298         unsigned int seq;
299         s64 nsecs;
300
301         WARN_ON(timekeeping_suspended);
302
303         do {
304                 seq = read_seqbegin(&timekeeper.lock);
305                 *ts = timekeeper.xtime;
306                 tomono = timekeeper.wall_to_monotonic;
307                 nsecs = timekeeping_get_ns();
308                 /* If arch requires, add in gettimeoffset() */
309                 nsecs += arch_gettimeoffset();
310
311         } while (read_seqretry(&timekeeper.lock, seq));
312
313         set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec,
314                                 ts->tv_nsec + tomono.tv_nsec + nsecs);
315 }
316 EXPORT_SYMBOL_GPL(ktime_get_ts);
317
318 #ifdef CONFIG_NTP_PPS
319
320 /**
321  * getnstime_raw_and_real - get day and raw monotonic time in timespec format
322  * @ts_raw:     pointer to the timespec to be set to raw monotonic time
323  * @ts_real:    pointer to the timespec to be set to the time of day
324  *
325  * This function reads both the time of day and raw monotonic time at the
326  * same time atomically and stores the resulting timestamps in timespec
327  * format.
328  */
329 void getnstime_raw_and_real(struct timespec *ts_raw, struct timespec *ts_real)
330 {
331         unsigned long seq;
332         s64 nsecs_raw, nsecs_real;
333
334         WARN_ON_ONCE(timekeeping_suspended);
335
336         do {
337                 u32 arch_offset;
338
339                 seq = read_seqbegin(&timekeeper.lock);
340
341                 *ts_raw = timekeeper.raw_time;
342                 *ts_real = timekeeper.xtime;
343
344                 nsecs_raw = timekeeping_get_ns_raw();
345                 nsecs_real = timekeeping_get_ns();
346
347                 /* If arch requires, add in gettimeoffset() */
348                 arch_offset = arch_gettimeoffset();
349                 nsecs_raw += arch_offset;
350                 nsecs_real += arch_offset;
351
352         } while (read_seqretry(&timekeeper.lock, seq));
353
354         timespec_add_ns(ts_raw, nsecs_raw);
355         timespec_add_ns(ts_real, nsecs_real);
356 }
357 EXPORT_SYMBOL(getnstime_raw_and_real);
358
359 #endif /* CONFIG_NTP_PPS */
360
361 /**
362  * do_gettimeofday - Returns the time of day in a timeval
363  * @tv:         pointer to the timeval to be set
364  *
365  * NOTE: Users should be converted to using getnstimeofday()
366  */
367 void do_gettimeofday(struct timeval *tv)
368 {
369         struct timespec now;
370
371         getnstimeofday(&now);
372         tv->tv_sec = now.tv_sec;
373         tv->tv_usec = now.tv_nsec/1000;
374 }
375
376 EXPORT_SYMBOL(do_gettimeofday);
377 /**
378  * do_settimeofday - Sets the time of day
379  * @tv:         pointer to the timespec variable containing the new time
380  *
381  * Sets the time of day to the new time and update NTP and notify hrtimers
382  */
383 int do_settimeofday(const struct timespec *tv)
384 {
385         struct timespec ts_delta;
386         unsigned long flags;
387
388         if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
389                 return -EINVAL;
390
391         write_seqlock_irqsave(&timekeeper.lock, flags);
392
393         timekeeping_forward_now();
394
395         ts_delta.tv_sec = tv->tv_sec - timekeeper.xtime.tv_sec;
396         ts_delta.tv_nsec = tv->tv_nsec - timekeeper.xtime.tv_nsec;
397         timekeeper.wall_to_monotonic =
398                         timespec_sub(timekeeper.wall_to_monotonic, ts_delta);
399
400         timekeeper.xtime = *tv;
401         timekeeping_update(true);
402
403         write_sequnlock_irqrestore(&timekeeper.lock, flags);
404
405         /* signal hrtimers about time change */
406         clock_was_set();
407
408         return 0;
409 }
410
411 EXPORT_SYMBOL(do_settimeofday);
412
413
414 /**
415  * timekeeping_inject_offset - Adds or subtracts from the current time.
416  * @tv:         pointer to the timespec variable containing the offset
417  *
418  * Adds or subtracts an offset value from the current time.
419  */
420 int timekeeping_inject_offset(struct timespec *ts)
421 {
422         unsigned long flags;
423
424         if ((unsigned long)ts->tv_nsec >= NSEC_PER_SEC)
425                 return -EINVAL;
426
427         write_seqlock_irqsave(&timekeeper.lock, flags);
428
429         timekeeping_forward_now();
430
431         timekeeper.xtime = timespec_add(timekeeper.xtime, *ts);
432         timekeeper.wall_to_monotonic =
433                                 timespec_sub(timekeeper.wall_to_monotonic, *ts);
434
435         timekeeping_update(true);
436
437         write_sequnlock_irqrestore(&timekeeper.lock, flags);
438
439         /* signal hrtimers about time change */
440         clock_was_set();
441
442         return 0;
443 }
444 EXPORT_SYMBOL(timekeeping_inject_offset);
445
446 /**
447  * change_clocksource - Swaps clocksources if a new one is available
448  *
449  * Accumulates current time interval and initializes new clocksource
450  */
451 static int change_clocksource(void *data)
452 {
453         struct clocksource *new, *old;
454         unsigned long flags;
455
456         new = (struct clocksource *) data;
457
458         write_seqlock_irqsave(&timekeeper.lock, flags);
459
460         timekeeping_forward_now();
461         if (!new->enable || new->enable(new) == 0) {
462                 old = timekeeper.clock;
463                 timekeeper_setup_internals(new);
464                 if (old->disable)
465                         old->disable(old);
466         }
467         timekeeping_update(true);
468
469         write_sequnlock_irqrestore(&timekeeper.lock, flags);
470
471         return 0;
472 }
473
474 /**
475  * timekeeping_notify - Install a new clock source
476  * @clock:              pointer to the clock source
477  *
478  * This function is called from clocksource.c after a new, better clock
479  * source has been registered. The caller holds the clocksource_mutex.
480  */
481 void timekeeping_notify(struct clocksource *clock)
482 {
483         if (timekeeper.clock == clock)
484                 return;
485         stop_machine(change_clocksource, clock, NULL);
486         tick_clock_notify();
487 }
488
489 /**
490  * ktime_get_real - get the real (wall-) time in ktime_t format
491  *
492  * returns the time in ktime_t format
493  */
494 ktime_t ktime_get_real(void)
495 {
496         struct timespec now;
497
498         getnstimeofday(&now);
499
500         return timespec_to_ktime(now);
501 }
502 EXPORT_SYMBOL_GPL(ktime_get_real);
503
504 /**
505  * getrawmonotonic - Returns the raw monotonic time in a timespec
506  * @ts:         pointer to the timespec to be set
507  *
508  * Returns the raw monotonic time (completely un-modified by ntp)
509  */
510 void getrawmonotonic(struct timespec *ts)
511 {
512         unsigned long seq;
513         s64 nsecs;
514
515         do {
516                 seq = read_seqbegin(&timekeeper.lock);
517                 nsecs = timekeeping_get_ns_raw();
518                 *ts = timekeeper.raw_time;
519
520         } while (read_seqretry(&timekeeper.lock, seq));
521
522         timespec_add_ns(ts, nsecs);
523 }
524 EXPORT_SYMBOL(getrawmonotonic);
525
526
527 /**
528  * timekeeping_valid_for_hres - Check if timekeeping is suitable for hres
529  */
530 int timekeeping_valid_for_hres(void)
531 {
532         unsigned long seq;
533         int ret;
534
535         do {
536                 seq = read_seqbegin(&timekeeper.lock);
537
538                 ret = timekeeper.clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
539
540         } while (read_seqretry(&timekeeper.lock, seq));
541
542         return ret;
543 }
544
545 /**
546  * timekeeping_max_deferment - Returns max time the clocksource can be deferred
547  */
548 u64 timekeeping_max_deferment(void)
549 {
550         unsigned long seq;
551         u64 ret;
552         do {
553                 seq = read_seqbegin(&timekeeper.lock);
554
555                 ret = timekeeper.clock->max_idle_ns;
556
557         } while (read_seqretry(&timekeeper.lock, seq));
558
559         return ret;
560 }
561
562 /**
563  * read_persistent_clock -  Return time from the persistent clock.
564  *
565  * Weak dummy function for arches that do not yet support it.
566  * Reads the time from the battery backed persistent clock.
567  * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
568  *
569  *  XXX - Do be sure to remove it once all arches implement it.
570  */
571 void __attribute__((weak)) read_persistent_clock(struct timespec *ts)
572 {
573         ts->tv_sec = 0;
574         ts->tv_nsec = 0;
575 }
576
577 /**
578  * read_boot_clock -  Return time of the system start.
579  *
580  * Weak dummy function for arches that do not yet support it.
581  * Function to read the exact time the system has been started.
582  * Returns a timespec with tv_sec=0 and tv_nsec=0 if unsupported.
583  *
584  *  XXX - Do be sure to remove it once all arches implement it.
585  */
586 void __attribute__((weak)) read_boot_clock(struct timespec *ts)
587 {
588         ts->tv_sec = 0;
589         ts->tv_nsec = 0;
590 }
591
592 /*
593  * timekeeping_init - Initializes the clocksource and common timekeeping values
594  */
595 void __init timekeeping_init(void)
596 {
597         struct clocksource *clock;
598         unsigned long flags;
599         struct timespec now, boot;
600
601         read_persistent_clock(&now);
602         read_boot_clock(&boot);
603
604         seqlock_init(&timekeeper.lock);
605
606         ntp_init();
607
608         write_seqlock_irqsave(&timekeeper.lock, flags);
609         clock = clocksource_default_clock();
610         if (clock->enable)
611                 clock->enable(clock);
612         timekeeper_setup_internals(clock);
613
614         timekeeper.xtime.tv_sec = now.tv_sec;
615         timekeeper.xtime.tv_nsec = now.tv_nsec;
616         timekeeper.raw_time.tv_sec = 0;
617         timekeeper.raw_time.tv_nsec = 0;
618         if (boot.tv_sec == 0 && boot.tv_nsec == 0) {
619                 boot.tv_sec = timekeeper.xtime.tv_sec;
620                 boot.tv_nsec = timekeeper.xtime.tv_nsec;
621         }
622         set_normalized_timespec(&timekeeper.wall_to_monotonic,
623                                 -boot.tv_sec, -boot.tv_nsec);
624         update_rt_offset();
625         timekeeper.total_sleep_time.tv_sec = 0;
626         timekeeper.total_sleep_time.tv_nsec = 0;
627         write_sequnlock_irqrestore(&timekeeper.lock, flags);
628 }
629
630 /* time in seconds when suspend began */
631 static struct timespec timekeeping_suspend_time;
632
633 static void update_sleep_time(struct timespec t)
634 {
635         timekeeper.total_sleep_time = t;
636         timekeeper.offs_boot = timespec_to_ktime(t);
637 }
638
639 /**
640  * __timekeeping_inject_sleeptime - Internal function to add sleep interval
641  * @delta: pointer to a timespec delta value
642  *
643  * Takes a timespec offset measuring a suspend interval and properly
644  * adds the sleep offset to the timekeeping variables.
645  */
646 static void __timekeeping_inject_sleeptime(struct timespec *delta)
647 {
648         if (!timespec_valid(delta)) {
649                 printk(KERN_WARNING "__timekeeping_inject_sleeptime: Invalid "
650                                         "sleep delta value!\n");
651                 return;
652         }
653
654         timekeeper.xtime = timespec_add(timekeeper.xtime, *delta);
655         timekeeper.wall_to_monotonic =
656                         timespec_sub(timekeeper.wall_to_monotonic, *delta);
657         update_sleep_time(timespec_add(timekeeper.total_sleep_time, *delta));
658 }
659
660
661 /**
662  * timekeeping_inject_sleeptime - Adds suspend interval to timeekeeping values
663  * @delta: pointer to a timespec delta value
664  *
665  * This hook is for architectures that cannot support read_persistent_clock
666  * because their RTC/persistent clock is only accessible when irqs are enabled.
667  *
668  * This function should only be called by rtc_resume(), and allows
669  * a suspend offset to be injected into the timekeeping values.
670  */
671 void timekeeping_inject_sleeptime(struct timespec *delta)
672 {
673         unsigned long flags;
674         struct timespec ts;
675
676         /* Make sure we don't set the clock twice */
677         read_persistent_clock(&ts);
678         if (!(ts.tv_sec == 0 && ts.tv_nsec == 0))
679                 return;
680
681         write_seqlock_irqsave(&timekeeper.lock, flags);
682
683         timekeeping_forward_now();
684
685         __timekeeping_inject_sleeptime(delta);
686
687         timekeeping_update(true);
688
689         write_sequnlock_irqrestore(&timekeeper.lock, flags);
690
691         /* signal hrtimers about time change */
692         clock_was_set();
693 }
694
695
696 /**
697  * timekeeping_resume - Resumes the generic timekeeping subsystem.
698  *
699  * This is for the generic clocksource timekeeping.
700  * xtime/wall_to_monotonic/jiffies/etc are
701  * still managed by arch specific suspend/resume code.
702  */
703 static void timekeeping_resume(void)
704 {
705         unsigned long flags;
706         struct timespec ts;
707
708         read_persistent_clock(&ts);
709
710         clocksource_resume();
711
712         write_seqlock_irqsave(&timekeeper.lock, flags);
713
714         if (timespec_compare(&ts, &timekeeping_suspend_time) > 0) {
715                 ts = timespec_sub(ts, timekeeping_suspend_time);
716                 __timekeeping_inject_sleeptime(&ts);
717         }
718         /* re-base the last cycle value */
719         timekeeper.clock->cycle_last = timekeeper.clock->read(timekeeper.clock);
720         timekeeper.ntp_error = 0;
721         timekeeping_suspended = 0;
722         timekeeping_update(false);
723         write_sequnlock_irqrestore(&timekeeper.lock, flags);
724
725         touch_softlockup_watchdog();
726
727         clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
728
729         /* Resume hrtimers */
730         hrtimers_resume();
731 }
732
733 static int timekeeping_suspend(void)
734 {
735         unsigned long flags;
736         struct timespec         delta, delta_delta;
737         static struct timespec  old_delta;
738
739         read_persistent_clock(&timekeeping_suspend_time);
740
741         write_seqlock_irqsave(&timekeeper.lock, flags);
742         timekeeping_forward_now();
743         timekeeping_suspended = 1;
744
745         /*
746          * To avoid drift caused by repeated suspend/resumes,
747          * which each can add ~1 second drift error,
748          * try to compensate so the difference in system time
749          * and persistent_clock time stays close to constant.
750          */
751         delta = timespec_sub(timekeeper.xtime, timekeeping_suspend_time);
752         delta_delta = timespec_sub(delta, old_delta);
753         if (abs(delta_delta.tv_sec)  >= 2) {
754                 /*
755                  * if delta_delta is too large, assume time correction
756                  * has occured and set old_delta to the current delta.
757                  */
758                 old_delta = delta;
759         } else {
760                 /* Otherwise try to adjust old_system to compensate */
761                 timekeeping_suspend_time =
762                         timespec_add(timekeeping_suspend_time, delta_delta);
763         }
764         write_sequnlock_irqrestore(&timekeeper.lock, flags);
765
766         clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
767         clocksource_suspend();
768
769         return 0;
770 }
771
772 /* sysfs resume/suspend bits for timekeeping */
773 static struct syscore_ops timekeeping_syscore_ops = {
774         .resume         = timekeeping_resume,
775         .suspend        = timekeeping_suspend,
776 };
777
778 static int __init timekeeping_init_ops(void)
779 {
780         register_syscore_ops(&timekeeping_syscore_ops);
781         return 0;
782 }
783
784 device_initcall(timekeeping_init_ops);
785
786 /*
787  * If the error is already larger, we look ahead even further
788  * to compensate for late or lost adjustments.
789  */
790 static __always_inline int timekeeping_bigadjust(s64 error, s64 *interval,
791                                                  s64 *offset)
792 {
793         s64 tick_error, i;
794         u32 look_ahead, adj;
795         s32 error2, mult;
796
797         /*
798          * Use the current error value to determine how much to look ahead.
799          * The larger the error the slower we adjust for it to avoid problems
800          * with losing too many ticks, otherwise we would overadjust and
801          * produce an even larger error.  The smaller the adjustment the
802          * faster we try to adjust for it, as lost ticks can do less harm
803          * here.  This is tuned so that an error of about 1 msec is adjusted
804          * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
805          */
806         error2 = timekeeper.ntp_error >> (NTP_SCALE_SHIFT + 22 - 2 * SHIFT_HZ);
807         error2 = abs(error2);
808         for (look_ahead = 0; error2 > 0; look_ahead++)
809                 error2 >>= 2;
810
811         /*
812          * Now calculate the error in (1 << look_ahead) ticks, but first
813          * remove the single look ahead already included in the error.
814          */
815         tick_error = ntp_tick_length() >> (timekeeper.ntp_error_shift + 1);
816         tick_error -= timekeeper.xtime_interval >> 1;
817         error = ((error - tick_error) >> look_ahead) + tick_error;
818
819         /* Finally calculate the adjustment shift value.  */
820         i = *interval;
821         mult = 1;
822         if (error < 0) {
823                 error = -error;
824                 *interval = -*interval;
825                 *offset = -*offset;
826                 mult = -1;
827         }
828         for (adj = 0; error > i; adj++)
829                 error >>= 1;
830
831         *interval <<= adj;
832         *offset <<= adj;
833         return mult << adj;
834 }
835
836 /*
837  * Adjust the multiplier to reduce the error value,
838  * this is optimized for the most common adjustments of -1,0,1,
839  * for other values we can do a bit more work.
840  */
841 static void timekeeping_adjust(s64 offset)
842 {
843         s64 error, interval = timekeeper.cycle_interval;
844         int adj;
845
846         /*
847          * The point of this is to check if the error is greater than half
848          * an interval.
849          *
850          * First we shift it down from NTP_SHIFT to clocksource->shifted nsecs.
851          *
852          * Note we subtract one in the shift, so that error is really error*2.
853          * This "saves" dividing(shifting) interval twice, but keeps the
854          * (error > interval) comparison as still measuring if error is
855          * larger than half an interval.
856          *
857          * Note: It does not "save" on aggravation when reading the code.
858          */
859         error = timekeeper.ntp_error >> (timekeeper.ntp_error_shift - 1);
860         if (error > interval) {
861                 /*
862                  * We now divide error by 4(via shift), which checks if
863                  * the error is greater than twice the interval.
864                  * If it is greater, we need a bigadjust, if its smaller,
865                  * we can adjust by 1.
866                  */
867                 error >>= 2;
868                 /*
869                  * XXX - In update_wall_time, we round up to the next
870                  * nanosecond, and store the amount rounded up into
871                  * the error. This causes the likely below to be unlikely.
872                  *
873                  * The proper fix is to avoid rounding up by using
874                  * the high precision timekeeper.xtime_nsec instead of
875                  * xtime.tv_nsec everywhere. Fixing this will take some
876                  * time.
877                  */
878                 if (likely(error <= interval))
879                         adj = 1;
880                 else
881                         adj = timekeeping_bigadjust(error, &interval, &offset);
882         } else if (error < -interval) {
883                 /* See comment above, this is just switched for the negative */
884                 error >>= 2;
885                 if (likely(error >= -interval)) {
886                         adj = -1;
887                         interval = -interval;
888                         offset = -offset;
889                 } else
890                         adj = timekeeping_bigadjust(error, &interval, &offset);
891         } else /* No adjustment needed */
892                 return;
893
894         if (unlikely(timekeeper.clock->maxadj &&
895                         (timekeeper.mult + adj >
896                         timekeeper.clock->mult + timekeeper.clock->maxadj))) {
897                 printk_once(KERN_WARNING
898                         "Adjusting %s more than 11%% (%ld vs %ld)\n",
899                         timekeeper.clock->name, (long)timekeeper.mult + adj,
900                         (long)timekeeper.clock->mult +
901                                 timekeeper.clock->maxadj);
902         }
903         /*
904          * So the following can be confusing.
905          *
906          * To keep things simple, lets assume adj == 1 for now.
907          *
908          * When adj != 1, remember that the interval and offset values
909          * have been appropriately scaled so the math is the same.
910          *
911          * The basic idea here is that we're increasing the multiplier
912          * by one, this causes the xtime_interval to be incremented by
913          * one cycle_interval. This is because:
914          *      xtime_interval = cycle_interval * mult
915          * So if mult is being incremented by one:
916          *      xtime_interval = cycle_interval * (mult + 1)
917          * Its the same as:
918          *      xtime_interval = (cycle_interval * mult) + cycle_interval
919          * Which can be shortened to:
920          *      xtime_interval += cycle_interval
921          *
922          * So offset stores the non-accumulated cycles. Thus the current
923          * time (in shifted nanoseconds) is:
924          *      now = (offset * adj) + xtime_nsec
925          * Now, even though we're adjusting the clock frequency, we have
926          * to keep time consistent. In other words, we can't jump back
927          * in time, and we also want to avoid jumping forward in time.
928          *
929          * So given the same offset value, we need the time to be the same
930          * both before and after the freq adjustment.
931          *      now = (offset * adj_1) + xtime_nsec_1
932          *      now = (offset * adj_2) + xtime_nsec_2
933          * So:
934          *      (offset * adj_1) + xtime_nsec_1 =
935          *              (offset * adj_2) + xtime_nsec_2
936          * And we know:
937          *      adj_2 = adj_1 + 1
938          * So:
939          *      (offset * adj_1) + xtime_nsec_1 =
940          *              (offset * (adj_1+1)) + xtime_nsec_2
941          *      (offset * adj_1) + xtime_nsec_1 =
942          *              (offset * adj_1) + offset + xtime_nsec_2
943          * Canceling the sides:
944          *      xtime_nsec_1 = offset + xtime_nsec_2
945          * Which gives us:
946          *      xtime_nsec_2 = xtime_nsec_1 - offset
947          * Which simplfies to:
948          *      xtime_nsec -= offset
949          *
950          * XXX - TODO: Doc ntp_error calculation.
951          */
952         timekeeper.mult += adj;
953         timekeeper.xtime_interval += interval;
954         timekeeper.xtime_nsec -= offset;
955         timekeeper.ntp_error -= (interval - offset) <<
956                                 timekeeper.ntp_error_shift;
957 }
958
959
960 /**
961  * logarithmic_accumulation - shifted accumulation of cycles
962  *
963  * This functions accumulates a shifted interval of cycles into
964  * into a shifted interval nanoseconds. Allows for O(log) accumulation
965  * loop.
966  *
967  * Returns the unconsumed cycles.
968  */
969 static cycle_t logarithmic_accumulation(cycle_t offset, int shift)
970 {
971         u64 nsecps = (u64)NSEC_PER_SEC << timekeeper.shift;
972         u64 raw_nsecs;
973
974         /* If the offset is smaller than a shifted interval, do nothing */
975         if (offset < timekeeper.cycle_interval<<shift)
976                 return offset;
977
978         /* Accumulate one shifted interval */
979         offset -= timekeeper.cycle_interval << shift;
980         timekeeper.clock->cycle_last += timekeeper.cycle_interval << shift;
981
982         timekeeper.xtime_nsec += timekeeper.xtime_interval << shift;
983         while (timekeeper.xtime_nsec >= nsecps) {
984                 int leap;
985                 timekeeper.xtime_nsec -= nsecps;
986                 timekeeper.xtime.tv_sec++;
987                 leap = second_overflow(timekeeper.xtime.tv_sec);
988                 timekeeper.xtime.tv_sec += leap;
989                 timekeeper.wall_to_monotonic.tv_sec -= leap;
990                 if (leap)
991                         clock_was_set_delayed();
992         }
993
994         /* Accumulate raw time */
995         raw_nsecs = timekeeper.raw_interval << shift;
996         raw_nsecs += timekeeper.raw_time.tv_nsec;
997         if (raw_nsecs >= NSEC_PER_SEC) {
998                 u64 raw_secs = raw_nsecs;
999                 raw_nsecs = do_div(raw_secs, NSEC_PER_SEC);
1000                 timekeeper.raw_time.tv_sec += raw_secs;
1001         }
1002         timekeeper.raw_time.tv_nsec = raw_nsecs;
1003
1004         /* Accumulate error between NTP and clock interval */
1005         timekeeper.ntp_error += ntp_tick_length() << shift;
1006         timekeeper.ntp_error -=
1007             (timekeeper.xtime_interval + timekeeper.xtime_remainder) <<
1008                                 (timekeeper.ntp_error_shift + shift);
1009
1010         return offset;
1011 }
1012
1013
1014 /**
1015  * update_wall_time - Uses the current clocksource to increment the wall time
1016  *
1017  */
1018 static void update_wall_time(void)
1019 {
1020         struct clocksource *clock;
1021         cycle_t offset;
1022         int shift = 0, maxshift;
1023         unsigned long flags;
1024
1025         write_seqlock_irqsave(&timekeeper.lock, flags);
1026
1027         /* Make sure we're fully resumed: */
1028         if (unlikely(timekeeping_suspended))
1029                 goto out;
1030
1031         clock = timekeeper.clock;
1032
1033 #ifdef CONFIG_ARCH_USES_GETTIMEOFFSET
1034         offset = timekeeper.cycle_interval;
1035 #else
1036         offset = (clock->read(clock) - clock->cycle_last) & clock->mask;
1037 #endif
1038         timekeeper.xtime_nsec = (s64)timekeeper.xtime.tv_nsec <<
1039                                                 timekeeper.shift;
1040
1041         /*
1042          * With NO_HZ we may have to accumulate many cycle_intervals
1043          * (think "ticks") worth of time at once. To do this efficiently,
1044          * we calculate the largest doubling multiple of cycle_intervals
1045          * that is smaller than the offset.  We then accumulate that
1046          * chunk in one go, and then try to consume the next smaller
1047          * doubled multiple.
1048          */
1049         shift = ilog2(offset) - ilog2(timekeeper.cycle_interval);
1050         shift = max(0, shift);
1051         /* Bound shift to one less than what overflows tick_length */
1052         maxshift = (64 - (ilog2(ntp_tick_length())+1)) - 1;
1053         shift = min(shift, maxshift);
1054         while (offset >= timekeeper.cycle_interval) {
1055                 offset = logarithmic_accumulation(offset, shift);
1056                 if(offset < timekeeper.cycle_interval<<shift)
1057                         shift--;
1058         }
1059
1060         /* correct the clock when NTP error is too big */
1061         timekeeping_adjust(offset);
1062
1063         /*
1064          * Since in the loop above, we accumulate any amount of time
1065          * in xtime_nsec over a second into xtime.tv_sec, its possible for
1066          * xtime_nsec to be fairly small after the loop. Further, if we're
1067          * slightly speeding the clocksource up in timekeeping_adjust(),
1068          * its possible the required corrective factor to xtime_nsec could
1069          * cause it to underflow.
1070          *
1071          * Now, we cannot simply roll the accumulated second back, since
1072          * the NTP subsystem has been notified via second_overflow. So
1073          * instead we push xtime_nsec forward by the amount we underflowed,
1074          * and add that amount into the error.
1075          *
1076          * We'll correct this error next time through this function, when
1077          * xtime_nsec is not as small.
1078          */
1079         if (unlikely((s64)timekeeper.xtime_nsec < 0)) {
1080                 s64 neg = -(s64)timekeeper.xtime_nsec;
1081                 timekeeper.xtime_nsec = 0;
1082                 timekeeper.ntp_error += neg << timekeeper.ntp_error_shift;
1083         }
1084
1085
1086         /*
1087          * Store full nanoseconds into xtime after rounding it up and
1088          * add the remainder to the error difference.
1089          */
1090         timekeeper.xtime.tv_nsec = ((s64)timekeeper.xtime_nsec >>
1091                                                 timekeeper.shift) + 1;
1092         timekeeper.xtime_nsec -= (s64)timekeeper.xtime.tv_nsec <<
1093                                                 timekeeper.shift;
1094         timekeeper.ntp_error += timekeeper.xtime_nsec <<
1095                                 timekeeper.ntp_error_shift;
1096
1097         /*
1098          * Finally, make sure that after the rounding
1099          * xtime.tv_nsec isn't larger than NSEC_PER_SEC
1100          */
1101         if (unlikely(timekeeper.xtime.tv_nsec >= NSEC_PER_SEC)) {
1102                 int leap;
1103                 timekeeper.xtime.tv_nsec -= NSEC_PER_SEC;
1104                 timekeeper.xtime.tv_sec++;
1105                 leap = second_overflow(timekeeper.xtime.tv_sec);
1106                 timekeeper.xtime.tv_sec += leap;
1107                 timekeeper.wall_to_monotonic.tv_sec -= leap;
1108                 if (leap)
1109                         clock_was_set_delayed();
1110         }
1111
1112         timekeeping_update(false);
1113
1114 out:
1115         write_sequnlock_irqrestore(&timekeeper.lock, flags);
1116
1117 }
1118
1119 /**
1120  * getboottime - Return the real time of system boot.
1121  * @ts:         pointer to the timespec to be set
1122  *
1123  * Returns the wall-time of boot in a timespec.
1124  *
1125  * This is based on the wall_to_monotonic offset and the total suspend
1126  * time. Calls to settimeofday will affect the value returned (which
1127  * basically means that however wrong your real time clock is at boot time,
1128  * you get the right time here).
1129  */
1130 void getboottime(struct timespec *ts)
1131 {
1132         struct timespec boottime = {
1133                 .tv_sec = timekeeper.wall_to_monotonic.tv_sec +
1134                                 timekeeper.total_sleep_time.tv_sec,
1135                 .tv_nsec = timekeeper.wall_to_monotonic.tv_nsec +
1136                                 timekeeper.total_sleep_time.tv_nsec
1137         };
1138
1139         set_normalized_timespec(ts, -boottime.tv_sec, -boottime.tv_nsec);
1140 }
1141 EXPORT_SYMBOL_GPL(getboottime);
1142
1143
1144 /**
1145  * get_monotonic_boottime - Returns monotonic time since boot
1146  * @ts:         pointer to the timespec to be set
1147  *
1148  * Returns the monotonic time since boot in a timespec.
1149  *
1150  * This is similar to CLOCK_MONTONIC/ktime_get_ts, but also
1151  * includes the time spent in suspend.
1152  */
1153 void get_monotonic_boottime(struct timespec *ts)
1154 {
1155         struct timespec tomono, sleep;
1156         unsigned int seq;
1157         s64 nsecs;
1158
1159         WARN_ON(timekeeping_suspended);
1160
1161         do {
1162                 seq = read_seqbegin(&timekeeper.lock);
1163                 *ts = timekeeper.xtime;
1164                 tomono = timekeeper.wall_to_monotonic;
1165                 sleep = timekeeper.total_sleep_time;
1166                 nsecs = timekeeping_get_ns();
1167
1168         } while (read_seqretry(&timekeeper.lock, seq));
1169
1170         set_normalized_timespec(ts, ts->tv_sec + tomono.tv_sec + sleep.tv_sec,
1171                         ts->tv_nsec + tomono.tv_nsec + sleep.tv_nsec + nsecs);
1172 }
1173 EXPORT_SYMBOL_GPL(get_monotonic_boottime);
1174
1175 /**
1176  * ktime_get_boottime - Returns monotonic time since boot in a ktime
1177  *
1178  * Returns the monotonic time since boot in a ktime
1179  *
1180  * This is similar to CLOCK_MONTONIC/ktime_get, but also
1181  * includes the time spent in suspend.
1182  */
1183 ktime_t ktime_get_boottime(void)
1184 {
1185         struct timespec ts;
1186
1187         get_monotonic_boottime(&ts);
1188         return timespec_to_ktime(ts);
1189 }
1190 EXPORT_SYMBOL_GPL(ktime_get_boottime);
1191
1192 /**
1193  * monotonic_to_bootbased - Convert the monotonic time to boot based.
1194  * @ts:         pointer to the timespec to be converted
1195  */
1196 void monotonic_to_bootbased(struct timespec *ts)
1197 {
1198         *ts = timespec_add(*ts, timekeeper.total_sleep_time);
1199 }
1200 EXPORT_SYMBOL_GPL(monotonic_to_bootbased);
1201
1202 unsigned long get_seconds(void)
1203 {
1204         return timekeeper.xtime.tv_sec;
1205 }
1206 EXPORT_SYMBOL(get_seconds);
1207
1208 struct timespec __current_kernel_time(void)
1209 {
1210         return timekeeper.xtime;
1211 }
1212
1213 struct timespec current_kernel_time(void)
1214 {
1215         struct timespec now;
1216         unsigned long seq;
1217
1218         do {
1219                 seq = read_seqbegin(&timekeeper.lock);
1220
1221                 now = timekeeper.xtime;
1222         } while (read_seqretry(&timekeeper.lock, seq));
1223
1224         return now;
1225 }
1226 EXPORT_SYMBOL(current_kernel_time);
1227
1228 struct timespec get_monotonic_coarse(void)
1229 {
1230         struct timespec now, mono;
1231         unsigned long seq;
1232
1233         do {
1234                 seq = read_seqbegin(&timekeeper.lock);
1235
1236                 now = timekeeper.xtime;
1237                 mono = timekeeper.wall_to_monotonic;
1238         } while (read_seqretry(&timekeeper.lock, seq));
1239
1240         set_normalized_timespec(&now, now.tv_sec + mono.tv_sec,
1241                                 now.tv_nsec + mono.tv_nsec);
1242         return now;
1243 }
1244
1245 /*
1246  * The 64-bit jiffies value is not atomic - you MUST NOT read it
1247  * without sampling the sequence number in xtime_lock.
1248  * jiffies is defined in the linker script...
1249  */
1250 void do_timer(unsigned long ticks)
1251 {
1252         jiffies_64 += ticks;
1253         update_wall_time();
1254         calc_global_load(ticks);
1255 }
1256
1257 /**
1258  * get_xtime_and_monotonic_and_sleep_offset() - get xtime, wall_to_monotonic,
1259  *    and sleep offsets.
1260  * @xtim:       pointer to timespec to be set with xtime
1261  * @wtom:       pointer to timespec to be set with wall_to_monotonic
1262  * @sleep:      pointer to timespec to be set with time in suspend
1263  */
1264 void get_xtime_and_monotonic_and_sleep_offset(struct timespec *xtim,
1265                                 struct timespec *wtom, struct timespec *sleep)
1266 {
1267         unsigned long seq;
1268
1269         do {
1270                 seq = read_seqbegin(&timekeeper.lock);
1271                 *xtim = timekeeper.xtime;
1272                 *wtom = timekeeper.wall_to_monotonic;
1273                 *sleep = timekeeper.total_sleep_time;
1274         } while (read_seqretry(&timekeeper.lock, seq));
1275 }
1276
1277 #ifdef CONFIG_HIGH_RES_TIMERS
1278 /**
1279  * ktime_get_update_offsets - hrtimer helper
1280  * @offs_real:  pointer to storage for monotonic -> realtime offset
1281  * @offs_boot:  pointer to storage for monotonic -> boottime offset
1282  *
1283  * Returns current monotonic time and updates the offsets
1284  * Called from hrtimer_interupt() or retrigger_next_event()
1285  */
1286 ktime_t ktime_get_update_offsets(ktime_t *offs_real, ktime_t *offs_boot)
1287 {
1288         ktime_t now;
1289         unsigned int seq;
1290         u64 secs, nsecs;
1291
1292         do {
1293                 seq = read_seqbegin(&timekeeper.lock);
1294
1295                 secs = timekeeper.xtime.tv_sec;
1296                 nsecs = timekeeper.xtime.tv_nsec;
1297                 nsecs += timekeeping_get_ns();
1298                 /* If arch requires, add in gettimeoffset() */
1299                 nsecs += arch_gettimeoffset();
1300
1301                 *offs_real = timekeeper.offs_real;
1302                 *offs_boot = timekeeper.offs_boot;
1303         } while (read_seqretry(&timekeeper.lock, seq));
1304
1305         now = ktime_add_ns(ktime_set(secs, 0), nsecs);
1306         now = ktime_sub(now, *offs_real);
1307         return now;
1308 }
1309 #endif
1310
1311 /**
1312  * ktime_get_monotonic_offset() - get wall_to_monotonic in ktime_t format
1313  */
1314 ktime_t ktime_get_monotonic_offset(void)
1315 {
1316         unsigned long seq;
1317         struct timespec wtom;
1318
1319         do {
1320                 seq = read_seqbegin(&timekeeper.lock);
1321                 wtom = timekeeper.wall_to_monotonic;
1322         } while (read_seqretry(&timekeeper.lock, seq));
1323
1324         return timespec_to_ktime(wtom);
1325 }
1326
1327 /**
1328  * xtime_update() - advances the timekeeping infrastructure
1329  * @ticks:      number of ticks, that have elapsed since the last call.
1330  *
1331  * Must be called with interrupts disabled.
1332  */
1333 void xtime_update(unsigned long ticks)
1334 {
1335         write_seqlock(&xtime_lock);
1336         do_timer(ticks);
1337         write_sequnlock(&xtime_lock);
1338 }