git.oblomov.eu Git - linux-2.6/blob - 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, NTP_INTERVAL_LENGTH);
 190
 191         tick_clock_notify();
 192
 193         printk(KERN_INFO "Time: %s clocksource has been installed.\n",
 194                clock->name);
 195 }
 196 #else
 197 static inline void change_clocksource(void) { }
 198 static inline s64 __get_nsec_offset(void) { return 0; }
 199 #endif
 200
 201 /**
 202  * timekeeping_is_continuous - check to see if timekeeping is free running
 203  */
 204 int timekeeping_is_continuous(void)
 205 {
 206         unsigned long seq;
 207         int ret;
 208
 209         do {
 210                 seq = read_seqbegin(&xtime_lock);
 211
 212                 ret = clock->flags & CLOCK_SOURCE_VALID_FOR_HRES;
 213
 214         } while (read_seqretry(&xtime_lock, seq));
 215
 216         return ret;
 217 }
 218
 219 /**
 220  * read_persistent_clock -  Return time in seconds from the persistent clock.
 221  *
 222  * Weak dummy function for arches that do not yet support it.
 223  * Returns seconds from epoch using the battery backed persistent clock.
 224  * Returns zero if unsupported.
 225  *
 226  *  XXX - Do be sure to remove it once all arches implement it.
 227  */
 228 unsigned long __attribute__((weak)) read_persistent_clock(void)
 229 {
 230         return 0;
 231 }
 232
 233 /*
 234  * timekeeping_init - Initializes the clocksource and common timekeeping values
 235  */
 236 void __init timekeeping_init(void)
 237 {
 238         unsigned long flags;
 239         unsigned long sec = read_persistent_clock();
 240
 241         write_seqlock_irqsave(&xtime_lock, flags);
 242
 243         ntp_clear();
 244
 245         clock = clocksource_get_next();
 246         clocksource_calculate_interval(clock, NTP_INTERVAL_LENGTH);
 247         clock->cycle_last = clocksource_read(clock);
 248
 249         xtime.tv_sec = sec;
 250         xtime.tv_nsec = 0;
 251         set_normalized_timespec(&wall_to_monotonic,
 252                 -xtime.tv_sec, -xtime.tv_nsec);
 253         total_sleep_time = 0;
 254
 255         write_sequnlock_irqrestore(&xtime_lock, flags);
 256 }
 257
 258 /* flag for if timekeeping is suspended */
 259 static int timekeeping_suspended;
 260 /* time in seconds when suspend began */
 261 static unsigned long timekeeping_suspend_time;
 262 /* xtime offset when we went into suspend */
 263 static s64 timekeeping_suspend_nsecs;
 264
 265 /**
 266  * timekeeping_resume - Resumes the generic timekeeping subsystem.
 267  * @dev:        unused
 268  *
 269  * This is for the generic clocksource timekeeping.
 270  * xtime/wall_to_monotonic/jiffies/etc are
 271  * still managed by arch specific suspend/resume code.
 272  */
 273 static int timekeeping_resume(struct sys_device *dev)
 274 {
 275         unsigned long flags;
 276         unsigned long now = read_persistent_clock();
 277
 278         clocksource_resume();
 279
 280         write_seqlock_irqsave(&xtime_lock, flags);
 281
 282         if (now && (now > timekeeping_suspend_time)) {
 283                 unsigned long sleep_length = now - timekeeping_suspend_time;
 284
 285                 xtime.tv_sec += sleep_length;
 286                 wall_to_monotonic.tv_sec -= sleep_length;
 287                 total_sleep_time += sleep_length;
 288         }
 289         /* Make sure that we have the correct xtime reference */
 290         timespec_add_ns(&xtime, timekeeping_suspend_nsecs);
 291         /* re-base the last cycle value */
 292         clock->cycle_last = clocksource_read(clock);
 293         clock->error = 0;
 294         timekeeping_suspended = 0;
 295         write_sequnlock_irqrestore(&xtime_lock, flags);
 296
 297         touch_softlockup_watchdog();
 298
 299         clockevents_notify(CLOCK_EVT_NOTIFY_RESUME, NULL);
 300
 301         /* Resume hrtimers */
 302         hres_timers_resume();
 303
 304         return 0;
 305 }
 306
 307 static int timekeeping_suspend(struct sys_device *dev, pm_message_t state)
 308 {
 309         unsigned long flags;
 310
 311         timekeeping_suspend_time = read_persistent_clock();
 312
 313         write_seqlock_irqsave(&xtime_lock, flags);
 314         /* Get the current xtime offset */
 315         timekeeping_suspend_nsecs = __get_nsec_offset();
 316         timekeeping_suspended = 1;
 317         write_sequnlock_irqrestore(&xtime_lock, flags);
 318
 319         clockevents_notify(CLOCK_EVT_NOTIFY_SUSPEND, NULL);
 320
 321         return 0;
 322 }
 323
 324 /* sysfs resume/suspend bits for timekeeping */
 325 static struct sysdev_class timekeeping_sysclass = {
 326         .name           = "timekeeping",
 327         .resume         = timekeeping_resume,
 328         .suspend        = timekeeping_suspend,
 329 };
 330
 331 static struct sys_device device_timer = {
 332         .id             = 0,
 333         .cls            = &timekeeping_sysclass,
 334 };
 335
 336 static int __init timekeeping_init_device(void)
 337 {
 338         int error = sysdev_class_register(&timekeeping_sysclass);
 339         if (!error)
 340                 error = sysdev_register(&device_timer);
 341         return error;
 342 }
 343
 344 device_initcall(timekeeping_init_device);
 345
 346 /*
 347  * If the error is already larger, we look ahead even further
 348  * to compensate for late or lost adjustments.
 349  */
 350 static __always_inline int clocksource_bigadjust(s64 error, s64 *interval,
 351                                                  s64 *offset)
 352 {
 353         s64 tick_error, i;
 354         u32 look_ahead, adj;
 355         s32 error2, mult;
 356
 357         /*
 358          * Use the current error value to determine how much to look ahead.
 359          * The larger the error the slower we adjust for it to avoid problems
 360          * with losing too many ticks, otherwise we would overadjust and
 361          * produce an even larger error.  The smaller the adjustment the
 362          * faster we try to adjust for it, as lost ticks can do less harm
 363          * here.  This is tuned so that an error of about 1 msec is adusted
 364          * within about 1 sec (or 2^20 nsec in 2^SHIFT_HZ ticks).
 365          */
 366         error2 = clock->error >> (TICK_LENGTH_SHIFT + 22 - 2 * SHIFT_HZ);
 367         error2 = abs(error2);
 368         for (look_ahead = 0; error2 > 0; look_ahead++)
 369                 error2 >>= 2;
 370
 371         /*
 372          * Now calculate the error in (1 << look_ahead) ticks, but first
 373          * remove the single look ahead already included in the error.
 374          */
 375         tick_error = current_tick_length() >>
 376                 (TICK_LENGTH_SHIFT - clock->shift + 1);
 377         tick_error -= clock->xtime_interval >> 1;
 378         error = ((error - tick_error) >> look_ahead) + tick_error;
 379
 380         /* Finally calculate the adjustment shift value.  */
 381         i = *interval;
 382         mult = 1;
 383         if (error < 0) {
 384                 error = -error;
 385                 *interval = -*interval;
 386                 *offset = -*offset;
 387                 mult = -1;
 388         }
 389         for (adj = 0; error > i; adj++)
 390                 error >>= 1;
 391
 392         *interval <<= adj;
 393         *offset <<= adj;
 394         return mult << adj;
 395 }
 396
 397 /*
 398  * Adjust the multiplier to reduce the error value,
 399  * this is optimized for the most common adjustments of -1,0,1,
 400  * for other values we can do a bit more work.
 401  */
 402 static void clocksource_adjust(s64 offset)
 403 {
 404         s64 error, interval = clock->cycle_interval;
 405         int adj;
 406
 407         error = clock->error >> (TICK_LENGTH_SHIFT - clock->shift - 1);
 408         if (error > interval) {
 409                 error >>= 2;
 410                 if (likely(error <= interval))
 411                         adj = 1;
 412                 else
 413                         adj = clocksource_bigadjust(error, &interval, &offset);
 414         } else if (error < -interval) {
 415                 error >>= 2;
 416                 if (likely(error >= -interval)) {
 417                         adj = -1;
 418                         interval = -interval;
 419                         offset = -offset;
 420                 } else
 421                         adj = clocksource_bigadjust(error, &interval, &offset);
 422         } else
 423                 return;
 424
 425         clock->mult += adj;
 426         clock->xtime_interval += interval;
 427         clock->xtime_nsec -= offset;
 428         clock->error -= (interval - offset) <<
 429                         (TICK_LENGTH_SHIFT - clock->shift);
 430 }
 431
 432 /**
 433  * update_wall_time - Uses the current clocksource to increment the wall time
 434  *
 435  * Called from the timer interrupt, must hold a write on xtime_lock.
 436  */
 437 void update_wall_time(void)
 438 {
 439         cycle_t offset;
 440
 441         /* Make sure we're fully resumed: */
 442         if (unlikely(timekeeping_suspended))
 443                 return;
 444
 445 #ifdef CONFIG_GENERIC_TIME
 446         offset = (clocksource_read(clock) - clock->cycle_last) & clock->mask;
 447 #else
 448         offset = clock->cycle_interval;
 449 #endif
 450         clock->xtime_nsec += (s64)xtime.tv_nsec << clock->shift;
 451
 452         /* normally this loop will run just once, however in the
 453          * case of lost or late ticks, it will accumulate correctly.
 454          */
 455         while (offset >= clock->cycle_interval) {
 456                 /* accumulate one interval */
 457                 clock->xtime_nsec += clock->xtime_interval;
 458                 clock->cycle_last += clock->cycle_interval;
 459                 offset -= clock->cycle_interval;
 460
 461                 if (clock->xtime_nsec >= (u64)NSEC_PER_SEC << clock->shift) {
 462                         clock->xtime_nsec -= (u64)NSEC_PER_SEC << clock->shift;
 463                         xtime.tv_sec++;
 464                         second_overflow();
 465                 }
 466
 467                 /* accumulate error between NTP and clock interval */
 468                 clock->error += current_tick_length();
 469                 clock->error -= clock->xtime_interval << (TICK_LENGTH_SHIFT - clock->shift);
 470         }
 471
 472         /* correct the clock when NTP error is too big */
 473         clocksource_adjust(offset);
 474
 475         /* store full nanoseconds into xtime */
 476         xtime.tv_nsec = (s64)clock->xtime_nsec >> clock->shift;
 477         clock->xtime_nsec -= (s64)xtime.tv_nsec << clock->shift;
 478
 479         update_xtime_cache(cyc2ns(clock, offset));
 480
 481         /* check to see if there is a new clocksource to use */
 482         change_clocksource();
 483         update_vsyscall(&xtime, clock);
 484 }
 485
 486 /**
 487  * getboottime - Return the real time of system boot.
 488  * @ts:         pointer to the timespec to be set
 489  *
 490  * Returns the time of day in a timespec.
 491  *
 492  * This is based on the wall_to_monotonic offset and the total suspend
 493  * time. Calls to settimeofday will affect the value returned (which
 494  * basically means that however wrong your real time clock is at boot time,
 495  * you get the right time here).
 496  */
 497 void getboottime(struct timespec *ts)
 498 {
 499         set_normalized_timespec(ts,
 500                 - (wall_to_monotonic.tv_sec + total_sleep_time),
 501                 - wall_to_monotonic.tv_nsec);
 502 }
 503
 504 /**
 505  * monotonic_to_bootbased - Convert the monotonic time to boot based.
 506  * @ts:         pointer to the timespec to be converted
 507  */
 508 void monotonic_to_bootbased(struct timespec *ts)
 509 {
 510         ts->tv_sec += total_sleep_time;
 511 }
 512
 513 unsigned long get_seconds(void)
 514 {
 515         return xtime_cache.tv_sec;
 516 }
 517 EXPORT_SYMBOL(get_seconds);
 518
 519
 520 struct timespec current_kernel_time(void)
 521 {
 522         struct timespec now;
 523         unsigned long seq;
 524
 525         do {
 526                 seq = read_seqbegin(&xtime_lock);
 527
 528                 now = xtime_cache;
 529         } while (read_seqretry(&xtime_lock, seq));
 530
 531         return now;
 532 }
 533 EXPORT_SYMBOL(current_kernel_time);