2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Jack Lange <jarusl@cs.northwestern.edu>
15 * Patrick G. Bridges <bridges@cs.unm.edu>
17 * This is free software. You are permitted to use,
18 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
21 #include <palacios/vmm.h>
22 #include <palacios/vmm_time.h>
23 #include <palacios/vm_guest.h>
25 #ifndef V3_CONFIG_DEBUG_TIME
27 #define PrintDebug(fmt, args...)
32 * Time handling in VMMs is challenging, and Palacios uses the highest
33 * resolution, lowest overhead timer on modern CPUs that it can - the
34 * processor timestamp counter (TSC). Note that on somewhat old processors
35 * this can be problematic; in particular, older AMD processors did not
36 * have a constant rate timestamp counter in the face of power management
37 * events. However, the latest Intel and AMD CPUs all do (should...) have a
38 * constant rate TSC, and Palacios relies on this fact.
40 * Basically, Palacios keeps track of three quantities as it runs to manage
41 * the passage of time:
42 * (1) The host timestamp counter - read directly from HW and never written
43 * (2) A monotonic guest timestamp counter used to measure the progression of
44 * time in the guest. This is computed using an offsets from (1) above.
45 * (3) The actual guest timestamp counter (which can be written by
46 * writing to the guest TSC MSR - MSR 0x10) from the monotonic guest TSC.
47 * This is also computed as an offset from (2) above when the TSC and
48 * this offset is updated when the TSC MSR is written.
50 * The value used to offset the guest TSC from the host TSC is the *sum* of all
51 * of these offsets (2 and 3) above
53 * Because all other devices are slaved off of the passage of time in the guest,
54 * it is (2) above that drives the firing of other timers in the guest,
55 * including timer devices such as the Programmable Interrupt Timer (PIT).
58 * (1) Add support for temporarily skewing guest time off of where it should
59 * be to support slack simulation of guests. The idea is that simulators
60 * set this skew to be the difference between how much time passed for a
61 * simulated feature and a real implementation of that feature, making time
62 * pass at a different rate from real time on this core. The VMM will then
63 * attempt to move this skew back towards 0 subject to resolution/accuracy
64 * constraints from various system timers.
66 * The main effort in doing this will be to get accuracy/resolution
67 * information from each local timer and to use this to bound how much skew
68 * is removed on each exit.
70 * (2) Look more into sychronizing the offsets *across* virtual and physical
71 * cores so that multicore guests stay mostly in sync.
73 * (3) Look into using the AMD TSC multiplier feature and adding explicit time
74 * dilation support to time handling.
78 static int handle_cpufreq_hcall(struct guest_info * info, uint_t hcall_id, void * priv_data) {
79 struct vm_core_time * time_state = &(info->time_state);
81 info->vm_regs.rbx = time_state->guest_cpu_freq;
83 PrintDebug("Guest request cpu frequency: return %ld\n", (long)info->vm_regs.rbx);
90 int v3_start_time(struct guest_info * info) {
91 /* We start running with guest_time == host_time */
92 uint64_t t = v3_get_host_time(&info->time_state);
94 PrintDebug("Starting initial guest time as %llu\n", t);
96 info->time_state.enter_time = 0;
97 info->time_state.exit_time = t;
98 info->time_state.last_update = t;
99 info->time_state.initial_time = t;
100 info->yield_start_cycle = t;
105 int v3_pause_time( struct guest_info * info )
107 struct vm_core_time * time_state = &(info->time_state);
108 if (time_state->pause_time != 0) {
109 PrintError("Attempted to pause time when time already paused.\n");
112 time_state->pause_time = v3_get_host_time( time_state );
117 int v3_resume_time( struct guest_info * info )
119 struct vm_core_time * time_state = &(info->time_state);
120 uint64_t host_time, guest_time;
123 if (time_state->pause_time == 0) {
124 PrintError("Attempted to resume time when time not paused.\n");
128 host_time = v3_get_host_time(time_state);
129 guest_time = v3_compute_guest_time(time_state, host_time);
130 offset = (sint64_t)guest_time - (sint64_t)host_time;
131 time_state->guest_host_offset = offset;
132 time_state->pause_time = 0;
137 int v3_offset_time( struct guest_info * info, sint64_t offset )
139 struct vm_core_time * time_state = &(info->time_state);
140 PrintDebug("Adding additional offset of %lld to guest time.\n", offset);
141 time_state->guest_host_offset += offset;
145 #ifdef V3_CONFIG_TIME_DILATION
146 static uint64_t compute_target_host_time(struct guest_info * info, uint64_t guest_time)
148 struct vm_core_time * time_state = &(info->time_state);
149 uint64_t guest_elapsed, desired_elapsed;
151 guest_elapsed = (guest_time - time_state->initial_time);
152 desired_elapsed = (guest_elapsed * time_state->host_cpu_freq) / time_state->guest_cpu_freq;
153 return time_state->initial_time + desired_elapsed;
156 static uint64_t compute_target_guest_time(struct guest_info *info)
158 struct vm_core_time * time_state = &(info->time_state);
159 uint64_t host_elapsed, desired_elapsed;
161 host_elapsed = v3_get_host_time(time_state) - time_state->initial_time;
162 desired_elapsed = (host_elapsed * time_state->guest_cpu_freq) / time_state->host_cpu_freq;
164 return time_state->initial_time + desired_elapsed;
168 /* Yield time in the host to deal with a guest that wants to run slower than
169 * the native host cycle frequency */
170 static int yield_host_time(struct guest_info * info) {
171 struct vm_core_time * time_state = &(info->time_state);
172 uint64_t host_time, target_host_time;
173 uint64_t guest_time, old_guest_time;
175 /* Now, let the host run while the guest is stopped to make the two
176 * sync up. Note that this doesn't assume that guest time is stopped;
177 * the offsetting in the next step will change add an offset to guest
178 * time to account for the time paused even if the geust isn't
179 * usually paused in the VMM. */
180 host_time = v3_get_host_time(time_state);
181 old_guest_time = v3_compute_guest_time(time_state, host_time);
182 target_host_time = compute_target_host_time(info, old_guest_time);
184 while (target_host_time > host_time) {
186 host_time = v3_get_host_time(time_state);
189 guest_time = v3_compute_guest_time(time_state, host_time);
191 /* We do *not* assume the guest timer was paused in the VM. If it was
192 * this offseting is 0. If it wasn't, we need this. */
193 v3_offset_time(info, (sint64_t)(old_guest_time - guest_time));
198 static int skew_guest_time(struct guest_info * info) {
199 struct vm_core_time * time_state = &(info->time_state);
200 uint64_t target_guest_time, guest_time;
201 /* Now the host may have gotten ahead of the guest because
202 * yielding is a coarse grained thing. Figure out what guest time
203 * we want to be at, and use the use the offsetting mechanism in
204 * the VMM to make the guest run forward. We limit *how* much we skew
205 * it forward to prevent the guest time making large jumps,
207 target_guest_time = compute_target_guest_time(info);
208 guest_time = v3_get_guest_time(time_state);
210 if (guest_time < target_guest_time) {
211 sint64_t max_skew, desired_skew, skew;
213 if (time_state->enter_time) {
214 /* Limit forward skew to 10% of the amount the guest has
215 * run since we last could skew time */
216 max_skew = (sint64_t)(guest_time - time_state->enter_time) / 10;
221 desired_skew = (sint64_t)(target_guest_time - guest_time);
222 skew = desired_skew > max_skew ? max_skew : desired_skew;
223 PrintDebug("Guest %lld cycles behind where it should be.\n",
225 PrintDebug("Limit on forward skew is %lld. Skewing forward %lld.\n",
228 v3_offset_time(info, skew);
233 #endif /* V3_CONFIG_TIME_DILATION */
235 // Control guest time in relation to host time so that the two stay
236 // appropriately synchronized to the extent possible.
237 int v3_adjust_time(struct guest_info * info) {
239 #ifdef V3_CONFIG_TIME_DILATION
240 /* First deal with yielding if we want to slow down the guest */
241 yield_host_time(info);
243 /* Now, if the guest is too slow, (either from excess yielding above,
244 * or because the VMM is doing something that takes a long time to emulate)
245 * allow guest time to jump forward a bit */
246 skew_guest_time(info);
251 /* Called immediately upon entry in the the VMM */
253 v3_time_exit_vm( struct guest_info * info, uint64_t * guest_cycles )
255 struct vm_core_time * time_state = &(info->time_state);
257 time_state->exit_time = v3_get_host_time(time_state);
259 #ifdef V3_CONFIG_TIME_DILATION
260 v3_pause_time( info );
266 /* Called immediately prior to entry to the VM */
268 v3_time_enter_vm( struct guest_info * info )
270 struct vm_core_time * time_state = &(info->time_state);
273 host_time = v3_get_host_time(time_state);
274 time_state->enter_time = host_time;
275 #ifdef V3_CONFIG_TIME_DILATION
276 v3_resume_time( info );
278 time_state->guest_host_offset = 0;
286 struct v3_timer * v3_add_timer(struct guest_info * info,
287 struct v3_timer_ops * ops,
288 void * private_data) {
289 struct v3_timer * timer = NULL;
290 timer = (struct v3_timer *)V3_Malloc(sizeof(struct v3_timer));
291 V3_ASSERT(timer != NULL);
294 timer->private_data = private_data;
296 list_add(&(timer->timer_link), &(info->time_state.timers));
297 info->time_state.num_timers++;
302 int v3_remove_timer(struct guest_info * info, struct v3_timer * timer) {
303 list_del(&(timer->timer_link));
304 info->time_state.num_timers--;
310 void v3_update_timers(struct guest_info * info) {
311 struct vm_core_time *time_state = &info->time_state;
312 struct v3_timer * tmp_timer;
314 uint64_t old_time = info->time_state.last_update;
316 time_state->last_update = v3_get_guest_time(time_state);
317 cycles = (sint64_t)(time_state->last_update - old_time);
318 V3_ASSERT(cycles >= 0);
320 // V3_Print("Updating timers with %lld elapsed cycles.\n", cycles);
321 list_for_each_entry(tmp_timer, &(time_state->timers), timer_link) {
322 tmp_timer->ops->update_timer(info, cycles, time_state->guest_cpu_freq, tmp_timer->private_data);
328 * Handle full virtualization of the time stamp counter. As noted
329 * above, we don't store the actual value of the TSC, only the guest's
330 * offset from monotonic guest's time. If the guest writes to the TSC, we
331 * handle this by changing that offset.
333 * Possible TODO: Proper hooking of TSC read/writes?
336 int v3_rdtsc(struct guest_info * info) {
337 uint64_t tscval = v3_get_guest_tsc(&info->time_state);
339 info->vm_regs.rdx = tscval >> 32;
340 info->vm_regs.rax = tscval & 0xffffffffLL;
345 int v3_handle_rdtsc(struct guest_info * info) {
348 info->vm_regs.rax &= 0x00000000ffffffffLL;
349 info->vm_regs.rdx &= 0x00000000ffffffffLL;
356 int v3_rdtscp(struct guest_info * info) {
358 /* First get the MSR value that we need. It's safe to futz with
359 * ra/c/dx here since they're modified by this instruction anyway. */
360 info->vm_regs.rcx = TSC_AUX_MSR;
361 ret = v3_handle_msr_read(info);
367 info->vm_regs.rcx = info->vm_regs.rax;
369 /* Now do the TSC half of the instruction */
370 ret = v3_rdtsc(info);
380 int v3_handle_rdtscp(struct guest_info * info) {
381 PrintDebug("Handling virtual RDTSCP call.\n");
385 info->vm_regs.rax &= 0x00000000ffffffffLL;
386 info->vm_regs.rcx &= 0x00000000ffffffffLL;
387 info->vm_regs.rdx &= 0x00000000ffffffffLL;
394 static int tsc_aux_msr_read_hook(struct guest_info *info, uint_t msr_num,
395 struct v3_msr *msr_val, void *priv) {
396 struct vm_core_time * time_state = &(info->time_state);
398 V3_ASSERT(msr_num == TSC_AUX_MSR);
400 msr_val->lo = time_state->tsc_aux.lo;
401 msr_val->hi = time_state->tsc_aux.hi;
406 static int tsc_aux_msr_write_hook(struct guest_info *info, uint_t msr_num,
407 struct v3_msr msr_val, void *priv) {
408 struct vm_core_time * time_state = &(info->time_state);
410 V3_ASSERT(msr_num == TSC_AUX_MSR);
412 time_state->tsc_aux.lo = msr_val.lo;
413 time_state->tsc_aux.hi = msr_val.hi;
418 static int tsc_msr_read_hook(struct guest_info *info, uint_t msr_num,
419 struct v3_msr *msr_val, void *priv) {
420 uint64_t time = v3_get_guest_tsc(&info->time_state);
422 V3_ASSERT(msr_num == TSC_MSR);
424 msr_val->hi = time >> 32;
425 msr_val->lo = time & 0xffffffffLL;
430 static int tsc_msr_write_hook(struct guest_info *info, uint_t msr_num,
431 struct v3_msr msr_val, void *priv) {
432 struct vm_core_time * time_state = &(info->time_state);
433 uint64_t guest_time, new_tsc;
435 V3_ASSERT(msr_num == TSC_MSR);
437 new_tsc = (((uint64_t)msr_val.hi) << 32) | (uint64_t)msr_val.lo;
438 guest_time = v3_get_guest_time(time_state);
439 time_state->tsc_guest_offset = (sint64_t)new_tsc - (sint64_t)guest_time;
445 int v3_init_time_vm(struct v3_vm_info * vm) {
448 PrintDebug("Installing TSC MSR hook.\n");
449 ret = v3_hook_msr(vm, TSC_MSR,
450 tsc_msr_read_hook, tsc_msr_write_hook, NULL);
456 PrintDebug("Installing TSC_AUX MSR hook.\n");
457 ret = v3_hook_msr(vm, TSC_AUX_MSR, tsc_aux_msr_read_hook,
458 tsc_aux_msr_write_hook, NULL);
464 PrintDebug("Registering TIME_CPUFREQ hypercall.\n");
465 ret = v3_register_hypercall(vm, TIME_CPUFREQ_HCALL,
466 handle_cpufreq_hcall, NULL);
468 PrintDebug("Setting base time dilation factor.\n");
469 vm->time_state.td_mult = 1;
474 void v3_deinit_time_vm(struct v3_vm_info * vm) {
475 v3_unhook_msr(vm, TSC_MSR);
476 v3_unhook_msr(vm, TSC_AUX_MSR);
478 v3_remove_hypercall(vm, TIME_CPUFREQ_HCALL);
481 void v3_init_time_core(struct guest_info * info) {
482 struct vm_core_time * time_state = &(info->time_state);
483 v3_cfg_tree_t * cfg_tree = info->core_cfg_data;
486 time_state->host_cpu_freq = V3_CPU_KHZ();
487 khz = v3_cfg_val(cfg_tree, "khz");
490 time_state->guest_cpu_freq = atoi(khz);
491 PrintDebug("Logical Core %d (vcpu=%d) CPU frequency requested at %d khz.\n",
492 info->pcpu_id, info->vcpu_id, time_state->guest_cpu_freq);
495 if ( (khz == NULL) ||
496 (time_state->guest_cpu_freq <= 0) ||
497 (time_state->guest_cpu_freq > time_state->host_cpu_freq) ) {
499 time_state->guest_cpu_freq = time_state->host_cpu_freq;
502 PrintDebug("Logical Core %d (vcpu=%d) CPU frequency set to %d KHz (host CPU frequency = %d KHz).\n",
503 info->pcpu_id, info->vcpu_id,
504 time_state->guest_cpu_freq,
505 time_state->host_cpu_freq);
507 time_state->initial_time = 0;
508 time_state->last_update = 0;
509 time_state->guest_host_offset = 0;
510 time_state->tsc_guest_offset = 0;
511 time_state->enter_time = 0;
512 time_state->exit_time = 0;
513 time_state->pause_time = 0;
516 INIT_LIST_HEAD(&(time_state->timers));
517 time_state->num_timers = 0;
519 time_state->tsc_aux.lo = 0;
520 time_state->tsc_aux.hi = 0;
524 void v3_deinit_time_core(struct guest_info * core) {
525 struct vm_core_time * time_state = &(core->time_state);
526 struct v3_timer * tmr = NULL;
527 struct v3_timer * tmp = NULL;
529 list_for_each_entry_safe(tmr, tmp, &(time_state->timers), timer_link) {
530 v3_remove_timer(core, tmr);