arch/x86/xen/time.c

   1 /*
   2  * Xen time implementation.
   3  *
   4  * This is implemented in terms of a clocksource driver which uses
   5  * the hypervisor clock as a nanosecond timebase, and a clockevent
   6  * driver which uses the hypervisor's timer mechanism.
   7  *
   8  * Jeremy Fitzhardinge <jeremy@xensource.com>, XenSource Inc, 2007
   9  */
  10 #include <linux/kernel.h>
  11 #include <linux/interrupt.h>
  12 #include <linux/clocksource.h>
  13 #include <linux/clockchips.h>
  14 #include <linux/kernel_stat.h>
  15 #include <linux/math64.h>
  16 #include <linux/gfp.h>
  17
  18 #include <asm/pvclock.h>
  19 #include <asm/xen/hypervisor.h>
  20 #include <asm/xen/hypercall.h>
  21
  22 #include <xen/events.h>
  23 #include <xen/features.h>
  24 #include <xen/interface/xen.h>
  25 #include <xen/interface/vcpu.h>
  26
  27 #include "xen-ops.h"
  28
  29 /* Xen may fire a timer up to this many ns early */
  30 #define TIMER_SLOP      100000
  31 #define NS_PER_TICK     (1000000000LL / HZ)
  32
  33 /* runstate info updated by Xen */
  34 static DEFINE_PER_CPU(struct vcpu_runstate_info, xen_runstate);
  35
  36 /* snapshots of runstate info */
  37 static DEFINE_PER_CPU(struct vcpu_runstate_info, xen_runstate_snapshot);
  38
  39 /* unused ns of stolen and blocked time */
  40 static DEFINE_PER_CPU(u64, xen_residual_stolen);
  41 static DEFINE_PER_CPU(u64, xen_residual_blocked);
  42
  43 /* return an consistent snapshot of 64-bit time/counter value */
  44 static u64 get64(const u64 *p)
  45 {
  46         u64 ret;
  47
  48         if (BITS_PER_LONG < 64) {
  49                 u32 *p32 = (u32 *)p;
  50                 u32 h, l;
  51
  52                 /*
  53                  * Read high then low, and then make sure high is
  54                  * still the same; this will only loop if low wraps
  55                  * and carries into high.
  56                  * XXX some clean way to make this endian-proof?
  57                  */
  58                 do {
  59                         h = p32[1];
  60                         barrier();
  61                         l = p32[0];
  62                         barrier();
  63                 } while (p32[1] != h);
  64
  65                 ret = (((u64)h) << 32) | l;
  66         } else
  67                 ret = *p;
  68
  69         return ret;
  70 }
  71
  72 /*
  73  * Runstate accounting
  74  */
  75 static void get_runstate_snapshot(struct vcpu_runstate_info *res)
  76 {
  77         u64 state_time;
  78         struct vcpu_runstate_info *state;
  79
  80         BUG_ON(preemptible());
  81
  82         state = &__get_cpu_var(xen_runstate);
  83
  84         /*
  85          * The runstate info is always updated by the hypervisor on
  86          * the current CPU, so there's no need to use anything
  87          * stronger than a compiler barrier when fetching it.
  88          */
  89         do {
  90                 state_time = get64(&state->state_entry_time);
  91                 barrier();
  92                 *res = *state;
  93                 barrier();
  94         } while (get64(&state->state_entry_time) != state_time);
  95 }
  96
  97 /* return true when a vcpu could run but has no real cpu to run on */
  98 bool xen_vcpu_stolen(int vcpu)
  99 {
 100         return per_cpu(xen_runstate, vcpu).state == RUNSTATE_runnable;
 101 }
 102
 103 void xen_setup_runstate_info(int cpu)
 104 {
 105         struct vcpu_register_runstate_memory_area area;
 106
 107         area.addr.v = &per_cpu(xen_runstate, cpu);
 108
 109         if (HYPERVISOR_vcpu_op(VCPUOP_register_runstate_memory_area,
 110                                cpu, &area))
 111                 BUG();
 112 }
 113
 114 static void do_stolen_accounting(void)
 115 {
 116         struct vcpu_runstate_info state;
 117         struct vcpu_runstate_info *snap;
 118         s64 blocked, runnable, offline, stolen;
 119         cputime_t ticks;
 120
 121         get_runstate_snapshot(&state);
 122
 123         WARN_ON(state.state != RUNSTATE_running);
 124
 125         snap = &__get_cpu_var(xen_runstate_snapshot);
 126
 127         /* work out how much time the VCPU has not been runn*ing*  */
 128         blocked = state.time[RUNSTATE_blocked] - snap->time[RUNSTATE_blocked];
 129         runnable = state.time[RUNSTATE_runnable] - snap->time[RUNSTATE_runnable];
 130         offline = state.time[RUNSTATE_offline] - snap->time[RUNSTATE_offline];
 131
 132         *snap = state;
 133
 134         /* Add the appropriate number of ticks of stolen time,
 135            including any left-overs from last time. */
 136         stolen = runnable + offline + __this_cpu_read(xen_residual_stolen);
 137
 138         if (stolen < 0)
 139                 stolen = 0;
 140
 141         ticks = iter_div_u64_rem(stolen, NS_PER_TICK, &stolen);
 142         __this_cpu_write(xen_residual_stolen, stolen);
 143         account_steal_ticks(ticks);
 144
 145         /* Add the appropriate number of ticks of blocked time,
 146            including any left-overs from last time. */
 147         blocked += __this_cpu_read(xen_residual_blocked);
 148
 149         if (blocked < 0)
 150                 blocked = 0;
 151
 152         ticks = iter_div_u64_rem(blocked, NS_PER_TICK, &blocked);
 153         __this_cpu_write(xen_residual_blocked, blocked);
 154         account_idle_ticks(ticks);
 155 }
 156
 157 /* Get the TSC speed from Xen */
 158 static unsigned long xen_tsc_khz(void)
 159 {
 160         struct pvclock_vcpu_time_info *info =
 161                 &HYPERVISOR_shared_info->vcpu_info[0].time;
 162
 163         return pvclock_tsc_khz(info);
 164 }
 165
 166 cycle_t xen_clocksource_read(void)
 167 {
 168         struct pvclock_vcpu_time_info *src;
 169         cycle_t ret;
 170
 171         src = &get_cpu_var(xen_vcpu)->time;
 172         ret = pvclock_clocksource_read(src);
 173         put_cpu_var(xen_vcpu);
 174         return ret;
 175 }
 176
 177 static cycle_t xen_clocksource_get_cycles(struct clocksource *cs)
 178 {
 179         return xen_clocksource_read();
 180 }
 181
 182 static void xen_read_wallclock(struct timespec *ts)
 183 {
 184         struct shared_info *s = HYPERVISOR_shared_info;
 185         struct pvclock_wall_clock *wall_clock = &(s->wc);
 186         struct pvclock_vcpu_time_info *vcpu_time;
 187
 188         vcpu_time = &get_cpu_var(xen_vcpu)->time;
 189         pvclock_read_wallclock(wall_clock, vcpu_time, ts);
 190         put_cpu_var(xen_vcpu);
 191 }
 192
 193 static unsigned long xen_get_wallclock(void)
 194 {
 195         struct timespec ts;
 196
 197         xen_read_wallclock(&ts);
 198         return ts.tv_sec;
 199 }
 200
 201 static int xen_set_wallclock(unsigned long now)
 202 {
 203         struct xen_platform_op op;
 204         int rc;
 205
 206         /* do nothing for domU */
 207         if (!xen_initial_domain())
 208                 return -1;
 209
 210         op.cmd = XENPF_settime;
 211         op.u.settime.secs = now;
 212         op.u.settime.nsecs = 0;
 213         op.u.settime.system_time = xen_clocksource_read();
 214
 215         rc = HYPERVISOR_dom0_op(&op);
 216         WARN(rc != 0, "XENPF_settime failed: now=%ld\n", now);
 217
 218         return rc;
 219 }
 220
 221 static struct clocksource xen_clocksource __read_mostly = {
 222         .name = "xen",
 223         .rating = 400,
 224         .read = xen_clocksource_get_cycles,
 225         .mask = ~0,
 226         .flags = CLOCK_SOURCE_IS_CONTINUOUS,
 227 };
 228
 229 /*
 230    Xen clockevent implementation
 231
 232    Xen has two clockevent implementations:
 233
 234    The old timer_op one works with all released versions of Xen prior
 235    to version 3.0.4.  This version of the hypervisor provides a
 236    single-shot timer with nanosecond resolution.  However, sharing the
 237    same event channel is a 100Hz tick which is delivered while the
 238    vcpu is running.  We don't care about or use this tick, but it will
 239    cause the core time code to think the timer fired too soon, and
 240    will end up resetting it each time.  It could be filtered, but
 241    doing so has complications when the ktime clocksource is not yet
 242    the xen clocksource (ie, at boot time).
 243
 244    The new vcpu_op-based timer interface allows the tick timer period
 245    to be changed or turned off.  The tick timer is not useful as a
 246    periodic timer because events are only delivered to running vcpus.
 247    The one-shot timer can report when a timeout is in the past, so
 248    set_next_event is capable of returning -ETIME when appropriate.
 249    This interface is used when available.
 250 */
 251
 252
 253 /*
 254   Get a hypervisor absolute time.  In theory we could maintain an
 255   offset between the kernel's time and the hypervisor's time, and
 256   apply that to a kernel's absolute timeout.  Unfortunately the
 257   hypervisor and kernel times can drift even if the kernel is using
 258   the Xen clocksource, because ntp can warp the kernel's clocksource.
 259 */
 260 static s64 get_abs_timeout(unsigned long delta)
 261 {
 262         return xen_clocksource_read() + delta;
 263 }
 264
 265 static void xen_timerop_set_mode(enum clock_event_mode mode,
 266                                  struct clock_event_device *evt)
 267 {
 268         switch (mode) {
 269         case CLOCK_EVT_MODE_PERIODIC:
 270                 /* unsupported */
 271                 WARN_ON(1);
 272                 break;
 273
 274         case CLOCK_EVT_MODE_ONESHOT:
 275         case CLOCK_EVT_MODE_RESUME:
 276                 break;
 277
 278         case CLOCK_EVT_MODE_UNUSED:
 279         case CLOCK_EVT_MODE_SHUTDOWN:
 280                 HYPERVISOR_set_timer_op(0);  /* cancel timeout */
 281                 break;
 282         }
 283 }
 284
 285 static int xen_timerop_set_next_event(unsigned long delta,
 286                                       struct clock_event_device *evt)
 287 {
 288         WARN_ON(evt->mode != CLOCK_EVT_MODE_ONESHOT);
 289
 290         if (HYPERVISOR_set_timer_op(get_abs_timeout(delta)) < 0)
 291                 BUG();
 292
 293         /* We may have missed the deadline, but there's no real way of
 294            knowing for sure.  If the event was in the past, then we'll
 295            get an immediate interrupt. */
 296
 297         return 0;
 298 }
 299
 300 static const struct clock_event_device xen_timerop_clockevent = {
 301         .name = "xen",
 302         .features = CLOCK_EVT_FEAT_ONESHOT,
 303
 304         .max_delta_ns = 0xffffffff,
 305         .min_delta_ns = TIMER_SLOP,
 306
 307         .mult = 1,
 308         .shift = 0,
 309         .rating = 500,
 310
 311         .set_mode = xen_timerop_set_mode,
 312         .set_next_event = xen_timerop_set_next_event,
 313 };
 314
 315
 316
 317 static void xen_vcpuop_set_mode(enum clock_event_mode mode,
 318                                 struct clock_event_device *evt)
 319 {
 320         int cpu = smp_processor_id();
 321
 322         switch (mode) {
 323         case CLOCK_EVT_MODE_PERIODIC:
 324                 WARN_ON(1);     /* unsupported */
 325                 break;
 326
 327         case CLOCK_EVT_MODE_ONESHOT:
 328                 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer, cpu, NULL))
 329                         BUG();
 330                 break;
 331
 332         case CLOCK_EVT_MODE_UNUSED:
 333         case CLOCK_EVT_MODE_SHUTDOWN:
 334                 if (HYPERVISOR_vcpu_op(VCPUOP_stop_singleshot_timer, cpu, NULL) ||
 335                     HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer, cpu, NULL))
 336                         BUG();
 337                 break;
 338         case CLOCK_EVT_MODE_RESUME:
 339                 break;
 340         }
 341 }
 342
 343 static int xen_vcpuop_set_next_event(unsigned long delta,
 344                                      struct clock_event_device *evt)
 345 {
 346         int cpu = smp_processor_id();
 347         struct vcpu_set_singleshot_timer single;
 348         int ret;
 349
 350         WARN_ON(evt->mode != CLOCK_EVT_MODE_ONESHOT);
 351
 352         single.timeout_abs_ns = get_abs_timeout(delta);
 353         single.flags = VCPU_SSHOTTMR_future;
 354
 355         ret = HYPERVISOR_vcpu_op(VCPUOP_set_singleshot_timer, cpu, &single);
 356
 357         BUG_ON(ret != 0 && ret != -ETIME);
 358
 359         return ret;
 360 }
 361
 362 static const struct clock_event_device xen_vcpuop_clockevent = {
 363         .name = "xen",
 364         .features = CLOCK_EVT_FEAT_ONESHOT,
 365
 366         .max_delta_ns = 0xffffffff,
 367         .min_delta_ns = TIMER_SLOP,
 368
 369         .mult = 1,
 370         .shift = 0,
 371         .rating = 500,
 372
 373         .set_mode = xen_vcpuop_set_mode,
 374         .set_next_event = xen_vcpuop_set_next_event,
 375 };
 376
 377 static const struct clock_event_device *xen_clockevent =
 378         &xen_timerop_clockevent;
 379 static DEFINE_PER_CPU(struct clock_event_device, xen_clock_events);
 380
 381 static irqreturn_t xen_timer_interrupt(int irq, void *dev_id)
 382 {
 383         struct clock_event_device *evt = &__get_cpu_var(xen_clock_events);
 384         irqreturn_t ret;
 385
 386         ret = IRQ_NONE;
 387         if (evt->event_handler) {
 388                 evt->event_handler(evt);
 389                 ret = IRQ_HANDLED;
 390         }
 391
 392         do_stolen_accounting();
 393
 394         return ret;
 395 }
 396
 397 void xen_setup_timer(int cpu)
 398 {
 399         const char *name;
 400         struct clock_event_device *evt;
 401         int irq;
 402
 403         printk(KERN_INFO "installing Xen timer for CPU %d\n", cpu);
 404
 405         name = kasprintf(GFP_KERNEL, "timer%d", cpu);
 406         if (!name)
 407                 name = "<timer kasprintf failed>";
 408
 409         irq = bind_virq_to_irqhandler(VIRQ_TIMER, cpu, xen_timer_interrupt,
 410                                       IRQF_DISABLED|IRQF_PERCPU|
 411                                       IRQF_NOBALANCING|IRQF_TIMER|
 412                                       IRQF_FORCE_RESUME,
 413                                       name, NULL);
 414
 415         evt = &per_cpu(xen_clock_events, cpu);
 416         memcpy(evt, xen_clockevent, sizeof(*evt));
 417
 418         evt->cpumask = cpumask_of(cpu);
 419         evt->irq = irq;
 420 }
 421
 422 void xen_teardown_timer(int cpu)
 423 {
 424         struct clock_event_device *evt;
 425         BUG_ON(cpu == 0);
 426         evt = &per_cpu(xen_clock_events, cpu);
 427         unbind_from_irqhandler(evt->irq, NULL);
 428 }
 429
 430 void xen_setup_cpu_clockevents(void)
 431 {
 432         BUG_ON(preemptible());
 433
 434         clockevents_register_device(&__get_cpu_var(xen_clock_events));
 435 }
 436
 437 void xen_timer_resume(void)
 438 {
 439         int cpu;
 440
 441         pvclock_resume();
 442
 443         if (xen_clockevent != &xen_vcpuop_clockevent)
 444                 return;
 445
 446         for_each_online_cpu(cpu) {
 447                 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer, cpu, NULL))
 448                         BUG();
 449         }
 450 }
 451
 452 static const struct pv_time_ops xen_time_ops __initconst = {
 453         .sched_clock = xen_clocksource_read,
 454 };
 455
 456 static void __init xen_time_init(void)
 457 {
 458         int cpu = smp_processor_id();
 459         struct timespec tp;
 460
 461         clocksource_register_hz(&xen_clocksource, NSEC_PER_SEC);
 462
 463         if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer, cpu, NULL) == 0) {
 464                 /* Successfully turned off 100Hz tick, so we have the
 465                    vcpuop-based timer interface */
 466                 printk(KERN_DEBUG "Xen: using vcpuop timer interface\n");
 467                 xen_clockevent = &xen_vcpuop_clockevent;
 468         }
 469
 470         /* Set initial system time with full resolution */
 471         xen_read_wallclock(&tp);
 472         do_settimeofday(&tp);
 473
 474         setup_force_cpu_cap(X86_FEATURE_TSC);
 475
 476         xen_setup_runstate_info(cpu);
 477         xen_setup_timer(cpu);
 478         xen_setup_cpu_clockevents();
 479 }
 480
 481 void __init xen_init_time_ops(void)
 482 {
 483         pv_time_ops = xen_time_ops;
 484
 485         x86_init.timers.timer_init = xen_time_init;
 486         x86_init.timers.setup_percpu_clockev = x86_init_noop;
 487         x86_cpuinit.setup_percpu_clockev = x86_init_noop;
 488
 489         x86_platform.calibrate_tsc = xen_tsc_khz;
 490         x86_platform.get_wallclock = xen_get_wallclock;
 491         x86_platform.set_wallclock = xen_set_wallclock;
 492 }
 493
 494 #ifdef CONFIG_XEN_PVHVM
 495 static void xen_hvm_setup_cpu_clockevents(void)
 496 {
 497         int cpu = smp_processor_id();
 498         xen_setup_runstate_info(cpu);
 499         xen_setup_timer(cpu);
 500         xen_setup_cpu_clockevents();
 501 }
 502
 503 void __init xen_hvm_init_time_ops(void)
 504 {
 505         /* vector callback is needed otherwise we cannot receive interrupts
 506          * on cpu > 0 and at this point we don't know how many cpus are
 507          * available */
 508         if (!xen_have_vector_callback)
 509                 return;
 510         if (!xen_feature(XENFEAT_hvm_safe_pvclock)) {
 511                 printk(KERN_INFO "Xen doesn't support pvclock on HVM,"
 512                                 "disable pv timer\n");
 513                 return;
 514         }
 515
 516         pv_time_ops = xen_time_ops;
 517         x86_init.timers.setup_percpu_clockev = xen_time_init;
 518         x86_cpuinit.setup_percpu_clockev = xen_hvm_setup_cpu_clockevents;
 519
 520         x86_platform.calibrate_tsc = xen_tsc_khz;
 521         x86_platform.get_wallclock = xen_get_wallclock;
 522         x86_platform.set_wallclock = xen_set_wallclock;
 523 }
 524 #endif