kernel/sched/clock.c

   1 /*
   2  * sched_clock for unstable cpu clocks
   3  *
   4  *  Copyright (C) 2008 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
   5  *
   6  *  Updates and enhancements:
   7  *    Copyright (C) 2008 Red Hat, Inc. Steven Rostedt <srostedt@redhat.com>
   8  *
   9  * Based on code by:
  10  *   Ingo Molnar <mingo@redhat.com>
  11  *   Guillaume Chazarain <guichaz@gmail.com>
  12  *
  13  *
  14  * What:
  15  *
  16  * cpu_clock(i) provides a fast (execution time) high resolution
  17  * clock with bounded drift between CPUs. The value of cpu_clock(i)
  18  * is monotonic for constant i. The timestamp returned is in nanoseconds.
  19  *
  20  * ######################### BIG FAT WARNING ##########################
  21  * # when comparing cpu_clock(i) to cpu_clock(j) for i != j, time can #
  22  * # go backwards !!                                                  #
  23  * ####################################################################
  24  *
  25  * There is no strict promise about the base, although it tends to start
  26  * at 0 on boot (but people really shouldn't rely on that).
  27  *
  28  * cpu_clock(i)       -- can be used from any context, including NMI.
  29  * local_clock()      -- is cpu_clock() on the current cpu.
  30  *
  31  * sched_clock_cpu(i)
  32  *
  33  * How:
  34  *
  35  * The implementation either uses sched_clock() when
  36  * !CONFIG_HAVE_UNSTABLE_SCHED_CLOCK, which means in that case the
  37  * sched_clock() is assumed to provide these properties (mostly it means
  38  * the architecture provides a globally synchronized highres time source).
  39  *
  40  * Otherwise it tries to create a semi stable clock from a mixture of other
  41  * clocks, including:
  42  *
  43  *  - GTOD (clock monotomic)
  44  *  - sched_clock()
  45  *  - explicit idle events
  46  *
  47  * We use GTOD as base and use sched_clock() deltas to improve resolution. The
  48  * deltas are filtered to provide monotonicity and keeping it within an
  49  * expected window.
  50  *
  51  * Furthermore, explicit sleep and wakeup hooks allow us to account for time
  52  * that is otherwise invisible (TSC gets stopped).
  53  *
  54  */
  55 #include <linux/spinlock.h>
  56 #include <linux/hardirq.h>
  57 #include <linux/export.h>
  58 #include <linux/percpu.h>
  59 #include <linux/ktime.h>
  60 #include <linux/sched.h>
  61
  62 /*
  63  * Scheduler clock - returns current time in nanosec units.
  64  * This is default implementation.
  65  * Architectures and sub-architectures can override this.
  66  */
  67 unsigned long long __attribute__((weak)) sched_clock(void)
  68 {
  69         return (unsigned long long)(jiffies - INITIAL_JIFFIES)
  70                                         * (NSEC_PER_SEC / HZ);
  71 }
  72 EXPORT_SYMBOL_GPL(sched_clock);
  73
  74 __read_mostly int sched_clock_running;
  75
  76 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
  77 __read_mostly int sched_clock_stable;
  78
  79 struct sched_clock_data {
  80         u64                     tick_raw;
  81         u64                     tick_gtod;
  82         u64                     clock;
  83 };
  84
  85 static DEFINE_PER_CPU_SHARED_ALIGNED(struct sched_clock_data, sched_clock_data);
  86
  87 static inline struct sched_clock_data *this_scd(void)
  88 {
  89         return &__get_cpu_var(sched_clock_data);
  90 }
  91
  92 static inline struct sched_clock_data *cpu_sdc(int cpu)
  93 {
  94         return &per_cpu(sched_clock_data, cpu);
  95 }
  96
  97 void sched_clock_init(void)
  98 {
  99         u64 ktime_now = ktime_to_ns(ktime_get());
 100         int cpu;
 101
 102         for_each_possible_cpu(cpu) {
 103                 struct sched_clock_data *scd = cpu_sdc(cpu);
 104
 105                 scd->tick_raw = 0;
 106                 scd->tick_gtod = ktime_now;
 107                 scd->clock = ktime_now;
 108         }
 109
 110         sched_clock_running = 1;
 111 }
 112
 113 /*
 114  * min, max except they take wrapping into account
 115  */
 116
 117 static inline u64 wrap_min(u64 x, u64 y)
 118 {
 119         return (s64)(x - y) < 0 ? x : y;
 120 }
 121
 122 static inline u64 wrap_max(u64 x, u64 y)
 123 {
 124         return (s64)(x - y) > 0 ? x : y;
 125 }
 126
 127 /*
 128  * update the percpu scd from the raw @now value
 129  *
 130  *  - filter out backward motion
 131  *  - use the GTOD tick value to create a window to filter crazy TSC values
 132  */
 133 static u64 sched_clock_local(struct sched_clock_data *scd)
 134 {
 135         u64 now, clock, old_clock, min_clock, max_clock;
 136         s64 delta;
 137
 138 again:
 139         now = sched_clock();
 140         delta = now - scd->tick_raw;
 141         if (unlikely(delta < 0))
 142                 delta = 0;
 143
 144         old_clock = scd->clock;
 145
 146         /*
 147          * scd->clock = clamp(scd->tick_gtod + delta,
 148          *                    max(scd->tick_gtod, scd->clock),
 149          *                    scd->tick_gtod + TICK_NSEC);
 150          */
 151
 152         clock = scd->tick_gtod + delta;
 153         min_clock = wrap_max(scd->tick_gtod, old_clock);
 154         max_clock = wrap_max(old_clock, scd->tick_gtod + TICK_NSEC);
 155
 156         clock = wrap_max(clock, min_clock);
 157         clock = wrap_min(clock, max_clock);
 158
 159         if (cmpxchg64(&scd->clock, old_clock, clock) != old_clock)
 160                 goto again;
 161
 162         return clock;
 163 }
 164
 165 static u64 sched_clock_remote(struct sched_clock_data *scd)
 166 {
 167         struct sched_clock_data *my_scd = this_scd();
 168         u64 this_clock, remote_clock;
 169         u64 *ptr, old_val, val;
 170
 171 #if BITS_PER_LONG != 64
 172 again:
 173         /*
 174          * Careful here: The local and the remote clock values need to
 175          * be read out atomic as we need to compare the values and
 176          * then update either the local or the remote side. So the
 177          * cmpxchg64 below only protects one readout.
 178          *
 179          * We must reread via sched_clock_local() in the retry case on
 180          * 32bit as an NMI could use sched_clock_local() via the
 181          * tracer and hit between the readout of
 182          * the low32bit and the high 32bit portion.
 183          */
 184         this_clock = sched_clock_local(my_scd);
 185         /*
 186          * We must enforce atomic readout on 32bit, otherwise the
 187          * update on the remote cpu can hit inbetween the readout of
 188          * the low32bit and the high 32bit portion.
 189          */
 190         remote_clock = cmpxchg64(&scd->clock, 0, 0);
 191 #else
 192         /*
 193          * On 64bit the read of [my]scd->clock is atomic versus the
 194          * update, so we can avoid the above 32bit dance.
 195          */
 196         sched_clock_local(my_scd);
 197 again:
 198         this_clock = my_scd->clock;
 199         remote_clock = scd->clock;
 200 #endif
 201
 202         /*
 203          * Use the opportunity that we have both locks
 204          * taken to couple the two clocks: we take the
 205          * larger time as the latest time for both
 206          * runqueues. (this creates monotonic movement)
 207          */
 208         if (likely((s64)(remote_clock - this_clock) < 0)) {
 209                 ptr = &scd->clock;
 210                 old_val = remote_clock;
 211                 val = this_clock;
 212         } else {
 213                 /*
 214                  * Should be rare, but possible:
 215                  */
 216                 ptr = &my_scd->clock;
 217                 old_val = this_clock;
 218                 val = remote_clock;
 219         }
 220
 221         if (cmpxchg64(ptr, old_val, val) != old_val)
 222                 goto again;
 223
 224         return val;
 225 }
 226
 227 /*
 228  * Similar to cpu_clock(), but requires local IRQs to be disabled.
 229  *
 230  * See cpu_clock().
 231  */
 232 u64 sched_clock_cpu(int cpu)
 233 {
 234         struct sched_clock_data *scd;
 235         u64 clock;
 236
 237         if (sched_clock_stable)
 238                 return sched_clock();
 239
 240         if (unlikely(!sched_clock_running))
 241                 return 0ull;
 242
 243         preempt_disable();
 244         scd = cpu_sdc(cpu);
 245
 246         if (cpu != smp_processor_id())
 247                 clock = sched_clock_remote(scd);
 248         else
 249                 clock = sched_clock_local(scd);
 250         preempt_enable();
 251
 252         return clock;
 253 }
 254
 255 void sched_clock_tick(void)
 256 {
 257         struct sched_clock_data *scd;
 258         u64 now, now_gtod;
 259
 260         if (sched_clock_stable)
 261                 return;
 262
 263         if (unlikely(!sched_clock_running))
 264                 return;
 265
 266         WARN_ON_ONCE(!irqs_disabled());
 267
 268         scd = this_scd();
 269         now_gtod = ktime_to_ns(ktime_get());
 270         now = sched_clock();
 271
 272         scd->tick_raw = now;
 273         scd->tick_gtod = now_gtod;
 274         sched_clock_local(scd);
 275 }
 276
 277 /*
 278  * We are going deep-idle (irqs are disabled):
 279  */
 280 void sched_clock_idle_sleep_event(void)
 281 {
 282         sched_clock_cpu(smp_processor_id());
 283 }
 284 EXPORT_SYMBOL_GPL(sched_clock_idle_sleep_event);
 285
 286 /*
 287  * We just idled delta nanoseconds (called with irqs disabled):
 288  */
 289 void sched_clock_idle_wakeup_event(u64 delta_ns)
 290 {
 291         if (timekeeping_suspended)
 292                 return;
 293
 294         sched_clock_tick();
 295         touch_softlockup_watchdog();
 296 }
 297 EXPORT_SYMBOL_GPL(sched_clock_idle_wakeup_event);
 298
 299 /*
 300  * As outlined at the top, provides a fast, high resolution, nanosecond
 301  * time source that is monotonic per cpu argument and has bounded drift
 302  * between cpus.
 303  *
 304  * ######################### BIG FAT WARNING ##########################
 305  * # when comparing cpu_clock(i) to cpu_clock(j) for i != j, time can #
 306  * # go backwards !!                                                  #
 307  * ####################################################################
 308  */
 309 u64 cpu_clock(int cpu)
 310 {
 311         return sched_clock_cpu(cpu);
 312 }
 313
 314 /*
 315  * Similar to cpu_clock() for the current cpu. Time will only be observed
 316  * to be monotonic if care is taken to only compare timestampt taken on the
 317  * same CPU.
 318  *
 319  * See cpu_clock().
 320  */
 321 u64 local_clock(void)
 322 {
 323         return sched_clock_cpu(raw_smp_processor_id());
 324 }
 325
 326 #else /* CONFIG_HAVE_UNSTABLE_SCHED_CLOCK */
 327
 328 void sched_clock_init(void)
 329 {
 330         sched_clock_running = 1;
 331 }
 332
 333 u64 sched_clock_cpu(int cpu)
 334 {
 335         if (unlikely(!sched_clock_running))
 336                 return 0;
 337
 338         return sched_clock();
 339 }
 340
 341 u64 cpu_clock(int cpu)
 342 {
 343         return sched_clock_cpu(cpu);
 344 }
 345
 346 u64 local_clock(void)
 347 {
 348         return sched_clock_cpu(0);
 349 }
 350
 351 #endif /* CONFIG_HAVE_UNSTABLE_SCHED_CLOCK */
 352
 353 EXPORT_SYMBOL_GPL(cpu_clock);
 354 EXPORT_SYMBOL_GPL(local_clock);