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>
17 #include <asm/pvclock.h>
18 #include <asm/xen/hypervisor.h>
19 #include <asm/xen/hypercall.h>
21 #include <xen/events.h>
22 #include <xen/interface/xen.h>
23 #include <xen/interface/vcpu.h>
29 /* Xen may fire a timer up to this many ns early */
30 #define TIMER_SLOP 100000
31 #define NS_PER_TICK (1000000000LL / HZ)
33 /* runstate info updated by Xen */
34 static DEFINE_PER_CPU(struct vcpu_runstate_info
, runstate
);
36 /* snapshots of runstate info */
37 static DEFINE_PER_CPU(struct vcpu_runstate_info
, runstate_snapshot
);
39 /* unused ns of stolen and blocked time */
40 static DEFINE_PER_CPU(u64
, residual_stolen
);
41 static DEFINE_PER_CPU(u64
, residual_blocked
);
43 /* return an consistent snapshot of 64-bit time/counter value */
44 static u64
get64(const u64
*p
)
48 if (BITS_PER_LONG
< 64) {
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?
63 } while (p32
[1] != h
);
65 ret
= (((u64
)h
) << 32) | l
;
75 static void get_runstate_snapshot(struct vcpu_runstate_info
*res
)
78 struct vcpu_runstate_info
*state
;
80 BUG_ON(preemptible());
82 state
= &__get_cpu_var(runstate
);
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.
90 state_time
= get64(&state
->state_entry_time
);
94 } while (get64(&state
->state_entry_time
) != state_time
);
97 /* return true when a vcpu could run but has no real cpu to run on */
98 bool xen_vcpu_stolen(int vcpu
)
100 return per_cpu(runstate
, vcpu
).state
== RUNSTATE_runnable
;
103 static void setup_runstate_info(int cpu
)
105 struct vcpu_register_runstate_memory_area area
;
107 area
.addr
.v
= &per_cpu(runstate
, cpu
);
109 if (HYPERVISOR_vcpu_op(VCPUOP_register_runstate_memory_area
,
114 static void do_stolen_accounting(void)
116 struct vcpu_runstate_info state
;
117 struct vcpu_runstate_info
*snap
;
118 s64 blocked
, runnable
, offline
, stolen
;
121 get_runstate_snapshot(&state
);
123 WARN_ON(state
.state
!= RUNSTATE_running
);
125 snap
= &__get_cpu_var(runstate_snapshot
);
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
];
134 /* Add the appropriate number of ticks of stolen time,
135 including any left-overs from last time. */
136 stolen
= runnable
+ offline
+ __get_cpu_var(residual_stolen
);
141 ticks
= iter_div_u64_rem(stolen
, NS_PER_TICK
, &stolen
);
142 __get_cpu_var(residual_stolen
) = stolen
;
143 account_steal_ticks(ticks
);
145 /* Add the appropriate number of ticks of blocked time,
146 including any left-overs from last time. */
147 blocked
+= __get_cpu_var(residual_blocked
);
152 ticks
= iter_div_u64_rem(blocked
, NS_PER_TICK
, &blocked
);
153 __get_cpu_var(residual_blocked
) = blocked
;
154 account_idle_ticks(ticks
);
158 * Xen sched_clock implementation. Returns the number of unstolen
159 * nanoseconds, which is nanoseconds the VCPU spent in RUNNING+BLOCKED
162 unsigned long long xen_sched_clock(void)
164 struct vcpu_runstate_info state
;
170 * Ideally sched_clock should be called on a per-cpu basis
171 * anyway, so preempt should already be disabled, but that's
172 * not current practice at the moment.
176 now
= xen_clocksource_read();
178 get_runstate_snapshot(&state
);
180 WARN_ON(state
.state
!= RUNSTATE_running
);
182 offset
= now
- state
.state_entry_time
;
186 ret
= state
.time
[RUNSTATE_blocked
] +
187 state
.time
[RUNSTATE_running
] +
196 /* Get the TSC speed from Xen */
197 unsigned long xen_tsc_khz(void)
199 struct pvclock_vcpu_time_info
*info
=
200 &HYPERVISOR_shared_info
->vcpu_info
[0].time
;
202 return pvclock_tsc_khz(info
);
205 cycle_t
xen_clocksource_read(void)
207 struct pvclock_vcpu_time_info
*src
;
210 src
= &get_cpu_var(xen_vcpu
)->time
;
211 ret
= pvclock_clocksource_read(src
);
212 put_cpu_var(xen_vcpu
);
216 static cycle_t
xen_clocksource_get_cycles(struct clocksource
*cs
)
218 return xen_clocksource_read();
221 static void xen_read_wallclock(struct timespec
*ts
)
223 struct shared_info
*s
= HYPERVISOR_shared_info
;
224 struct pvclock_wall_clock
*wall_clock
= &(s
->wc
);
225 struct pvclock_vcpu_time_info
*vcpu_time
;
227 vcpu_time
= &get_cpu_var(xen_vcpu
)->time
;
228 pvclock_read_wallclock(wall_clock
, vcpu_time
, ts
);
229 put_cpu_var(xen_vcpu
);
232 unsigned long xen_get_wallclock(void)
236 xen_read_wallclock(&ts
);
240 int xen_set_wallclock(unsigned long now
)
242 /* do nothing for domU */
246 static struct clocksource xen_clocksource __read_mostly
= {
249 .read
= xen_clocksource_get_cycles
,
251 .mult
= 1<<XEN_SHIFT
, /* time directly in nanoseconds */
253 .flags
= CLOCK_SOURCE_IS_CONTINUOUS
,
257 Xen clockevent implementation
259 Xen has two clockevent implementations:
261 The old timer_op one works with all released versions of Xen prior
262 to version 3.0.4. This version of the hypervisor provides a
263 single-shot timer with nanosecond resolution. However, sharing the
264 same event channel is a 100Hz tick which is delivered while the
265 vcpu is running. We don't care about or use this tick, but it will
266 cause the core time code to think the timer fired too soon, and
267 will end up resetting it each time. It could be filtered, but
268 doing so has complications when the ktime clocksource is not yet
269 the xen clocksource (ie, at boot time).
271 The new vcpu_op-based timer interface allows the tick timer period
272 to be changed or turned off. The tick timer is not useful as a
273 periodic timer because events are only delivered to running vcpus.
274 The one-shot timer can report when a timeout is in the past, so
275 set_next_event is capable of returning -ETIME when appropriate.
276 This interface is used when available.
281 Get a hypervisor absolute time. In theory we could maintain an
282 offset between the kernel's time and the hypervisor's time, and
283 apply that to a kernel's absolute timeout. Unfortunately the
284 hypervisor and kernel times can drift even if the kernel is using
285 the Xen clocksource, because ntp can warp the kernel's clocksource.
287 static s64
get_abs_timeout(unsigned long delta
)
289 return xen_clocksource_read() + delta
;
292 static void xen_timerop_set_mode(enum clock_event_mode mode
,
293 struct clock_event_device
*evt
)
296 case CLOCK_EVT_MODE_PERIODIC
:
301 case CLOCK_EVT_MODE_ONESHOT
:
302 case CLOCK_EVT_MODE_RESUME
:
305 case CLOCK_EVT_MODE_UNUSED
:
306 case CLOCK_EVT_MODE_SHUTDOWN
:
307 HYPERVISOR_set_timer_op(0); /* cancel timeout */
312 static int xen_timerop_set_next_event(unsigned long delta
,
313 struct clock_event_device
*evt
)
315 WARN_ON(evt
->mode
!= CLOCK_EVT_MODE_ONESHOT
);
317 if (HYPERVISOR_set_timer_op(get_abs_timeout(delta
)) < 0)
320 /* We may have missed the deadline, but there's no real way of
321 knowing for sure. If the event was in the past, then we'll
322 get an immediate interrupt. */
327 static const struct clock_event_device xen_timerop_clockevent
= {
329 .features
= CLOCK_EVT_FEAT_ONESHOT
,
331 .max_delta_ns
= 0xffffffff,
332 .min_delta_ns
= TIMER_SLOP
,
338 .set_mode
= xen_timerop_set_mode
,
339 .set_next_event
= xen_timerop_set_next_event
,
344 static void xen_vcpuop_set_mode(enum clock_event_mode mode
,
345 struct clock_event_device
*evt
)
347 int cpu
= smp_processor_id();
350 case CLOCK_EVT_MODE_PERIODIC
:
351 WARN_ON(1); /* unsupported */
354 case CLOCK_EVT_MODE_ONESHOT
:
355 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
359 case CLOCK_EVT_MODE_UNUSED
:
360 case CLOCK_EVT_MODE_SHUTDOWN
:
361 if (HYPERVISOR_vcpu_op(VCPUOP_stop_singleshot_timer
, cpu
, NULL
) ||
362 HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
365 case CLOCK_EVT_MODE_RESUME
:
370 static int xen_vcpuop_set_next_event(unsigned long delta
,
371 struct clock_event_device
*evt
)
373 int cpu
= smp_processor_id();
374 struct vcpu_set_singleshot_timer single
;
377 WARN_ON(evt
->mode
!= CLOCK_EVT_MODE_ONESHOT
);
379 single
.timeout_abs_ns
= get_abs_timeout(delta
);
380 single
.flags
= VCPU_SSHOTTMR_future
;
382 ret
= HYPERVISOR_vcpu_op(VCPUOP_set_singleshot_timer
, cpu
, &single
);
384 BUG_ON(ret
!= 0 && ret
!= -ETIME
);
389 static const struct clock_event_device xen_vcpuop_clockevent
= {
391 .features
= CLOCK_EVT_FEAT_ONESHOT
,
393 .max_delta_ns
= 0xffffffff,
394 .min_delta_ns
= TIMER_SLOP
,
400 .set_mode
= xen_vcpuop_set_mode
,
401 .set_next_event
= xen_vcpuop_set_next_event
,
404 static const struct clock_event_device
*xen_clockevent
=
405 &xen_timerop_clockevent
;
406 static DEFINE_PER_CPU(struct clock_event_device
, xen_clock_events
);
408 static irqreturn_t
xen_timer_interrupt(int irq
, void *dev_id
)
410 struct clock_event_device
*evt
= &__get_cpu_var(xen_clock_events
);
414 if (evt
->event_handler
) {
415 evt
->event_handler(evt
);
419 do_stolen_accounting();
424 void xen_setup_timer(int cpu
)
427 struct clock_event_device
*evt
;
430 printk(KERN_INFO
"installing Xen timer for CPU %d\n", cpu
);
432 name
= kasprintf(GFP_KERNEL
, "timer%d", cpu
);
434 name
= "<timer kasprintf failed>";
436 irq
= bind_virq_to_irqhandler(VIRQ_TIMER
, cpu
, xen_timer_interrupt
,
437 IRQF_DISABLED
|IRQF_PERCPU
|IRQF_NOBALANCING
,
440 evt
= &per_cpu(xen_clock_events
, cpu
);
441 memcpy(evt
, xen_clockevent
, sizeof(*evt
));
443 evt
->cpumask
= cpumask_of(cpu
);
446 setup_runstate_info(cpu
);
449 void xen_teardown_timer(int cpu
)
451 struct clock_event_device
*evt
;
453 evt
= &per_cpu(xen_clock_events
, cpu
);
454 unbind_from_irqhandler(evt
->irq
, NULL
);
457 void xen_setup_cpu_clockevents(void)
459 BUG_ON(preemptible());
461 clockevents_register_device(&__get_cpu_var(xen_clock_events
));
464 void xen_timer_resume(void)
468 if (xen_clockevent
!= &xen_vcpuop_clockevent
)
471 for_each_online_cpu(cpu
) {
472 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
))
477 __init
void xen_time_init(void)
479 int cpu
= smp_processor_id();
481 clocksource_register(&xen_clocksource
);
483 if (HYPERVISOR_vcpu_op(VCPUOP_stop_periodic_timer
, cpu
, NULL
) == 0) {
484 /* Successfully turned off 100Hz tick, so we have the
485 vcpuop-based timer interface */
486 printk(KERN_DEBUG
"Xen: using vcpuop timer interface\n");
487 xen_clockevent
= &xen_vcpuop_clockevent
;
490 /* Set initial system time with full resolution */
491 xen_read_wallclock(&xtime
);
492 set_normalized_timespec(&wall_to_monotonic
,
493 -xtime
.tv_sec
, -xtime
.tv_nsec
);
495 setup_force_cpu_cap(X86_FEATURE_TSC
);
497 xen_setup_timer(cpu
);
498 xen_setup_cpu_clockevents();