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>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #include <palacios/vmm.h>
21 #include <palacios/vmm_intr.h>
22 #include <palacios/vmm_config.h>
23 #include <palacios/vm_guest.h>
24 #include <palacios/vmm_ctrl_regs.h>
25 #include <palacios/vmm_lowlevel.h>
26 #include <palacios/vmm_sprintf.h>
27 #include <palacios/vmm_extensions.h>
30 #include <palacios/svm.h>
33 #include <palacios/vmx.h>
36 #ifdef V3_CONFIG_CHECKPOINT
37 #include <palacios/vmm_checkpoint.h>
41 v3_cpu_arch_t v3_cpu_types[V3_CONFIG_MAX_CPUS];
42 struct v3_os_hooks * os_hooks = NULL;
43 int v3_dbg_enable = 0;
48 static void init_cpu(void * arg) {
49 uint32_t cpu_id = (uint32_t)(addr_t)arg;
52 if (v3_is_svm_capable()) {
53 PrintDebug("Machine is SVM Capable\n");
54 v3_init_svm_cpu(cpu_id);
59 if (v3_is_vmx_capable()) {
60 PrintDebug("Machine is VMX Capable\n");
61 v3_init_vmx_cpu(cpu_id);
66 PrintError("CPU has no virtualization Extensions\n");
71 static void deinit_cpu(void * arg) {
72 uint32_t cpu_id = (uint32_t)(addr_t)arg;
75 switch (v3_cpu_types[cpu_id]) {
79 PrintDebug("Deinitializing SVM CPU %d\n", cpu_id);
80 v3_deinit_svm_cpu(cpu_id);
86 case V3_VMX_EPT_UG_CPU:
87 PrintDebug("Deinitializing VMX CPU %d\n", cpu_id);
88 v3_deinit_vmx_cpu(cpu_id);
93 PrintError("CPU has no virtualization Extensions\n");
100 void Init_V3(struct v3_os_hooks * hooks, int num_cpus) {
103 V3_Print("V3 Print statement to fix a Kitten page fault bug\n");
105 // Set global variables.
108 for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
109 v3_cpu_types[i] = V3_INVALID_CPU;
112 // Register all the possible device types
115 // Register all shadow paging handlers
116 V3_init_shdw_paging();
118 // Register all extensions
119 V3_init_extensions();
122 #ifdef V3_CONFIG_SYMMOD
126 #ifdef V3_CONFIG_CHECKPOINT
127 V3_init_checkpoint();
133 if ((hooks) && (hooks->call_on_cpu)) {
135 for (i = 0; i < num_cpus; i++) {
137 V3_Print("Initializing VMM extensions on cpu %d\n", i);
138 hooks->call_on_cpu(i, &init_cpu, (void *)(addr_t)i);
150 V3_deinit_shdw_paging();
152 V3_deinit_extensions();
154 #ifdef V3_CONFIG_SYMMOD
158 #ifdef V3_CONFIG_CHECKPOINT
159 V3_deinit_checkpoint();
163 if ((os_hooks) && (os_hooks->call_on_cpu)) {
164 for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
165 if (v3_cpu_types[i] != V3_INVALID_CPU) {
166 V3_Call_On_CPU(i, deinit_cpu, (void *)(addr_t)i);
167 //deinit_cpu((void *)(addr_t)i);
175 v3_cpu_arch_t v3_get_cpu_type(int cpu_id) {
176 return v3_cpu_types[cpu_id];
180 struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name) {
181 struct v3_vm_info * vm = v3_config_guest(cfg, priv_data);
184 PrintError("Could not configure guest\n");
188 V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
192 } else if (strlen(name) >= 128) {
193 PrintError("VM name is too long. Will be truncated to 128 chars.\n");
196 memset(vm->name, 0, 128);
197 strncpy(vm->name, name, 127);
205 static int start_core(void * p)
207 struct guest_info * core = (struct guest_info *)p;
210 PrintDebug("virtual core %u (on logical core %u): in start_core (RIP=%p)\n",
211 core->vcpu_id, core->pcpu_id, (void *)(addr_t)core->rip);
213 switch (v3_cpu_types[0]) {
216 case V3_SVM_REV3_CPU:
217 return v3_start_svm_guest(core);
223 case V3_VMX_EPT_UG_CPU:
224 return v3_start_vmx_guest(core);
228 PrintError("Attempting to enter a guest on an invalid CPU\n");
236 // For the moment very ugly. Eventually we will shift the cpu_mask to an arbitrary sized type...
240 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask) {
242 uint8_t * core_mask = (uint8_t *)&cpu_mask; // This is to make future expansion easier
243 uint32_t avail_cores = 0;
246 /// CHECK IF WE ARE MULTICORE ENABLED....
248 V3_Print("V3 -- Starting VM (%u cores)\n", vm->num_cores);
249 V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
252 // Check that enough cores are present in the mask to handle vcores
253 for (i = 0; i < MAX_CORES; i++) {
257 if (core_mask[major] & (0x1 << minor)) {
263 if (vm->num_cores > avail_cores) {
264 PrintError("Attempted to start a VM with too many cores (vm->num_cores = %d, avail_cores = %d, MAX=%d)\n",
265 vm->num_cores, avail_cores, MAX_CORES);
269 // Spawn off threads for each core.
270 // We work backwards, so that core 0 is always started last.
271 for (i = 0, vcore_id = vm->num_cores - 1; (i < MAX_CORES) && (vcore_id >= 0); i++) {
274 struct guest_info * core = &(vm->cores[vcore_id]);
275 char * specified_cpu = v3_cfg_val(core->core_cfg_data, "target_cpu");
276 uint32_t core_idx = 0;
278 if (specified_cpu != NULL) {
279 core_idx = atoi(specified_cpu);
281 if ((core_idx < 0) || (core_idx >= MAX_CORES)) {
282 PrintError("Target CPU out of bounds (%d) (MAX_CORES=%d)\n", core_idx, MAX_CORES);
285 i--; // We reset the logical core idx. Not strictly necessary I guess...
290 major = core_idx / 8;
291 minor = core_idx % 8;
293 if ((core_mask[major] & (0x1 << minor)) == 0) {
294 PrintError("Logical CPU %d not available for virtual core %d; not started\n",
297 if (specified_cpu != NULL) {
298 PrintError("CPU was specified explicitly (%d). HARD ERROR\n", core_idx);
306 PrintDebug("Starting virtual core %u on logical core %u\n",
309 sprintf(core->exec_name, "%s-%u", vm->name, vcore_id);
311 PrintDebug("run: core=%u, func=0x%p, arg=0x%p, name=%s\n",
312 core_idx, start_core, core, core->exec_name);
314 core->pcpu_id = core_idx;
315 core->core_thread = V3_CREATE_THREAD_ON_CPU(core_idx, start_core, core, core->exec_name);
317 if (core->core_thread == NULL) {
318 PrintError("Thread launch failed\n");
332 int v3_reset_vm_core(struct guest_info * core, addr_t rip) {
334 switch (v3_cpu_types[core->pcpu_id]) {
337 case V3_SVM_REV3_CPU:
338 PrintDebug("Resetting SVM Guest CPU %d\n", core->vcpu_id);
339 return v3_reset_svm_vm_core(core, rip);
344 case V3_VMX_EPT_UG_CPU:
345 PrintDebug("Resetting VMX Guest CPU %d\n", core->vcpu_id);
346 return v3_reset_vmx_vm_core(core, rip);
350 PrintError("CPU has no virtualization Extensions\n");
359 /* move a virtual core to different physical core */
360 int v3_move_vm_core(struct v3_vm_info * vm, int vcore_id, int target_cpu) {
361 struct guest_info * core = NULL;
363 if ((vcore_id < 0) || (vcore_id >= vm->num_cores)) {
364 PrintError("Attempted to migrate invalid virtual core (%d)\n", vcore_id);
368 core = &(vm->cores[vcore_id]);
370 if (target_cpu == core->pcpu_id) {
371 PrintError("Attempted to migrate to local core (%d)\n", target_cpu);
372 // well that was pointless
376 if (core->core_thread == NULL) {
377 PrintError("Attempted to migrate a core without a valid thread context\n");
381 while (v3_raise_barrier(vm, NULL) == -1);
383 V3_Print("Performing Migration from %d to %d\n", core->pcpu_id, target_cpu);
385 // Double check that we weren't preemptively migrated
386 if (target_cpu != core->pcpu_id) {
388 V3_Print("Moving Core\n");
392 switch (v3_cpu_types[core->pcpu_id]) {
395 case V3_VMX_EPT_UG_CPU:
396 PrintDebug("Flushing VMX Guest CPU %d\n", core->vcpu_id);
397 V3_Call_On_CPU(core->pcpu_id, (void (*)(void *))v3_flush_vmx_vm_core, (void *)core);
404 if (V3_MOVE_THREAD_TO_CPU(target_cpu, core->core_thread) != 0) {
405 PrintError("Failed to move Vcore %d to CPU %d\n",
406 core->vcpu_id, target_cpu);
407 v3_lower_barrier(vm);
411 /* There will be a benign race window here:
412 core->pcpu_id will be set to the target core before its fully "migrated"
413 However the core will NEVER run on the old core again, its just in flight to the new core
415 core->pcpu_id = target_cpu;
417 V3_Print("core now at %d\n", core->pcpu_id);
424 v3_lower_barrier(vm);
431 int v3_stop_vm(struct v3_vm_info * vm) {
433 vm->run_state = VM_STOPPED;
435 // force exit all cores via a cross call/IPI
439 int still_running = 0;
441 for (i = 0; i < vm->num_cores; i++) {
442 if (vm->cores[i].core_run_state != CORE_STOPPED) {
447 if (still_running == 0) {
454 V3_Print("VM stopped. Returning\n");
460 int v3_pause_vm(struct v3_vm_info * vm) {
462 if (vm->run_state != VM_RUNNING) {
463 PrintError("Tried to pause a VM that was not running\n");
467 while (v3_raise_barrier(vm, NULL) == -1);
469 vm->run_state = VM_PAUSED;
475 int v3_continue_vm(struct v3_vm_info * vm) {
477 if (vm->run_state != VM_PAUSED) {
478 PrintError("Tried to continue a VM that was not paused\n");
482 v3_lower_barrier(vm);
484 vm->run_state = VM_RUNNING;
489 #ifdef V3_CONFIG_CHECKPOINT
490 #include <palacios/vmm_checkpoint.h>
492 int v3_save_vm(struct v3_vm_info * vm, char * store, char * url) {
493 return v3_chkpt_save_vm(vm, store, url);
497 int v3_load_vm(struct v3_vm_info * vm, char * store, char * url) {
498 return v3_chkpt_load_vm(vm, store, url);
503 int v3_free_vm(struct v3_vm_info * vm) {
505 // deinitialize guest (free memory, etc...)
507 v3_free_vm_devices(vm);
510 for (i = 0; i < vm->num_cores; i++) {
511 v3_free_core(&(vm->cores[i]));
515 v3_free_vm_internal(vm);
527 v3_cpu_mode_t v3_get_host_cpu_mode() {
537 cr4 = (struct cr4_32 *)&(cr4_val);
540 return PROTECTED_PAE;
548 v3_cpu_mode_t v3_get_host_cpu_mode() {
555 #define V3_Yield(addr) \
557 extern struct v3_os_hooks * os_hooks; \
558 if ((os_hooks) && (os_hooks)->yield_cpu) { \
559 (os_hooks)->yield_cpu(); \
565 void v3_yield_cond(struct guest_info * info) {
567 cur_cycle = v3_get_host_time(&info->time_state);
569 if (cur_cycle > (info->yield_start_cycle + info->vm_info->yield_cycle_period)) {
572 PrintDebug("Conditional Yield (cur_cyle=%p, start_cycle=%p, period=%p)\n",
573 (void *)cur_cycle, (void *)info->yield_start_cycle, (void *)info->yield_cycle_period);
576 info->yield_start_cycle = v3_get_host_time(&info->time_state);
582 * unconditional cpu yield
583 * if the yielding thread is a guest context, the guest quantum is reset on resumption
584 * Non guest context threads should call this function with a NULL argument
586 void v3_yield(struct guest_info * info) {
590 info->yield_start_cycle = v3_get_host_time(&info->time_state);
597 void v3_print_cond(const char * fmt, ...) {
598 if (v3_dbg_enable == 1) {
603 vsnprintf(buf, 2048, fmt, ap);
612 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector) {
613 extern struct v3_os_hooks * os_hooks;
615 if ((os_hooks) && (os_hooks)->interrupt_cpu) {
616 (os_hooks)->interrupt_cpu(vm, logical_cpu, vector);
622 int v3_vm_enter(struct guest_info * info) {
623 switch (v3_cpu_types[0]) {
626 case V3_SVM_REV3_CPU:
627 return v3_svm_enter(info);
633 case V3_VMX_EPT_UG_CPU:
634 return v3_vmx_enter(info);
638 PrintError("Attemping to enter a guest on an invalid CPU\n");