Merge git://git.kernel.org/pub/scm/linux/kernel/git/wim/linux-2.6-watchdog
[linux-2.6] / 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/sysdev.h>
17 #include <linux/clocksource.h>
18 #include <linux/jiffies.h>
19 #include <linux/time.h>
20 #include <linux/tick.h>
21
22
23 /*
24  * This read-write spinlock protects us from races in SMP while
25  * playing with xtime and avenrun.
26  */
27 __cacheline_aligned_in_smp DEFINE_SEQLOCK(xtime_lock);
28
29
30 /*
31  * The current time
32  * wall_to_monotonic is what we need to add to xtime (or xtime corrected
33  * for sub jiffie times) to get to monotonic time.  Monotonic is pegged
34  * at zero at system boot time, so wall_to_monotonic will be negative,
35  * however, we will ALWAYS keep the tv_nsec part positive so we can use
36  * the usual normalization.
37  *
38  * wall_to_monotonic is moved after resume from suspend for the monotonic
39  * time not to jump. We need to add total_sleep_time to wall_to_monotonic
40  * to get the real boot based time offset.
41  *
42  * - wall_to_monotonic is no longer the boot time, getboottime must be
43  * used instead.
44  */
45 struct timespec xtime __attribute__ ((aligned (16)));
46 struct timespec wall_to_monotonic __attribute__ ((aligned (16)));
47 static unsigned long total_sleep_time;          /* seconds */
48
49 static struct timespec xtime_cache __attribute__ ((aligned (16)));
50 static inline void update_xtime_cache(u64 nsec)
51 {
52         xtime_cache = xtime;
53         timespec_add_ns(&xtime_cache, nsec);
54 }
55
56 static struct clocksource *clock; /* pointer to current clocksource */
57
58
59 #ifdef CONFIG_GENERIC_TIME
60 /**
61  * __get_nsec_offset - Returns nanoseconds since last call to periodic_hook
62  *
63  * private function, must hold xtime_lock lock when being
64  * called. Returns the number of nanoseconds since the
65  * last call to update_wall_time() (adjusted by NTP scaling)
66  */
67 static inline s64 __get_nsec_offset(void)
68 {
69         cycle_t cycle_now, cycle_delta;
70         s64 ns_offset;
71
72         /* read clocksource: */
73         cycle_now = clocksource_read(clock);
74
75         /* calculate the delta since the last update_wall_time: */
76         cycle_delta = (cycle_now - clock->cycle_last) & clock->mask;
77
78         /* convert to nanoseconds: */
79         ns_offset = cyc2ns(clock, cycle_delta);
80
81         return ns_offset;
82 }
83
84 /**
85  * getnstimeofday - Returns the time of day in a timespec
86  * @ts:         pointer to the timespec to be set
87  *
88  * Returns the time of day in a timespec.
89  */
90 void getnstimeofday(struct timespec *ts)
91 {
92         unsigned long seq;
93         s64 nsecs;
94
95         do {
96                 seq = read_seqbegin(&xtime_lock);
97
98                 *ts = xtime;
99                 nsecs = __get_nsec_offset();
100
101         } while (read_seqretry(&xtime_lock, seq));
102
103         timespec_add_ns(ts, nsecs);
104 }
105
106 EXPORT_SYMBOL(getnstimeofday);
107
108 /**
109  * do_gettimeofday - Returns the time of day in a timeval
110  * @tv:         pointer to the timeval to be set
111  *
112  * NOTE: Users should be converted to using getnstimeofday()
113  */
114 void do_gettimeofday(struct timeval *tv)
115 {
116         struct timespec now;
117
118         getnstimeofday(&now);
119         tv->tv_sec = now.tv_sec;
120         tv->tv_usec = now.tv_nsec/1000;
121 }
122
123 EXPORT_SYMBOL(do_gettimeofday);
124 /**
125  * do_settimeofday - Sets the time of day
126  * @tv:         pointer to the timespec variable containing the new time
127  *
128  * Sets the time of day to the new time and update NTP and notify hrtimers
129  */
130 int do_settimeofday(struct timespec *tv)
131 {
132         unsigned long flags;
133         time_t wtm_sec, sec = tv->tv_sec;
134         long wtm_nsec, nsec = tv->tv_nsec;
135
136         if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
137                 return -EINVAL;
138
139         write_seqlock_irqsave(&xtime_lock, flags);
140
141         nsec -= __get_nsec_offset();
142
143         wtm_sec  = wall_to_monotonic.tv_sec + (xtime.tv_sec - sec);
144         wtm_nsec = wall_to_monotonic.tv_nsec + (xtime.tv_nsec - nsec);
145
146         set_normalized_timespec(&xtime, sec, nsec);
147         set_normalized_timespec(&wall_to_monotonic, wtm_sec, wtm_nsec);
148
149         clock->error = 0;
150         ntp_clear();
151
152         update_vsyscall(&xtime, clock);
153
154         write_sequnlock_irqrestore(&xtime_lock, flags);
155
156         /* signal hrtimers about time change */
157         clock_was_set();
158
159         return 0;
160 }
161
162 EXPORT_SYMBOL(do_settimeofday);
163
164 /**
165  * change_clocksource - Swaps clocksources if a new one is available
166  *
167  * Accumulates current time interval and initializes new clocksource
168  */
169 static void change_clocksource(void)
170 {
171         struct clocksource *new;
172         cycle_t now;
173         u64 nsec;
174
175         new = clocksource_get_next();
176
177         if (clock == new)
178                 return;
179
180         now = clocksource_read(new);
181         nsec =  __get_nsec_offset();
182         timespec_add_ns(&xtime, nsec);
183
184         clock = new;
185         clock->cycle_last = now;
186
187         clock->error = 0;
188         clock->xtime_nsec = 0;
189         clocksource_calculate_interval(clock,
190                 (unsigned long)(current_tick_length()>>TICK_LENGTH_SHIFT));
191
192         tick_clock_notify();
193
194         printk(KERN_INFO "Time: %s clocksource has been installed.\n",
195                clock->name);
196 }
197 #else
198 static inline void change_clocksource(void) { }
199 static inline s64 __get_nsec_offset(void) { return 0; }
200 #endif
201
202 /**
203  * timekeeping_is_continuous - check to see if timekeeping is free running
204  */
205 int timekeeping_is_continuous(void)
206 {
207         unsigned long seq;
208         int ret;
209
210         do {
211                 seq = read_seqbegin(&xtime_lock);
212
213                 ret = clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
214
215         } while (read_seqretry(&xtime_lock, seq));
216
217         return ret;
218 }
219
220 /**
221  * read_persistent_clock -  Return time in seconds from the persistent clock.
222  *
223  * Weak dummy function for arches that do not yet support it.
224  * Returns seconds from epoch using the battery backed persistent clock.
225  * Returns zero if unsupported.
226  *
227  *  XXX - Do be sure to remove it once all arches implement it.
228  */
229 unsigned long __attribute__((weak)) read_persistent_clock(void)
230 {
231         return 0;
232 }
233
234 /*
235  * timekeeping_init - Initializes the clocksource and common timekeeping values
236  */
237 void __init timekeeping_init(void)
238 {
239         unsigned long flags;
240         unsigned long sec = read_persistent_clock();
241
242         write_seqlock_irqsave(&xtime_lock, flags);
243
244         ntp_clear();
245
246         clock = clocksource_get_next();
247         clocksource_calculate_interval(clock,
248                 (unsigned long)(current_tick_length()>>TICK_LENGTH_SHIFT));
249         clock->cycle_last = clocksource_read(clock);
250
251         xtime.tv_sec = sec;
252         xtime.tv_nsec = 0;
253         set_normalized_timespec(&wall_to_monotonic,
254                 -xtime.tv_sec, -xtime.tv_nsec);
255         total_sleep_time = 0;
256
257         write_sequnlock_irqrestore(&xtime_lock, flags);
258 }
259
260 /* flag for if timekeeping is suspended */
261 static int timekeeping_suspended;
262 /* time in seconds when suspend began */
263 static unsigned long timekeeping_suspend_time;
264 /* xtime offset when we went into suspend */
265 static s64 timekeeping_suspend_nsecs;
266
267 /**
268  * timekeeping_resume - Resumes the generic timekeeping subsystem.
269  * @dev:        unused
270  *
271  * This is for the generic clocksource timekeeping.
272  * xtime/wall_to_monotonic/jiffies/etc are
273  * still managed by arch specific suspend/resume code.
274  */
275 static int timekeeping_resume(struct sys_device *dev)
276 {
277         unsigned long flags;
278         unsigned long now = read_persistent_clock();
279
280         clocksource_resume();
281
282         write_seqlock_irqsave(&xtime_lock, flags);
283
284         if (now && (now > timekeeping_suspend_time)) {
285                 unsigned long sleep_length = now - timekeeping_suspend_time;
286
287                 xtime.tv_sec += sleep_length;
288                 wall_to_monotonic.tv_sec -= sleep_length;
289                 total_sleep_time += sleep_length;
290         }
291         /* Make sure that we have the correct xtime reference */
292         timespec_add_ns(&xtime, timekeeping_suspend_nsecs);
293         /* re-base the last cycle value */
294         clock->cycle_last = clocksource_read(clock);
295         clock->error = 0;
296         timekeeping_suspended = 0;
297         write_sequnlock_irqrestore(&xtime_lock, flags);
298
299         touch_softlockup_watchdog();
300
301         clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
302
303         /* Resume hrtimers */
304         hres_timers_resume();
305
306         return 0;
307 }
308
309 static int timekeeping_suspend(struct sys_device *dev, pm_message_t state)
310 {
311         unsigned long flags;
312
313         timekeeping_suspend_time = read_persistent_clock();
314
315         write_seqlock_irqsave(&xtime_lock, flags);
316         /* Get the current xtime offset */
317         timekeeping_suspend_nsecs = __get_nsec_offset();
318         timekeeping_suspended = 1;
319         write_sequnlock_irqrestore(&xtime_lock, flags);
320
321         clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
322
323         return 0;
324 }
325
326 /* sysfs resume/suspend bits for timekeeping */
327 static struct sysdev_class timekeeping_sysclass = {
328         .name           = "timekeeping",
329         .resume         = timekeeping_resume,
330         .suspend        = timekeeping_suspend,
331 };
332
333 static struct sys_device device_timer = {
334         .id             = 0,
335         .cls            = &timekeeping_sysclass,
336 };
337
338 static int __init timekeeping_init_device(void)
339 {
340         int error = sysdev_class_register(&timekeeping_sysclass);
341         if (!error)
342                 error = sysdev_register(&device_timer);
343         return error;
344 }
345
346 device_initcall(timekeeping_init_device);
347
348 /*
349  * If the error is already larger, we look ahead even further
350  * to compensate for late or lost adjustments.
351  */
352 static __always_inline int clocksource_bigadjust(s64 error, s64 *interval,
353                                                  s64 *offset)
354 {
355         s64 tick_error, i;
356         u32 look_ahead, adj;
357         s32 error2, mult;
358
359         /*
360          * Use the current error value to determine how much to look ahead.
361          * The larger the error the slower we adjust for it to avoid problems
362          * with losing too many ticks, otherwise we would overadjust and
363          * produce an even larger error.  The smaller the adjustment the
364          * faster we try to adjust for it, as lost ticks can do less harm
365          * here.  This is tuned so that an error of about 1 msec is adusted
366          * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
367          */
368         error2 = clock->error >> (TICK_LENGTH_SHIFT + 22 - 2 * SHIFT_HZ);
369         error2 = abs(error2);
370         for (look_ahead = 0; error2 > 0; look_ahead++)
371                 error2 >>= 2;
372
373         /*
374          * Now calculate the error in (1 << look_ahead) ticks, but first
375          * remove the single look ahead already included in the error.
376          */
377         tick_error = current_tick_length() >>
378                 (TICK_LENGTH_SHIFT - clock->shift + 1);
379         tick_error -= clock->xtime_interval >> 1;
380         error = ((error - tick_error) >> look_ahead) + tick_error;
381
382         /* Finally calculate the adjustment shift value.  */
383         i = *interval;
384         mult = 1;
385         if (error < 0) {
386                 error = -error;
387                 *interval = -*interval;
388                 *offset = -*offset;
389                 mult = -1;
390         }
391         for (adj = 0; error > i; adj++)
392                 error >>= 1;
393
394         *interval <<= adj;
395         *offset <<= adj;
396         return mult << adj;
397 }
398
399 /*
400  * Adjust the multiplier to reduce the error value,
401  * this is optimized for the most common adjustments of -1,0,1,
402  * for other values we can do a bit more work.
403  */
404 static void clocksource_adjust(s64 offset)
405 {
406         s64 error, interval = clock->cycle_interval;
407         int adj;
408
409         error = clock->error >> (TICK_LENGTH_SHIFT - clock->shift - 1);
410         if (error > interval) {
411                 error >>= 2;
412                 if (likely(error <= interval))
413                         adj = 1;
414                 else
415                         adj = clocksource_bigadjust(error, &interval, &offset);
416         } else if (error < -interval) {
417                 error >>= 2;
418                 if (likely(error >= -interval)) {
419                         adj = -1;
420                         interval = -interval;
421                         offset = -offset;
422                 } else
423                         adj = clocksource_bigadjust(error, &interval, &offset);
424         } else
425                 return;
426
427         clock->mult += adj;
428         clock->xtime_interval += interval;
429         clock->xtime_nsec -= offset;
430         clock->error -= (interval - offset) <<
431                         (TICK_LENGTH_SHIFT - clock->shift);
432 }
433
434 /**
435  * update_wall_time - Uses the current clocksource to increment the wall time
436  *
437  * Called from the timer interrupt, must hold a write on xtime_lock.
438  */
439 void update_wall_time(void)
440 {
441         cycle_t offset;
442
443         /* Make sure we're fully resumed: */
444         if (unlikely(timekeeping_suspended))
445                 return;
446
447 #ifdef CONFIG_GENERIC_TIME
448         offset = (clocksource_read(clock) - clock->cycle_last) & clock->mask;
449 #else
450         offset = clock->cycle_interval;
451 #endif
452         clock->xtime_nsec += (s64)xtime.tv_nsec << clock->shift;
453
454         /* normally this loop will run just once, however in the
455          * case of lost or late ticks, it will accumulate correctly.
456          */
457         while (offset >= clock->cycle_interval) {
458                 /* accumulate one interval */
459                 clock->xtime_nsec += clock->xtime_interval;
460                 clock->cycle_last += clock->cycle_interval;
461                 offset -= clock->cycle_interval;
462
463                 if (clock->xtime_nsec >= (u64)NSEC_PER_SEC << clock->shift) {
464                         clock->xtime_nsec -= (u64)NSEC_PER_SEC << clock->shift;
465                         xtime.tv_sec++;
466                         second_overflow();
467                 }
468
469                 /* accumulate error between NTP and clock interval */
470                 clock->error += current_tick_length();
471                 clock->error -= clock->xtime_interval << (TICK_LENGTH_SHIFT - clock->shift);
472         }
473
474         /* correct the clock when NTP error is too big */
475         clocksource_adjust(offset);
476
477         /* store full nanoseconds into xtime */
478         xtime.tv_nsec = (s64)clock->xtime_nsec >> clock->shift;
479         clock->xtime_nsec -= (s64)xtime.tv_nsec << clock->shift;
480
481         update_xtime_cache(cyc2ns(clock, offset));
482
483         /* check to see if there is a new clocksource to use */
484         change_clocksource();
485         update_vsyscall(&xtime, clock);
486 }
487
488 /**
489  * getboottime - Return the real time of system boot.
490  * @ts:         pointer to the timespec to be set
491  *
492  * Returns the time of day in a timespec.
493  *
494  * This is based on the wall_to_monotonic offset and the total suspend
495  * time. Calls to settimeofday will affect the value returned (which
496  * basically means that however wrong your real time clock is at boot time,
497  * you get the right time here).
498  */
499 void getboottime(struct timespec *ts)
500 {
501         set_normalized_timespec(ts,
502                 - (wall_to_monotonic.tv_sec + total_sleep_time),
503                 - wall_to_monotonic.tv_nsec);
504 }
505
506 /**
507  * monotonic_to_bootbased - Convert the monotonic time to boot based.
508  * @ts:         pointer to the timespec to be converted
509  */
510 void monotonic_to_bootbased(struct timespec *ts)
511 {
512         ts->tv_sec += total_sleep_time;
513 }
514
515 unsigned long get_seconds(void)
516 {
517         return xtime_cache.tv_sec;
518 }
519 EXPORT_SYMBOL(get_seconds);
520
521
522 struct timespec current_kernel_time(void)
523 {
524         struct timespec now;
525         unsigned long seq;
526
527         do {
528                 seq = read_seqbegin(&xtime_lock);
529
530                 now = xtime_cache;
531         } while (read_seqretry(&xtime_lock, seq));
532
533         return now;
534 }
535 EXPORT_SYMBOL(current_kernel_time);