kernel/time/clocksource.c

   1 /*
   2  * linux/kernel/time/clocksource.c
   3  *
   4  * This file contains the functions which manage clocksource drivers.
   5  *
   6  * Copyright (C) 2004, 2005 IBM, John Stultz (johnstul@us.ibm.com)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * TODO WishList:
  23  *   o Allow clocksource drivers to be unregistered
  24  */
  25
  26 #include <linux/device.h>
  27 #include <linux/clocksource.h>
  28 #include <linux/init.h>
  29 #include <linux/module.h>
  30 #include <linux/sched.h> /* for spin_unlock_irq() using preempt_count() m68k */
  31 #include <linux/tick.h>
  32 #include <linux/kthread.h>
  33
  34 #include "tick-internal.h"
  35
  36 void timecounter_init(struct timecounter *tc,
  37                       const struct cyclecounter *cc,
  38                       u64 start_tstamp)
  39 {
  40         tc->cc = cc;
  41         tc->cycle_last = cc->read(cc);
  42         tc->nsec = start_tstamp;
  43 }
  44 EXPORT_SYMBOL_GPL(timecounter_init);
  45
  46 /**
  47  * timecounter_read_delta - get nanoseconds since last call of this function
  48  * @tc:         Pointer to time counter
  49  *
  50  * When the underlying cycle counter runs over, this will be handled
  51  * correctly as long as it does not run over more than once between
  52  * calls.
  53  *
  54  * The first call to this function for a new time counter initializes
  55  * the time tracking and returns an undefined result.
  56  */
  57 static u64 timecounter_read_delta(struct timecounter *tc)
  58 {
  59         cycle_t cycle_now, cycle_delta;
  60         u64 ns_offset;
  61
  62         /* read cycle counter: */
  63         cycle_now = tc->cc->read(tc->cc);
  64
  65         /* calculate the delta since the last timecounter_read_delta(): */
  66         cycle_delta = (cycle_now - tc->cycle_last) & tc->cc->mask;
  67
  68         /* convert to nanoseconds: */
  69         ns_offset = cyclecounter_cyc2ns(tc->cc, cycle_delta);
  70
  71         /* update time stamp of timecounter_read_delta() call: */
  72         tc->cycle_last = cycle_now;
  73
  74         return ns_offset;
  75 }
  76
  77 u64 timecounter_read(struct timecounter *tc)
  78 {
  79         u64 nsec;
  80
  81         /* increment time by nanoseconds since last call */
  82         nsec = timecounter_read_delta(tc);
  83         nsec += tc->nsec;
  84         tc->nsec = nsec;
  85
  86         return nsec;
  87 }
  88 EXPORT_SYMBOL_GPL(timecounter_read);
  89
  90 u64 timecounter_cyc2time(struct timecounter *tc,
  91                          cycle_t cycle_tstamp)
  92 {
  93         u64 cycle_delta = (cycle_tstamp - tc->cycle_last) & tc->cc->mask;
  94         u64 nsec;
  95
  96         /*
  97          * Instead of always treating cycle_tstamp as more recent
  98          * than tc->cycle_last, detect when it is too far in the
  99          * future and treat it as old time stamp instead.
 100          */
 101         if (cycle_delta > tc->cc->mask / 2) {
 102                 cycle_delta = (tc->cycle_last - cycle_tstamp) & tc->cc->mask;
 103                 nsec = tc->nsec - cyclecounter_cyc2ns(tc->cc, cycle_delta);
 104         } else {
 105                 nsec = cyclecounter_cyc2ns(tc->cc, cycle_delta) + tc->nsec;
 106         }
 107
 108         return nsec;
 109 }
 110 EXPORT_SYMBOL_GPL(timecounter_cyc2time);
 111
 112 /**
 113  * clocks_calc_mult_shift - calculate mult/shift factors for scaled math of clocks
 114  * @mult:       pointer to mult variable
 115  * @shift:      pointer to shift variable
 116  * @from:       frequency to convert from
 117  * @to:         frequency to convert to
 118  * @maxsec:     guaranteed runtime conversion range in seconds
 119  *
 120  * The function evaluates the shift/mult pair for the scaled math
 121  * operations of clocksources and clockevents.
 122  *
 123  * @to and @from are frequency values in HZ. For clock sources @to is
 124  * NSEC_PER_SEC == 1GHz and @from is the counter frequency. For clock
 125  * event @to is the counter frequency and @from is NSEC_PER_SEC.
 126  *
 127  * The @maxsec conversion range argument controls the time frame in
 128  * seconds which must be covered by the runtime conversion with the
 129  * calculated mult and shift factors. This guarantees that no 64bit
 130  * overflow happens when the input value of the conversion is
 131  * multiplied with the calculated mult factor. Larger ranges may
 132  * reduce the conversion accuracy by chosing smaller mult and shift
 133  * factors.
 134  */
 135 void
 136 clocks_calc_mult_shift(u32 *mult, u32 *shift, u32 from, u32 to, u32 maxsec)
 137 {
 138         u64 tmp;
 139         u32 sft, sftacc= 32;
 140
 141         /*
 142          * Calculate the shift factor which is limiting the conversion
 143          * range:
 144          */
 145         tmp = ((u64)maxsec * from) >> 32;
 146         while (tmp) {
 147                 tmp >>=1;
 148                 sftacc--;
 149         }
 150
 151         /*
 152          * Find the conversion shift/mult pair which has the best
 153          * accuracy and fits the maxsec conversion range:
 154          */
 155         for (sft = 32; sft > 0; sft--) {
 156                 tmp = (u64) to << sft;
 157                 tmp += from / 2;
 158                 do_div(tmp, from);
 159                 if ((tmp >> sftacc) == 0)
 160                         break;
 161         }
 162         *mult = tmp;
 163         *shift = sft;
 164 }
 165
 166 /*[Clocksource internal variables]---------
 167  * curr_clocksource:
 168  *      currently selected clocksource.
 169  * clocksource_list:
 170  *      linked list with the registered clocksources
 171  * clocksource_mutex:
 172  *      protects manipulations to curr_clocksource and the clocksource_list
 173  * override_name:
 174  *      Name of the user-specified clocksource.
 175  */
 176 static struct clocksource *curr_clocksource;
 177 static LIST_HEAD(clocksource_list);
 178 static DEFINE_MUTEX(clocksource_mutex);
 179 static char override_name[CS_NAME_LEN];
 180 static int finished_booting;
 181
 182 #ifdef CONFIG_CLOCKSOURCE_WATCHDOG
 183 static void clocksource_watchdog_work(struct work_struct *work);
 184 static void clocksource_select(void);
 185
 186 static LIST_HEAD(watchdog_list);
 187 static struct clocksource *watchdog;
 188 static struct timer_list watchdog_timer;
 189 static DECLARE_WORK(watchdog_work, clocksource_watchdog_work);
 190 static DEFINE_SPINLOCK(watchdog_lock);
 191 static int watchdog_running;
 192 static atomic_t watchdog_reset_pending;
 193
 194 static int clocksource_watchdog_kthread(void *data);
 195 static void __clocksource_change_rating(struct clocksource *cs, int rating);
 196
 197 /*
 198  * Interval: 0.5sec Threshold: 0.0625s
 199  */
 200 #define WATCHDOG_INTERVAL (HZ >> 1)
 201 #define WATCHDOG_THRESHOLD (NSEC_PER_SEC >> 4)
 202
 203 static void clocksource_watchdog_work(struct work_struct *work)
 204 {
 205         /*
 206          * If kthread_run fails the next watchdog scan over the
 207          * watchdog_list will find the unstable clock again.
 208          */
 209         kthread_run(clocksource_watchdog_kthread, NULL, "kwatchdog");
 210 }
 211
 212 static void __clocksource_unstable(struct clocksource *cs)
 213 {
 214         cs->flags &= ~(CLOCK_SOURCE_VALID_FOR_HRES | CLOCK_SOURCE_WATCHDOG);
 215         cs->flags |= CLOCK_SOURCE_UNSTABLE;
 216         if (finished_booting)
 217                 schedule_work(&watchdog_work);
 218 }
 219
 220 static void clocksource_unstable(struct clocksource *cs, int64_t delta)
 221 {
 222         printk(KERN_WARNING "Clocksource %s unstable (delta = %Ld ns)\n",
 223                cs->name, delta);
 224         __clocksource_unstable(cs);
 225 }
 226
 227 /**
 228  * clocksource_mark_unstable - mark clocksource unstable via watchdog
 229  * @cs:         clocksource to be marked unstable
 230  *
 231  * This function is called instead of clocksource_change_rating from
 232  * cpu hotplug code to avoid a deadlock between the clocksource mutex
 233  * and the cpu hotplug mutex. It defers the update of the clocksource
 234  * to the watchdog thread.
 235  */
 236 void clocksource_mark_unstable(struct clocksource *cs)
 237 {
 238         unsigned long flags;
 239
 240         spin_lock_irqsave(&watchdog_lock, flags);
 241         if (!(cs->flags & CLOCK_SOURCE_UNSTABLE)) {
 242                 if (list_empty(&cs->wd_list))
 243                         list_add(&cs->wd_list, &watchdog_list);
 244                 __clocksource_unstable(cs);
 245         }
 246         spin_unlock_irqrestore(&watchdog_lock, flags);
 247 }
 248
 249 static void clocksource_watchdog(unsigned long data)
 250 {
 251         struct clocksource *cs;
 252         cycle_t csnow, wdnow;
 253         int64_t wd_nsec, cs_nsec;
 254         int next_cpu, reset_pending;
 255
 256         spin_lock(&watchdog_lock);
 257         if (!watchdog_running)
 258                 goto out;
 259
 260         reset_pending = atomic_read(&watchdog_reset_pending);
 261
 262         list_for_each_entry(cs, &watchdog_list, wd_list) {
 263
 264                 /* Clocksource already marked unstable? */
 265                 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
 266                         if (finished_booting)
 267                                 schedule_work(&watchdog_work);
 268                         continue;
 269                 }
 270
 271                 local_irq_disable();
 272                 csnow = cs->read(cs);
 273                 wdnow = watchdog->read(watchdog);
 274                 local_irq_enable();
 275
 276                 /* Clocksource initialized ? */
 277                 if (!(cs->flags & CLOCK_SOURCE_WATCHDOG) ||
 278                     atomic_read(&watchdog_reset_pending)) {
 279                         cs->flags |= CLOCK_SOURCE_WATCHDOG;
 280                         cs->wd_last = wdnow;
 281                         cs->cs_last = csnow;
 282                         continue;
 283                 }
 284
 285                 wd_nsec = clocksource_cyc2ns((wdnow - cs->wd_last) & watchdog->mask,
 286                                              watchdog->mult, watchdog->shift);
 287
 288                 cs_nsec = clocksource_cyc2ns((csnow - cs->cs_last) &
 289                                              cs->mask, cs->mult, cs->shift);
 290                 cs->cs_last = csnow;
 291                 cs->wd_last = wdnow;
 292
 293                 if (atomic_read(&watchdog_reset_pending))
 294                         continue;
 295
 296                 /* Check the deviation from the watchdog clocksource. */
 297                 if ((abs(cs_nsec - wd_nsec) > WATCHDOG_THRESHOLD)) {
 298                         clocksource_unstable(cs, cs_nsec - wd_nsec);
 299                         continue;
 300                 }
 301
 302                 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) &&
 303                     (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS) &&
 304                     (watchdog->flags & CLOCK_SOURCE_IS_CONTINUOUS)) {
 305                         /* Mark it valid for high-res. */
 306                         cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 307
 308                         /*
 309                          * clocksource_done_booting() will sort it if
 310                          * finished_booting is not set yet.
 311                          */
 312                         if (!finished_booting)
 313                                 continue;
 314
 315                         /*
 316                          * If this is not the current clocksource let
 317                          * the watchdog thread reselect it. Due to the
 318                          * change to high res this clocksource might
 319                          * be preferred now. If it is the current
 320                          * clocksource let the tick code know about
 321                          * that change.
 322                          */
 323                         if (cs != curr_clocksource) {
 324                                 cs->flags |= CLOCK_SOURCE_RESELECT;
 325                                 schedule_work(&watchdog_work);
 326                         } else {
 327                                 tick_clock_notify();
 328                         }
 329                 }
 330         }
 331
 332         /*
 333          * We only clear the watchdog_reset_pending, when we did a
 334          * full cycle through all clocksources.
 335          */
 336         if (reset_pending)
 337                 atomic_dec(&watchdog_reset_pending);
 338
 339         /*
 340          * Cycle through CPUs to check if the CPUs stay synchronized
 341          * to each other.
 342          */
 343         next_cpu = cpumask_next(raw_smp_processor_id(), cpu_online_mask);
 344         if (next_cpu >= nr_cpu_ids)
 345                 next_cpu = cpumask_first(cpu_online_mask);
 346         watchdog_timer.expires += WATCHDOG_INTERVAL;
 347         add_timer_on(&watchdog_timer, next_cpu);
 348 out:
 349         spin_unlock(&watchdog_lock);
 350 }
 351
 352 static inline void clocksource_start_watchdog(void)
 353 {
 354         if (watchdog_running || !watchdog || list_empty(&watchdog_list))
 355                 return;
 356         init_timer(&watchdog_timer);
 357         watchdog_timer.function = clocksource_watchdog;
 358         watchdog_timer.expires = jiffies + WATCHDOG_INTERVAL;
 359         add_timer_on(&watchdog_timer, cpumask_first(cpu_online_mask));
 360         watchdog_running = 1;
 361 }
 362
 363 static inline void clocksource_stop_watchdog(void)
 364 {
 365         if (!watchdog_running || (watchdog && !list_empty(&watchdog_list)))
 366                 return;
 367         del_timer(&watchdog_timer);
 368         watchdog_running = 0;
 369 }
 370
 371 static inline void clocksource_reset_watchdog(void)
 372 {
 373         struct clocksource *cs;
 374
 375         list_for_each_entry(cs, &watchdog_list, wd_list)
 376                 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
 377 }
 378
 379 static void clocksource_resume_watchdog(void)
 380 {
 381         atomic_inc(&watchdog_reset_pending);
 382 }
 383
 384 static void clocksource_enqueue_watchdog(struct clocksource *cs)
 385 {
 386         unsigned long flags;
 387
 388         spin_lock_irqsave(&watchdog_lock, flags);
 389         if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
 390                 /* cs is a clocksource to be watched. */
 391                 list_add(&cs->wd_list, &watchdog_list);
 392                 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
 393         } else {
 394                 /* cs is a watchdog. */
 395                 if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
 396                         cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 397                 /* Pick the best watchdog. */
 398                 if (!watchdog || cs->rating > watchdog->rating) {
 399                         watchdog = cs;
 400                         /* Reset watchdog cycles */
 401                         clocksource_reset_watchdog();
 402                 }
 403         }
 404         /* Check if the watchdog timer needs to be started. */
 405         clocksource_start_watchdog();
 406         spin_unlock_irqrestore(&watchdog_lock, flags);
 407 }
 408
 409 static void clocksource_dequeue_watchdog(struct clocksource *cs)
 410 {
 411         unsigned long flags;
 412
 413         spin_lock_irqsave(&watchdog_lock, flags);
 414         if (cs != watchdog) {
 415                 if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
 416                         /* cs is a watched clocksource. */
 417                         list_del_init(&cs->wd_list);
 418                         /* Check if the watchdog timer needs to be stopped. */
 419                         clocksource_stop_watchdog();
 420                 }
 421         }
 422         spin_unlock_irqrestore(&watchdog_lock, flags);
 423 }
 424
 425 static int __clocksource_watchdog_kthread(void)
 426 {
 427         struct clocksource *cs, *tmp;
 428         unsigned long flags;
 429         LIST_HEAD(unstable);
 430         int select = 0;
 431
 432         spin_lock_irqsave(&watchdog_lock, flags);
 433         list_for_each_entry_safe(cs, tmp, &watchdog_list, wd_list) {
 434                 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
 435                         list_del_init(&cs->wd_list);
 436                         list_add(&cs->wd_list, &unstable);
 437                         select = 1;
 438                 }
 439                 if (cs->flags & CLOCK_SOURCE_RESELECT) {
 440                         cs->flags &= ~CLOCK_SOURCE_RESELECT;
 441                         select = 1;
 442                 }
 443         }
 444         /* Check if the watchdog timer needs to be stopped. */
 445         clocksource_stop_watchdog();
 446         spin_unlock_irqrestore(&watchdog_lock, flags);
 447
 448         /* Needs to be done outside of watchdog lock */
 449         list_for_each_entry_safe(cs, tmp, &unstable, wd_list) {
 450                 list_del_init(&cs->wd_list);
 451                 __clocksource_change_rating(cs, 0);
 452         }
 453         return select;
 454 }
 455
 456 static int clocksource_watchdog_kthread(void *data)
 457 {
 458         mutex_lock(&clocksource_mutex);
 459         if (__clocksource_watchdog_kthread())
 460                 clocksource_select();
 461         mutex_unlock(&clocksource_mutex);
 462         return 0;
 463 }
 464
 465 static bool clocksource_is_watchdog(struct clocksource *cs)
 466 {
 467         return cs == watchdog;
 468 }
 469
 470 #else /* CONFIG_CLOCKSOURCE_WATCHDOG */
 471
 472 static void clocksource_enqueue_watchdog(struct clocksource *cs)
 473 {
 474         if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
 475                 cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 476 }
 477
 478 static inline void clocksource_dequeue_watchdog(struct clocksource *cs) { }
 479 static inline void clocksource_resume_watchdog(void) { }
 480 static inline int __clocksource_watchdog_kthread(void) { return 0; }
 481 static bool clocksource_is_watchdog(struct clocksource *cs) { return false; }
 482 void clocksource_mark_unstable(struct clocksource *cs) { }
 483
 484 #endif /* CONFIG_CLOCKSOURCE_WATCHDOG */
 485
 486 /**
 487  * clocksource_suspend - suspend the clocksource(s)
 488  */
 489 void clocksource_suspend(void)
 490 {
 491         struct clocksource *cs;
 492
 493         list_for_each_entry_reverse(cs, &clocksource_list, list)
 494                 if (cs->suspend)
 495                         cs->suspend(cs);
 496 }
 497
 498 /**
 499  * clocksource_resume - resume the clocksource(s)
 500  */
 501 void clocksource_resume(void)
 502 {
 503         struct clocksource *cs;
 504
 505         list_for_each_entry(cs, &clocksource_list, list)
 506                 if (cs->resume)
 507                         cs->resume(cs);
 508
 509         clocksource_resume_watchdog();
 510 }
 511
 512 /**
 513  * clocksource_touch_watchdog - Update watchdog
 514  *
 515  * Update the watchdog after exception contexts such as kgdb so as not
 516  * to incorrectly trip the watchdog. This might fail when the kernel
 517  * was stopped in code which holds watchdog_lock.
 518  */
 519 void clocksource_touch_watchdog(void)
 520 {
 521         clocksource_resume_watchdog();
 522 }
 523
 524 /**
 525  * clocksource_max_adjustment- Returns max adjustment amount
 526  * @cs:         Pointer to clocksource
 527  *
 528  */
 529 static u32 clocksource_max_adjustment(struct clocksource *cs)
 530 {
 531         u64 ret;
 532         /*
 533          * We won't try to correct for more than 11% adjustments (110,000 ppm),
 534          */
 535         ret = (u64)cs->mult * 11;
 536         do_div(ret,100);
 537         return (u32)ret;
 538 }
 539
 540 /**
 541  * clocksource_max_deferment - Returns max time the clocksource can be deferred
 542  * @cs:         Pointer to clocksource
 543  *
 544  */
 545 static u64 clocksource_max_deferment(struct clocksource *cs)
 546 {
 547         u64 max_nsecs, max_cycles;
 548
 549         /*
 550          * Calculate the maximum number of cycles that we can pass to the
 551          * cyc2ns function without overflowing a 64-bit signed result. The
 552          * maximum number of cycles is equal to ULLONG_MAX/(cs->mult+cs->maxadj)
 553          * which is equivalent to the below.
 554          * max_cycles < (2^63)/(cs->mult + cs->maxadj)
 555          * max_cycles < 2^(log2((2^63)/(cs->mult + cs->maxadj)))
 556          * max_cycles < 2^(log2(2^63) - log2(cs->mult + cs->maxadj))
 557          * max_cycles < 2^(63 - log2(cs->mult + cs->maxadj))
 558          * max_cycles < 1 << (63 - log2(cs->mult + cs->maxadj))
 559          * Please note that we add 1 to the result of the log2 to account for
 560          * any rounding errors, ensure the above inequality is satisfied and
 561          * no overflow will occur.
 562          */
 563         max_cycles = 1ULL << (63 - (ilog2(cs->mult + cs->maxadj) + 1));
 564
 565         /*
 566          * The actual maximum number of cycles we can defer the clocksource is
 567          * determined by the minimum of max_cycles and cs->mask.
 568          * Note: Here we subtract the maxadj to make sure we don't sleep for
 569          * too long if there's a large negative adjustment.
 570          */
 571         max_cycles = min_t(u64, max_cycles, (u64) cs->mask);
 572         max_nsecs = clocksource_cyc2ns(max_cycles, cs->mult - cs->maxadj,
 573                                         cs->shift);
 574
 575         /*
 576          * To ensure that the clocksource does not wrap whilst we are idle,
 577          * limit the time the clocksource can be deferred by 12.5%. Please
 578          * note a margin of 12.5% is used because this can be computed with
 579          * a shift, versus say 10% which would require division.
 580          */
 581         return max_nsecs - (max_nsecs >> 3);
 582 }
 583
 584 #ifndef CONFIG_ARCH_USES_GETTIMEOFFSET
 585
 586 static struct clocksource *clocksource_find_best(bool oneshot, bool skipcur)
 587 {
 588         struct clocksource *cs;
 589
 590         if (!finished_booting || list_empty(&clocksource_list))
 591                 return NULL;
 592
 593         /*
 594          * We pick the clocksource with the highest rating. If oneshot
 595          * mode is active, we pick the highres valid clocksource with
 596          * the best rating.
 597          */
 598         list_for_each_entry(cs, &clocksource_list, list) {
 599                 if (skipcur && cs == curr_clocksource)
 600                         continue;
 601                 if (oneshot && !(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES))
 602                         continue;
 603                 return cs;
 604         }
 605         return NULL;
 606 }
 607
 608 static void __clocksource_select(bool skipcur)
 609 {
 610         bool oneshot = tick_oneshot_mode_active();
 611         struct clocksource *best, *cs;
 612
 613         /* Find the best suitable clocksource */
 614         best = clocksource_find_best(oneshot, skipcur);
 615         if (!best)
 616                 return;
 617
 618         /* Check for the override clocksource. */
 619         list_for_each_entry(cs, &clocksource_list, list) {
 620                 if (skipcur && cs == curr_clocksource)
 621                         continue;
 622                 if (strcmp(cs->name, override_name) != 0)
 623                         continue;
 624                 /*
 625                  * Check to make sure we don't switch to a non-highres
 626                  * capable clocksource if the tick code is in oneshot
 627                  * mode (highres or nohz)
 628                  */
 629                 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) && oneshot) {
 630                         /* Override clocksource cannot be used. */
 631                         printk(KERN_WARNING "Override clocksource %s is not "
 632                                "HRT compatible. Cannot switch while in "
 633                                "HRT/NOHZ mode\n", cs->name);
 634                         override_name[0] = 0;
 635                 } else
 636                         /* Override clocksource can be used. */
 637                         best = cs;
 638                 break;
 639         }
 640
 641         if (curr_clocksource != best && !timekeeping_notify(best)) {
 642                 pr_info("Switched to clocksource %s\n", best->name);
 643                 curr_clocksource = best;
 644         }
 645 }
 646
 647 /**
 648  * clocksource_select - Select the best clocksource available
 649  *
 650  * Private function. Must hold clocksource_mutex when called.
 651  *
 652  * Select the clocksource with the best rating, or the clocksource,
 653  * which is selected by userspace override.
 654  */
 655 static void clocksource_select(void)
 656 {
 657         return __clocksource_select(false);
 658 }
 659
 660 static void clocksource_select_fallback(void)
 661 {
 662         return __clocksource_select(true);
 663 }
 664
 665 #else /* !CONFIG_ARCH_USES_GETTIMEOFFSET */
 666
 667 static inline void clocksource_select(void) { }
 668 static inline void clocksource_select_fallback(void) { }
 669
 670 #endif
 671
 672 /*
 673  * clocksource_done_booting - Called near the end of core bootup
 674  *
 675  * Hack to avoid lots of clocksource churn at boot time.
 676  * We use fs_initcall because we want this to start before
 677  * device_initcall but after subsys_initcall.
 678  */
 679 static int __init clocksource_done_booting(void)
 680 {
 681         mutex_lock(&clocksource_mutex);
 682         curr_clocksource = clocksource_default_clock();
 683         finished_booting = 1;
 684         /*
 685          * Run the watchdog first to eliminate unstable clock sources
 686          */
 687         __clocksource_watchdog_kthread();
 688         clocksource_select();
 689         mutex_unlock(&clocksource_mutex);
 690         return 0;
 691 }
 692 fs_initcall(clocksource_done_booting);
 693
 694 /*
 695  * Enqueue the clocksource sorted by rating
 696  */
 697 static void clocksource_enqueue(struct clocksource *cs)
 698 {
 699         struct list_head *entry = &clocksource_list;
 700         struct clocksource *tmp;
 701
 702         list_for_each_entry(tmp, &clocksource_list, list)
 703                 /* Keep track of the place, where to insert */
 704                 if (tmp->rating >= cs->rating)
 705                         entry = &tmp->list;
 706         list_add(&cs->list, entry);
 707 }
 708
 709 /**
 710  * __clocksource_updatefreq_scale - Used update clocksource with new freq
 711  * @cs:         clocksource to be registered
 712  * @scale:      Scale factor multiplied against freq to get clocksource hz
 713  * @freq:       clocksource frequency (cycles per second) divided by scale
 714  *
 715  * This should only be called from the clocksource->enable() method.
 716  *
 717  * This *SHOULD NOT* be called directly! Please use the
 718  * clocksource_updatefreq_hz() or clocksource_updatefreq_khz helper functions.
 719  */
 720 void __clocksource_updatefreq_scale(struct clocksource *cs, u32 scale, u32 freq)
 721 {
 722         u64 sec;
 723         /*
 724          * Calc the maximum number of seconds which we can run before
 725          * wrapping around. For clocksources which have a mask > 32bit
 726          * we need to limit the max sleep time to have a good
 727          * conversion precision. 10 minutes is still a reasonable
 728          * amount. That results in a shift value of 24 for a
 729          * clocksource with mask >= 40bit and f >= 4GHz. That maps to
 730          * ~ 0.06ppm granularity for NTP. We apply the same 12.5%
 731          * margin as we do in clocksource_max_deferment()
 732          */
 733         sec = (cs->mask - (cs->mask >> 3));
 734         do_div(sec, freq);
 735         do_div(sec, scale);
 736         if (!sec)
 737                 sec = 1;
 738         else if (sec > 600 && cs->mask > UINT_MAX)
 739                 sec = 600;
 740
 741         clocks_calc_mult_shift(&cs->mult, &cs->shift, freq,
 742                                NSEC_PER_SEC / scale, sec * scale);
 743
 744         /*
 745          * for clocksources that have large mults, to avoid overflow.
 746          * Since mult may be adjusted by ntp, add an safety extra margin
 747          *
 748          */
 749         cs->maxadj = clocksource_max_adjustment(cs);
 750         while ((cs->mult + cs->maxadj < cs->mult)
 751                 || (cs->mult - cs->maxadj > cs->mult)) {
 752                 cs->mult >>= 1;
 753                 cs->shift--;
 754                 cs->maxadj = clocksource_max_adjustment(cs);
 755         }
 756
 757         cs->max_idle_ns = clocksource_max_deferment(cs);
 758 }
 759 EXPORT_SYMBOL_GPL(__clocksource_updatefreq_scale);
 760
 761 /**
 762  * __clocksource_register_scale - Used to install new clocksources
 763  * @cs:         clocksource to be registered
 764  * @scale:      Scale factor multiplied against freq to get clocksource hz
 765  * @freq:       clocksource frequency (cycles per second) divided by scale
 766  *
 767  * Returns -EBUSY if registration fails, zero otherwise.
 768  *
 769  * This *SHOULD NOT* be called directly! Please use the
 770  * clocksource_register_hz() or clocksource_register_khz helper functions.
 771  */
 772 int __clocksource_register_scale(struct clocksource *cs, u32 scale, u32 freq)
 773 {
 774
 775         /* Initialize mult/shift and max_idle_ns */
 776         __clocksource_updatefreq_scale(cs, scale, freq);
 777
 778         /* Add clocksource to the clcoksource list */
 779         mutex_lock(&clocksource_mutex);
 780         clocksource_enqueue(cs);
 781         clocksource_enqueue_watchdog(cs);
 782         clocksource_select();
 783         mutex_unlock(&clocksource_mutex);
 784         return 0;
 785 }
 786 EXPORT_SYMBOL_GPL(__clocksource_register_scale);
 787
 788
 789 /**
 790  * clocksource_register - Used to install new clocksources
 791  * @cs:         clocksource to be registered
 792  *
 793  * Returns -EBUSY if registration fails, zero otherwise.
 794  */
 795 int clocksource_register(struct clocksource *cs)
 796 {
 797         /* calculate max adjustment for given mult/shift */
 798         cs->maxadj = clocksource_max_adjustment(cs);
 799         WARN_ONCE(cs->mult + cs->maxadj < cs->mult,
 800                 "Clocksource %s might overflow on 11%% adjustment\n",
 801                 cs->name);
 802
 803         /* calculate max idle time permitted for this clocksource */
 804         cs->max_idle_ns = clocksource_max_deferment(cs);
 805
 806         mutex_lock(&clocksource_mutex);
 807         clocksource_enqueue(cs);
 808         clocksource_enqueue_watchdog(cs);
 809         clocksource_select();
 810         mutex_unlock(&clocksource_mutex);
 811         return 0;
 812 }
 813 EXPORT_SYMBOL(clocksource_register);
 814
 815 static void __clocksource_change_rating(struct clocksource *cs, int rating)
 816 {
 817         list_del(&cs->list);
 818         cs->rating = rating;
 819         clocksource_enqueue(cs);
 820 }
 821
 822 /**
 823  * clocksource_change_rating - Change the rating of a registered clocksource
 824  * @cs:         clocksource to be changed
 825  * @rating:     new rating
 826  */
 827 void clocksource_change_rating(struct clocksource *cs, int rating)
 828 {
 829         mutex_lock(&clocksource_mutex);
 830         __clocksource_change_rating(cs, rating);
 831         clocksource_select();
 832         mutex_unlock(&clocksource_mutex);
 833 }
 834 EXPORT_SYMBOL(clocksource_change_rating);
 835
 836 /*
 837  * Unbind clocksource @cs. Called with clocksource_mutex held
 838  */
 839 static int clocksource_unbind(struct clocksource *cs)
 840 {
 841         /*
 842          * I really can't convince myself to support this on hardware
 843          * designed by lobotomized monkeys.
 844          */
 845         if (clocksource_is_watchdog(cs))
 846                 return -EBUSY;
 847
 848         if (cs == curr_clocksource) {
 849                 /* Select and try to install a replacement clock source */
 850                 clocksource_select_fallback();
 851                 if (curr_clocksource == cs)
 852                         return -EBUSY;
 853         }
 854         clocksource_dequeue_watchdog(cs);
 855         list_del_init(&cs->list);
 856         return 0;
 857 }
 858
 859 /**
 860  * clocksource_unregister - remove a registered clocksource
 861  * @cs: clocksource to be unregistered
 862  */
 863 int clocksource_unregister(struct clocksource *cs)
 864 {
 865         int ret = 0;
 866
 867         mutex_lock(&clocksource_mutex);
 868         if (!list_empty(&cs->list))
 869                 ret = clocksource_unbind(cs);
 870         mutex_unlock(&clocksource_mutex);
 871         return ret;
 872 }
 873 EXPORT_SYMBOL(clocksource_unregister);
 874
 875 #ifdef CONFIG_SYSFS
 876 /**
 877  * sysfs_show_current_clocksources - sysfs interface for current clocksource
 878  * @dev:        unused
 879  * @attr:       unused
 880  * @buf:        char buffer to be filled with clocksource list
 881  *
 882  * Provides sysfs interface for listing current clocksource.
 883  */
 884 static ssize_t
 885 sysfs_show_current_clocksources(struct device *dev,
 886                                 struct device_attribute *attr, char *buf)
 887 {
 888         ssize_t count = 0;
 889
 890         mutex_lock(&clocksource_mutex);
 891         count = snprintf(buf, PAGE_SIZE, "%s\n", curr_clocksource->name);
 892         mutex_unlock(&clocksource_mutex);
 893
 894         return count;
 895 }
 896
 897 size_t sysfs_get_uname(const char *buf, char *dst, size_t cnt)
 898 {
 899         size_t ret = cnt;
 900
 901         /* strings from sysfs write are not 0 terminated! */
 902         if (!cnt || cnt >= CS_NAME_LEN)
 903                 return -EINVAL;
 904
 905         /* strip of \n: */
 906         if (buf[cnt-1] == '\n')
 907                 cnt--;
 908         if (cnt > 0)
 909                 memcpy(dst, buf, cnt);
 910         dst[cnt] = 0;
 911         return ret;
 912 }
 913
 914 /**
 915  * sysfs_override_clocksource - interface for manually overriding clocksource
 916  * @dev:        unused
 917  * @attr:       unused
 918  * @buf:        name of override clocksource
 919  * @count:      length of buffer
 920  *
 921  * Takes input from sysfs interface for manually overriding the default
 922  * clocksource selection.
 923  */
 924 static ssize_t sysfs_override_clocksource(struct device *dev,
 925                                           struct device_attribute *attr,
 926                                           const char *buf, size_t count)
 927 {
 928         size_t ret;
 929
 930         mutex_lock(&clocksource_mutex);
 931
 932         ret = sysfs_get_uname(buf, override_name, count);
 933         if (ret >= 0)
 934                 clocksource_select();
 935
 936         mutex_unlock(&clocksource_mutex);
 937
 938         return ret;
 939 }
 940
 941 /**
 942  * sysfs_unbind_current_clocksource - interface for manually unbinding clocksource
 943  * @dev:        unused
 944  * @attr:       unused
 945  * @buf:        unused
 946  * @count:      length of buffer
 947  *
 948  * Takes input from sysfs interface for manually unbinding a clocksource.
 949  */
 950 static ssize_t sysfs_unbind_clocksource(struct device *dev,
 951                                         struct device_attribute *attr,
 952                                         const char *buf, size_t count)
 953 {
 954         struct clocksource *cs;
 955         char name[CS_NAME_LEN];
 956         size_t ret;
 957
 958         ret = sysfs_get_uname(buf, name, count);
 959         if (ret < 0)
 960                 return ret;
 961
 962         ret = -ENODEV;
 963         mutex_lock(&clocksource_mutex);
 964         list_for_each_entry(cs, &clocksource_list, list) {
 965                 if (strcmp(cs->name, name))
 966                         continue;
 967                 ret = clocksource_unbind(cs);
 968                 break;
 969         }
 970         mutex_unlock(&clocksource_mutex);
 971
 972         return ret ? ret : count;
 973 }
 974
 975 /**
 976  * sysfs_show_available_clocksources - sysfs interface for listing clocksource
 977  * @dev:        unused
 978  * @attr:       unused
 979  * @buf:        char buffer to be filled with clocksource list
 980  *
 981  * Provides sysfs interface for listing registered clocksources
 982  */
 983 static ssize_t
 984 sysfs_show_available_clocksources(struct device *dev,
 985                                   struct device_attribute *attr,
 986                                   char *buf)
 987 {
 988         struct clocksource *src;
 989         ssize_t count = 0;
 990
 991         mutex_lock(&clocksource_mutex);
 992         list_for_each_entry(src, &clocksource_list, list) {
 993                 /*
 994                  * Don't show non-HRES clocksource if the tick code is
 995                  * in one shot mode (highres=on or nohz=on)
 996                  */
 997                 if (!tick_oneshot_mode_active() ||
 998                     (src->flags & CLOCK_SOURCE_VALID_FOR_HRES))
 999                         count += snprintf(buf + count,
1000                                   max((ssize_t)PAGE_SIZE - count, (ssize_t)0),
1001                                   "%s ", src->name);
1002         }
1003         mutex_unlock(&clocksource_mutex);
1004
1005         count += snprintf(buf + count,
1006                           max((ssize_t)PAGE_SIZE - count, (ssize_t)0), "\n");
1007
1008         return count;
1009 }
1010
1011 /*
1012  * Sysfs setup bits:
1013  */
1014 static DEVICE_ATTR(current_clocksource, 0644, sysfs_show_current_clocksources,
1015                    sysfs_override_clocksource);
1016
1017 static DEVICE_ATTR(unbind_clocksource, 0200, NULL, sysfs_unbind_clocksource);
1018
1019 static DEVICE_ATTR(available_clocksource, 0444,
1020                    sysfs_show_available_clocksources, NULL);
1021
1022 static struct bus_type clocksource_subsys = {
1023         .name = "clocksource",
1024         .dev_name = "clocksource",
1025 };
1026
1027 static struct device device_clocksource = {
1028         .id     = 0,
1029         .bus    = &clocksource_subsys,
1030 };
1031
1032 static int __init init_clocksource_sysfs(void)
1033 {
1034         int error = subsys_system_register(&clocksource_subsys, NULL);
1035
1036         if (!error)
1037                 error = device_register(&device_clocksource);
1038         if (!error)
1039                 error = device_create_file(
1040                                 &device_clocksource,
1041                                 &dev_attr_current_clocksource);
1042         if (!error)
1043                 error = device_create_file(&device_clocksource,
1044                                            &dev_attr_unbind_clocksource);
1045         if (!error)
1046                 error = device_create_file(
1047                                 &device_clocksource,
1048                                 &dev_attr_available_clocksource);
1049         return error;
1050 }
1051
1052 device_initcall(init_clocksource_sysfs);
1053 #endif /* CONFIG_SYSFS */
1054
1055 /**
1056  * boot_override_clocksource - boot clock override
1057  * @str:        override name
1058  *
1059  * Takes a clocksource= boot argument and uses it
1060  * as the clocksource override name.
1061  */
1062 static int __init boot_override_clocksource(char* str)
1063 {
1064         mutex_lock(&clocksource_mutex);
1065         if (str)
1066                 strlcpy(override_name, str, sizeof(override_name));
1067         mutex_unlock(&clocksource_mutex);
1068         return 1;
1069 }
1070
1071 __setup("clocksource=", boot_override_clocksource);
1072
1073 /**
1074  * boot_override_clock - Compatibility layer for deprecated boot option
1075  * @str:        override name
1076  *
1077  * DEPRECATED! Takes a clock= boot argument and uses it
1078  * as the clocksource override name
1079  */
1080 static int __init boot_override_clock(char* str)
1081 {
1082         if (!strcmp(str, "pmtmr")) {
1083                 printk("Warning: clock=pmtmr is deprecated. "
1084                         "Use clocksource=acpi_pm.\n");
1085                 return boot_override_clocksource("acpi_pm");
1086         }
1087         printk("Warning! clock= boot option is deprecated. "
1088                 "Use clocksource=xyz\n");
1089         return boot_override_clocksource(str);
1090 }
1091
1092 __setup("clock=", boot_override_clock);