2 * Xen time implementation.
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.
8 * Jeremy Fitzhardinge <jeremy@xensource.com>, XenSource Inc, 2007
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 #include <linux/slab.h>
18 #include <linux/pvclock_gtod.h>
20 #include <asm/pvclock.h>
21 #include <asm/xen/hypervisor.h>
22 #include <asm/xen/hypercall.h>
24 #include <xen/events.h>
25 #include <xen/features.h>
26 #include <xen/interface/xen.h>
27 #include <xen/interface/vcpu.h>
31 /* Xen may fire a timer up to this many ns early */
32 #define TIMER_SLOP 100000
33 #define NS_PER_TICK (1000000000LL / HZ)
35 /* runstate info updated by Xen */
36 static DEFINE_PER_CPU(struct vcpu_runstate_info
, xen_runstate
);
38 /* snapshots of runstate info */
39 static DEFINE_PER_CPU(struct vcpu_runstate_info
, xen_runstate_snapshot
);
41 /* unused ns of stolen time */
42 static DEFINE_PER_CPU(u64
, xen_residual_stolen
);
44 /* return an consistent snapshot of 64-bit time/counter value */
45 static u64
get64(const u64
*p
)
49 if (BITS_PER_LONG
< 64) {
54 * Read high then low, and then make sure high is
55 * still the same; this will only loop if low wraps
56 * and carries into high.
57 * XXX some clean way to make this endian-proof?
64 } while (p32
[1] != h
);
66 ret
= (((u64
)h
) << 32) | l
;
76 static void get_runstate_snapshot(struct vcpu_runstate_info
*res
)
79 struct vcpu_runstate_info
*state
;
81 BUG_ON(preemptible());
83 state
= &__get_cpu_var(xen_runstate
);
86 * The runstate info is always updated by the hypervisor on
87 * the current CPU, so there's no need to use anything
88 * stronger than a compiler barrier when fetching it.
91 state_time
= get64(&state
->state_entry_time
);
95 } while (get64(&state
->state_entry_time
) != state_time
);
98 /* return true when a vcpu could run but has no real cpu to run on */
99 bool xen_vcpu_stolen(int vcpu
)
101 return per_cpu(xen_runstate
, vcpu
).state
== RUNSTATE_runnable
;
104 void xen_setup_runstate_info(int cpu
)
106 struct vcpu_register_runstate_memory_area area
;
108 area
.addr
.v
= &per_cpu(xen_runstate
, cpu
);
110 if (HYPERVISOR_vcpu_op(VCPUOP_register_runstate_memory_area
,
115 static void do_stolen_accounting(void)
117 struct vcpu_runstate_info state
;
118 struct vcpu_runstate_info
*snap
;
119 s64 runnable
, offline
, stolen
;
122 get_runstate_snapshot(&state
);
124 WARN_ON(state
.state
!= RUNSTATE_running
);
126 snap
= &__get_cpu_var(xen_runstate_snapshot
);
128 /* work out how much time the VCPU has not been runn*ing* */
129 runnable
= state
.time
[RUNSTATE_runnable
] - snap
->time
[RUNSTATE_runnable
];
130 offline
= state
.time
[RUNSTATE_offline
] - snap
->time
[RUNSTATE_offline
];
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
);
141 ticks
= iter_div_u64_rem(stolen
, NS_PER_TICK
, &stolen
);
142 __this_cpu_write(xen_residual_stolen
, stolen
);
143 account_steal_ticks(ticks
);
146 /* Get the TSC speed from Xen */
147 static unsigned long xen_tsc_khz(void)
149 struct pvclock_vcpu_time_info
*info
=
150 &HYPERVISOR_shared_info
->vcpu_info
[0].time
;
152 return pvclock_tsc_khz(info
);
155 cycle_t
xen_clocksource_read(void)
157 struct pvclock_vcpu_time_info
*src
;
160 preempt_disable_notrace();
161 src
= &__get_cpu_var(xen_vcpu
)->time
;
162 ret
= pvclock_clocksource_read(src
);
163 preempt_enable_notrace();
167 static cycle_t
xen_clocksource_get_cycles(struct clocksource
*cs
)
169 return xen_clocksource_read();
172 static void xen_read_wallclock(struct timespec
*ts
)
174 struct shared_info
*s
= HYPERVISOR_shared_info
;
175 struct pvclock_wall_clock
*wall_clock
= &(s
->wc
);
176 struct pvclock_vcpu_time_info
*vcpu_time
;
178 vcpu_time
= &get_cpu_var(xen_vcpu
)->time
;
179 pvclock_read_wallclock(wall_clock
, vcpu_time
, ts
);
180 put_cpu_var(xen_vcpu
);
183 static void xen_get_wallclock(struct timespec
*now
)
185 xen_read_wallclock(now
);
188 static int xen_set_wallclock(const struct timespec
*now
)
193 static int xen_pvclock_gtod_notify(struct notifier_block
*nb
,
194 unsigned long was_set
, void *priv
)
196 /* Protected by the calling core code serialization */
197 static struct timespec next_sync
;
199 struct xen_platform_op op
;
202 now
= __current_kernel_time();
205 * We only take the expensive HV call when the clock was set
206 * or when the 11 minutes RTC synchronization time elapsed.
208 if (!was_set
&& timespec_compare(&now
, &next_sync
) < 0)
211 op
.cmd
= XENPF_settime
;
212 op
.u
.settime
.secs
= now
.tv_sec
;
213 op
.u
.settime
.nsecs
= now
.tv_nsec
;
214 op
.u
.settime
.system_time
= xen_clocksource_read();
216 (void)HYPERVISOR_dom0_op(&op
);
219 * Move the next drift compensation time 11 minutes
220 * ahead. That's emulating the sync_cmos_clock() update for
224 next_sync
.tv_sec
+= 11 * 60;
229 static struct notifier_block xen_pvclock_gtod_notifier
= {
230 .notifier_call
= xen_pvclock_gtod_notify
,
233 static struct clocksource xen_clocksource __read_mostly
= {
236 .read
= xen_clocksource_get_cycles
,
238 .flags
= CLOCK_SOURCE_IS_CONTINUOUS
,
242 Xen clockevent implementation
244 Xen has two clockevent implementations:
246 The old timer_op one works with all released versions of Xen prior
247 to version 3.0.4. This version of the hypervisor provides a
248 single-shot timer with nanosecond resolution. However, sharing the
249 same event channel is a 100Hz tick which is delivered while the
250 vcpu is running. We don't care about or use this tick, but it will
251 cause the core time code to think the timer fired too soon, and
252 will end up resetting it each time. It could be filtered, but
253 doing so has complications when the ktime clocksource is not yet
254 the xen clocksource (ie, at boot time).
256 The new vcpu_op-based timer interface allows the tick timer period
257 to be changed or turned off. The tick timer is not useful as a
258 periodic timer because events are only delivered to running vcpus.
259 The one-shot timer can report when a timeout is in the past, so
260 set_next_event is capable of returning -ETIME when appropriate.
261 This interface is used when available.
266 Get a hypervisor absolute time. In theory we could maintain an
267 offset between the kernel's time and the hypervisor's time, and
268 apply that to a kernel's absolute timeout. Unfortunately the
269 hypervisor and kernel times can drift even if the kernel is using
270 the Xen clocksource, because ntp can warp the kernel's clocksource.
272 static s64
get_abs_timeout(unsigned long delta
)
274 return xen_clocksource_read() + delta
;
277 static void xen_timerop_set_mode(enum clock_event_mode mode
,
278 struct clock_event_device
*evt
)
281 case CLOCK_EVT_MODE_PERIODIC
:
286 case CLOCK_EVT_MODE_ONESHOT
:
287 case CLOCK_EVT_MODE_RESUME
:
290 case CLOCK_EVT_MODE_UNUSED
:
291 case CLOCK_EVT_MODE_SHUTDOWN
:
292 HYPERVISOR_set_timer_op(0); /* cancel timeout */
297 static int xen_timerop_set_next_event(unsigned long delta
,
298 struct clock_event_device
*evt
)
300 WARN_ON(evt
->mode
!= CLOCK_EVT_MODE_ONESHOT
);
302 if (HYPERVISOR_set_timer_op(get_abs_timeout(delta
)) < 0)
305 /* We may have missed the deadline, but there's no real way of
306 knowing for sure. If the event was in the past, then we'll
307 get an immediate interrupt. */
312 static const struct clock_event_device xen_timerop_clockevent
= {
314 .features
= CLOCK_EVT_FEAT_ONESHOT
,
316 .max_delta_ns
= 0xffffffff,
317 .min_delta_ns
= TIMER_SLOP
,
323 .set_mode
= xen_timerop_set_mode
,
324 .set_next_event
= xen_timerop_set_next_event
,
329 static void xen_vcpuop_set_mode(enum clock_event_mode mode
,
330 struct clock_event_device
*evt
)
332 int cpu
= smp_processor_id();
335 case CLOCK_EVT_MODE_PERIODIC
:
336 WARN_ON(1); /* unsupported */
339 case CLOCK_EVT_MODE_ONESHOT
:
340 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
344 case CLOCK_EVT_MODE_UNUSED
:
345 case CLOCK_EVT_MODE_SHUTDOWN
:
346 if (HYPERVISOR_vcpu_op(VCPUOP_stop_singleshot_timer
, cpu
, NULL
) ||
347 HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
350 case CLOCK_EVT_MODE_RESUME
:
355 static int xen_vcpuop_set_next_event(unsigned long delta
,
356 struct clock_event_device
*evt
)
358 int cpu
= smp_processor_id();
359 struct vcpu_set_singleshot_timer single
;
362 WARN_ON(evt
->mode
!= CLOCK_EVT_MODE_ONESHOT
);
364 single
.timeout_abs_ns
= get_abs_timeout(delta
);
365 single
.flags
= VCPU_SSHOTTMR_future
;
367 ret
= HYPERVISOR_vcpu_op(VCPUOP_set_singleshot_timer
, cpu
, &single
);
369 BUG_ON(ret
!= 0 && ret
!= -ETIME
);
374 static const struct clock_event_device xen_vcpuop_clockevent
= {
376 .features
= CLOCK_EVT_FEAT_ONESHOT
,
378 .max_delta_ns
= 0xffffffff,
379 .min_delta_ns
= TIMER_SLOP
,
385 .set_mode
= xen_vcpuop_set_mode
,
386 .set_next_event
= xen_vcpuop_set_next_event
,
389 static const struct clock_event_device
*xen_clockevent
=
390 &xen_timerop_clockevent
;
392 struct xen_clock_event_device
{
393 struct clock_event_device evt
;
396 static DEFINE_PER_CPU(struct xen_clock_event_device
, xen_clock_events
) = { .evt
.irq
= -1 };
398 static irqreturn_t
xen_timer_interrupt(int irq
, void *dev_id
)
400 struct clock_event_device
*evt
= &__get_cpu_var(xen_clock_events
).evt
;
404 if (evt
->event_handler
) {
405 evt
->event_handler(evt
);
409 do_stolen_accounting();
414 void xen_teardown_timer(int cpu
)
416 struct clock_event_device
*evt
;
418 evt
= &per_cpu(xen_clock_events
, cpu
).evt
;
421 unbind_from_irqhandler(evt
->irq
, NULL
);
423 kfree(per_cpu(xen_clock_events
, cpu
).name
);
424 per_cpu(xen_clock_events
, cpu
).name
= NULL
;
428 void xen_setup_timer(int cpu
)
431 struct clock_event_device
*evt
;
434 evt
= &per_cpu(xen_clock_events
, cpu
).evt
;
435 WARN(evt
->irq
>= 0, "IRQ%d for CPU%d is already allocated\n", evt
->irq
, cpu
);
437 xen_teardown_timer(cpu
);
439 printk(KERN_INFO
"installing Xen timer for CPU %d\n", cpu
);
441 name
= kasprintf(GFP_KERNEL
, "timer%d", cpu
);
443 name
= "<timer kasprintf failed>";
445 irq
= bind_virq_to_irqhandler(VIRQ_TIMER
, cpu
, xen_timer_interrupt
,
446 IRQF_DISABLED
|IRQF_PERCPU
|
447 IRQF_NOBALANCING
|IRQF_TIMER
|
451 memcpy(evt
, xen_clockevent
, sizeof(*evt
));
453 evt
->cpumask
= cpumask_of(cpu
);
455 per_cpu(xen_clock_events
, cpu
).name
= name
;
459 void xen_setup_cpu_clockevents(void)
461 BUG_ON(preemptible());
463 clockevents_register_device(&__get_cpu_var(xen_clock_events
).evt
);
466 void xen_timer_resume(void)
472 if (xen_clockevent
!= &xen_vcpuop_clockevent
)
475 for_each_online_cpu(cpu
) {
476 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
481 static const struct pv_time_ops xen_time_ops __initconst
= {
482 .sched_clock
= xen_clocksource_read
,
485 static void __init
xen_time_init(void)
487 int cpu
= smp_processor_id();
490 clocksource_register_hz(&xen_clocksource
, NSEC_PER_SEC
);
492 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
) == 0) {
493 /* Successfully turned off 100Hz tick, so we have the
494 vcpuop-based timer interface */
495 printk(KERN_DEBUG
"Xen: using vcpuop timer interface\n");
496 xen_clockevent
= &xen_vcpuop_clockevent
;
499 /* Set initial system time with full resolution */
500 xen_read_wallclock(&tp
);
501 do_settimeofday(&tp
);
503 setup_force_cpu_cap(X86_FEATURE_TSC
);
505 xen_setup_runstate_info(cpu
);
506 xen_setup_timer(cpu
);
507 xen_setup_cpu_clockevents();
509 if (xen_initial_domain())
510 pvclock_gtod_register_notifier(&xen_pvclock_gtod_notifier
);
513 void __init
xen_init_time_ops(void)
515 pv_time_ops
= xen_time_ops
;
517 x86_init
.timers
.timer_init
= xen_time_init
;
518 x86_init
.timers
.setup_percpu_clockev
= x86_init_noop
;
519 x86_cpuinit
.setup_percpu_clockev
= x86_init_noop
;
521 x86_platform
.calibrate_tsc
= xen_tsc_khz
;
522 x86_platform
.get_wallclock
= xen_get_wallclock
;
523 /* Dom0 uses the native method to set the hardware RTC. */
524 if (!xen_initial_domain())
525 x86_platform
.set_wallclock
= xen_set_wallclock
;
528 #ifdef CONFIG_XEN_PVHVM
529 static void xen_hvm_setup_cpu_clockevents(void)
531 int cpu
= smp_processor_id();
532 xen_setup_runstate_info(cpu
);
534 * xen_setup_timer(cpu) - snprintf is bad in atomic context. Hence
535 * doing it xen_hvm_cpu_notify (which gets called by smp_init during
536 * early bootup and also during CPU hotplug events).
538 xen_setup_cpu_clockevents();
541 void __init
xen_hvm_init_time_ops(void)
543 /* vector callback is needed otherwise we cannot receive interrupts
544 * on cpu > 0 and at this point we don't know how many cpus are
546 if (!xen_have_vector_callback
)
548 if (!xen_feature(XENFEAT_hvm_safe_pvclock
)) {
549 printk(KERN_INFO
"Xen doesn't support pvclock on HVM,"
550 "disable pv timer\n");
554 pv_time_ops
= xen_time_ops
;
555 x86_init
.timers
.setup_percpu_clockev
= xen_time_init
;
556 x86_cpuinit
.setup_percpu_clockev
= xen_hvm_setup_cpu_clockevents
;
558 x86_platform
.calibrate_tsc
= xen_tsc_khz
;
559 x86_platform
.get_wallclock
= xen_get_wallclock
;
560 x86_platform
.set_wallclock
= xen_set_wallclock
;