kernel/sched/clock.c

   1 /*
   2  * sched_clock for unstable cpu clocks
   3  *
   4  *  Copyright (C) 2008 Red Hat, Inc., Peter Zijlstra
   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 #include <linux/static_key.h>
  62 #include <linux/workqueue.h>
  63 #include <linux/compiler.h>
  64 #include <linux/tick.h>
  65
  66 /*
  67  * Scheduler clock - returns current time in nanosec units.
  68  * This is default implementation.
  69  * Architectures and sub-architectures can override this.
  70  */
  71 unsigned long long __weak sched_clock(void)
  72 {
  73         return (unsigned long long)(jiffies - INITIAL_JIFFIES)
  74                                         * (NSEC_PER_SEC / HZ);
  75 }
  76 EXPORT_SYMBOL_GPL(sched_clock);
  77
  78 __read_mostly int sched_clock_running;
  79
  80 void sched_clock_init(void)
  81 {
  82         sched_clock_running = 1;
  83 }
  84
  85 #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
  86 static DEFINE_STATIC_KEY_FALSE(__sched_clock_stable);
  87 static int __sched_clock_stable_early;
  88
  89 /*
  90  * We want: ktime_get_ns() + gtod_offset == sched_clock() + raw_offset
  91  */
  92 static __read_mostly u64 raw_offset;
  93 static __read_mostly u64 gtod_offset;
  94
  95 struct sched_clock_data {
  96         u64                     tick_raw;
  97         u64                     tick_gtod;
  98         u64                     clock;
  99 };
 100
 101 static DEFINE_PER_CPU_SHARED_ALIGNED(struct sched_clock_data, sched_clock_data);
 102
 103 static inline struct sched_clock_data *this_scd(void)
 104 {
 105         return this_cpu_ptr(&sched_clock_data);
 106 }
 107
 108 static inline struct sched_clock_data *cpu_sdc(int cpu)
 109 {
 110         return &per_cpu(sched_clock_data, cpu);
 111 }
 112
 113 int sched_clock_stable(void)
 114 {
 115         return static_branch_likely(&__sched_clock_stable);
 116 }
 117
 118 static void __set_sched_clock_stable(void)
 119 {
 120         struct sched_clock_data *scd = this_scd();
 121
 122         /*
 123          * Attempt to make the (initial) unstable->stable transition continuous.
 124          */
 125         raw_offset = (scd->tick_gtod + gtod_offset) - (scd->tick_raw);
 126
 127         printk(KERN_INFO "sched_clock: Marking stable (%lld, %lld)->(%lld, %lld)\n",
 128                         scd->tick_gtod, gtod_offset,
 129                         scd->tick_raw,  raw_offset);
 130
 131         static_branch_enable(&__sched_clock_stable);
 132         tick_dep_clear(TICK_DEP_BIT_CLOCK_UNSTABLE);
 133 }
 134
 135 void set_sched_clock_stable(void)
 136 {
 137         __sched_clock_stable_early = 1;
 138
 139         smp_mb(); /* matches sched_clock_init_late() */
 140
 141         /*
 142          * This really should only be called early (before
 143          * sched_clock_init_late()) when guestimating our sched_clock() is
 144          * solid.
 145          *
 146          * After that we test stability and we can negate our guess using
 147          * clear_sched_clock_stable, possibly from a watchdog.
 148          */
 149         if (WARN_ON_ONCE(sched_clock_running == 2))
 150                 __set_sched_clock_stable();
 151 }
 152
 153 static void __clear_sched_clock_stable(struct work_struct *work)
 154 {
 155         struct sched_clock_data *scd = this_scd();
 156
 157         /*
 158          * Attempt to make the stable->unstable transition continuous.
 159          *
 160          * Trouble is, this is typically called from the TSC watchdog
 161          * timer, which is late per definition. This means the tick
 162          * values can already be screwy.
 163          *
 164          * Still do what we can.
 165          */
 166         gtod_offset = (scd->tick_raw + raw_offset) - (scd->tick_gtod);
 167
 168         printk(KERN_INFO "sched_clock: Marking unstable (%lld, %lld)<-(%lld, %lld)\n",
 169                         scd->tick_gtod, gtod_offset,
 170                         scd->tick_raw,  raw_offset);
 171
 172         static_branch_disable(&__sched_clock_stable);
 173         tick_dep_set(TICK_DEP_BIT_CLOCK_UNSTABLE);
 174 }
 175
 176 static DECLARE_WORK(sched_clock_work, __clear_sched_clock_stable);
 177
 178 void clear_sched_clock_stable(void)
 179 {
 180         __sched_clock_stable_early = 0;
 181
 182         smp_mb(); /* matches sched_clock_init_late() */
 183
 184         if (sched_clock_running == 2)
 185                 schedule_work(&sched_clock_work);
 186 }
 187
 188 void sched_clock_init_late(void)
 189 {
 190         sched_clock_running = 2;
 191         /*
 192          * Ensure that it is impossible to not do a static_key update.
 193          *
 194          * Either {set,clear}_sched_clock_stable() must see sched_clock_running
 195          * and do the update, or we must see their __sched_clock_stable_early
 196          * and do the update, or both.
 197          */
 198         smp_mb(); /* matches {set,clear}_sched_clock_stable() */
 199
 200         if (__sched_clock_stable_early)
 201                 __set_sched_clock_stable();
 202         else
 203                 __clear_sched_clock_stable(NULL);
 204 }
 205
 206 /*
 207  * min, max except they take wrapping into account
 208  */
 209
 210 static inline u64 wrap_min(u64 x, u64 y)
 211 {
 212         return (s64)(x - y) < 0 ? x : y;
 213 }
 214
 215 static inline u64 wrap_max(u64 x, u64 y)
 216 {
 217         return (s64)(x - y) > 0 ? x : y;
 218 }
 219
 220 /*
 221  * update the percpu scd from the raw @now value
 222  *
 223  *  - filter out backward motion
 224  *  - use the GTOD tick value to create a window to filter crazy TSC values
 225  */
 226 static u64 sched_clock_local(struct sched_clock_data *scd)
 227 {
 228         u64 now, clock, old_clock, min_clock, max_clock;
 229         s64 delta;
 230
 231 again:
 232         now = sched_clock();
 233         delta = now - scd->tick_raw;
 234         if (unlikely(delta < 0))
 235                 delta = 0;
 236
 237         old_clock = scd->clock;
 238
 239         /*
 240          * scd->clock = clamp(scd->tick_gtod + delta,
 241          *                    max(scd->tick_gtod, scd->clock),
 242          *                    scd->tick_gtod + TICK_NSEC);
 243          */
 244
 245         clock = scd->tick_gtod + gtod_offset + delta;
 246         min_clock = wrap_max(scd->tick_gtod, old_clock);
 247         max_clock = wrap_max(old_clock, scd->tick_gtod + TICK_NSEC);
 248
 249         clock = wrap_max(clock, min_clock);
 250         clock = wrap_min(clock, max_clock);
 251
 252         if (cmpxchg64(&scd->clock, old_clock, clock) != old_clock)
 253                 goto again;
 254
 255         return clock;
 256 }
 257
 258 static u64 sched_clock_remote(struct sched_clock_data *scd)
 259 {
 260         struct sched_clock_data *my_scd = this_scd();
 261         u64 this_clock, remote_clock;
 262         u64 *ptr, old_val, val;
 263
 264 #if BITS_PER_LONG != 64
 265 again:
 266         /*
 267          * Careful here: The local and the remote clock values need to
 268          * be read out atomic as we need to compare the values and
 269          * then update either the local or the remote side. So the
 270          * cmpxchg64 below only protects one readout.
 271          *
 272          * We must reread via sched_clock_local() in the retry case on
 273          * 32bit as an NMI could use sched_clock_local() via the
 274          * tracer and hit between the readout of
 275          * the low32bit and the high 32bit portion.
 276          */
 277         this_clock = sched_clock_local(my_scd);
 278         /*
 279          * We must enforce atomic readout on 32bit, otherwise the
 280          * update on the remote cpu can hit inbetween the readout of
 281          * the low32bit and the high 32bit portion.
 282          */
 283         remote_clock = cmpxchg64(&scd->clock, 0, 0);
 284 #else
 285         /*
 286          * On 64bit the read of [my]scd->clock is atomic versus the
 287          * update, so we can avoid the above 32bit dance.
 288          */
 289         sched_clock_local(my_scd);
 290 again:
 291         this_clock = my_scd->clock;
 292         remote_clock = scd->clock;
 293 #endif
 294
 295         /*
 296          * Use the opportunity that we have both locks
 297          * taken to couple the two clocks: we take the
 298          * larger time as the latest time for both
 299          * runqueues. (this creates monotonic movement)
 300          */
 301         if (likely((s64)(remote_clock - this_clock) < 0)) {
 302                 ptr = &scd->clock;
 303                 old_val = remote_clock;
 304                 val = this_clock;
 305         } else {
 306                 /*
 307                  * Should be rare, but possible:
 308                  */
 309                 ptr = &my_scd->clock;
 310                 old_val = this_clock;
 311                 val = remote_clock;
 312         }
 313
 314         if (cmpxchg64(ptr, old_val, val) != old_val)
 315                 goto again;
 316
 317         return val;
 318 }
 319
 320 /*
 321  * Similar to cpu_clock(), but requires local IRQs to be disabled.
 322  *
 323  * See cpu_clock().
 324  */
 325 u64 sched_clock_cpu(int cpu)
 326 {
 327         struct sched_clock_data *scd;
 328         u64 clock;
 329
 330         if (sched_clock_stable())
 331                 return sched_clock() + raw_offset;
 332
 333         if (unlikely(!sched_clock_running))
 334                 return 0ull;
 335
 336         preempt_disable_notrace();
 337         scd = cpu_sdc(cpu);
 338
 339         if (cpu != smp_processor_id())
 340                 clock = sched_clock_remote(scd);
 341         else
 342                 clock = sched_clock_local(scd);
 343         preempt_enable_notrace();
 344
 345         return clock;
 346 }
 347 EXPORT_SYMBOL_GPL(sched_clock_cpu);
 348
 349 void sched_clock_tick(void)
 350 {
 351         struct sched_clock_data *scd;
 352
 353         WARN_ON_ONCE(!irqs_disabled());
 354
 355         /*
 356          * Update these values even if sched_clock_stable(), because it can
 357          * become unstable at any point in time at which point we need some
 358          * values to fall back on.
 359          *
 360          * XXX arguably we can skip this if we expose tsc_clocksource_reliable
 361          */
 362         scd = this_scd();
 363         scd->tick_raw  = sched_clock();
 364         scd->tick_gtod = ktime_get_ns();
 365
 366         if (!sched_clock_stable() && likely(sched_clock_running))
 367                 sched_clock_local(scd);
 368 }
 369
 370 /*
 371  * We are going deep-idle (irqs are disabled):
 372  */
 373 void sched_clock_idle_sleep_event(void)
 374 {
 375         sched_clock_cpu(smp_processor_id());
 376 }
 377 EXPORT_SYMBOL_GPL(sched_clock_idle_sleep_event);
 378
 379 /*
 380  * We just idled delta nanoseconds (called with irqs disabled):
 381  */
 382 void sched_clock_idle_wakeup_event(u64 delta_ns)
 383 {
 384         if (timekeeping_suspended)
 385                 return;
 386
 387         sched_clock_tick();
 388         touch_softlockup_watchdog_sched();
 389 }
 390 EXPORT_SYMBOL_GPL(sched_clock_idle_wakeup_event);
 391
 392 #else /* CONFIG_HAVE_UNSTABLE_SCHED_CLOCK */
 393
 394 u64 sched_clock_cpu(int cpu)
 395 {
 396         if (unlikely(!sched_clock_running))
 397                 return 0;
 398
 399         return sched_clock();
 400 }
 401
 402 #endif /* CONFIG_HAVE_UNSTABLE_SCHED_CLOCK */
 403
 404 /*
 405  * Running clock - returns the time that has elapsed while a guest has been
 406  * running.
 407  * On a guest this value should be local_clock minus the time the guest was
 408  * suspended by the hypervisor (for any reason).
 409  * On bare metal this function should return the same as local_clock.
 410  * Architectures and sub-architectures can override this.
 411  */
 412 u64 __weak running_clock(void)
 413 {
 414         return local_clock();
 415 }