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