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>
37 v3_cpu_arch_t v3_cpu_types[V3_CONFIG_MAX_CPUS];
38 struct v3_os_hooks * os_hooks = NULL;
39 int v3_dbg_enable = 0;
43 static void init_cpu(void * arg) {
44 uint32_t cpu_id = (uint32_t)(addr_t)arg;
47 if (v3_is_svm_capable()) {
48 PrintDebug("Machine is SVM Capable\n");
49 v3_init_svm_cpu(cpu_id);
54 if (v3_is_vmx_capable()) {
55 PrintDebug("Machine is VMX Capable\n");
56 v3_init_vmx_cpu(cpu_id);
61 PrintError("CPU has no virtualization Extensions\n");
66 static void deinit_cpu(void * arg) {
67 uint32_t cpu_id = (uint32_t)(addr_t)arg;
70 switch (v3_cpu_types[cpu_id]) {
74 PrintDebug("Deinitializing SVM CPU %d\n", cpu_id);
75 v3_deinit_svm_cpu(cpu_id);
81 case V3_VMX_EPT_UG_CPU:
82 PrintDebug("Deinitializing VMX CPU %d\n", cpu_id);
83 v3_deinit_vmx_cpu(cpu_id);
88 PrintError("CPU has no virtualization Extensions\n");
95 void Init_V3(struct v3_os_hooks * hooks, int num_cpus) {
98 V3_Print("V3 Print statement to fix a Kitten page fault bug\n");
100 // Set global variables.
103 for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
104 v3_cpu_types[i] = V3_INVALID_CPU;
107 // Register all the possible device types
110 // Register all shadow paging handlers
111 V3_init_shdw_paging();
113 // Register all extensions
114 V3_init_extensions();
117 #ifdef V3_CONFIG_SYMMOD
123 #ifdef V3_CONFIG_MULTITHREAD_OS
124 if ((hooks) && (hooks->call_on_cpu)) {
126 for (i = 0; i < num_cpus; i++) {
128 V3_Print("Initializing VMM extensions on cpu %d\n", i);
129 hooks->call_on_cpu(i, &init_cpu, (void *)(addr_t)i);
143 V3_deinit_shdw_paging();
145 V3_deinit_extensions();
147 #ifdef V3_CONFIG_SYMMOD
152 #ifdef V3_CONFIG_MULTITHREAD_OS
153 if ((os_hooks) && (os_hooks->call_on_cpu)) {
154 for (i = 0; i < V3_CONFIG_MAX_CPUS; i++) {
155 if (v3_cpu_types[i] != V3_INVALID_CPU) {
156 deinit_cpu((void *)(addr_t)i);
167 v3_cpu_arch_t v3_get_cpu_type(int cpu_id) {
168 return v3_cpu_types[cpu_id];
172 struct v3_vm_info * v3_create_vm(void * cfg, void * priv_data, char * name) {
173 struct v3_vm_info * vm = v3_config_guest(cfg, priv_data);
176 PrintError("Could not configure guest\n");
180 V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
184 } else if (strlen(name) >= 128) {
185 PrintError("VM name is too long. Will be truncated to 128 chars.\n");
188 memset(vm->name, 0, 128);
189 strncpy(vm->name, name, 127);
195 static int start_core(void * p)
197 struct guest_info * core = (struct guest_info *)p;
200 PrintDebug("virtual core %u (on logical core %u): in start_core (RIP=%p)\n",
201 core->vcpu_id, core->pcpu_id, (void *)(addr_t)core->rip);
203 switch (v3_cpu_types[0]) {
206 case V3_SVM_REV3_CPU:
207 return v3_start_svm_guest(core);
213 case V3_VMX_EPT_UG_CPU:
214 return v3_start_vmx_guest(core);
218 PrintError("Attempting to enter a guest on an invalid CPU\n");
226 // For the moment very ugly. Eventually we will shift the cpu_mask to an arbitrary sized type...
227 #ifdef V3_CONFIG_MULTITHREAD_OS
234 int v3_start_vm(struct v3_vm_info * vm, unsigned int cpu_mask) {
236 uint8_t * core_mask = (uint8_t *)&cpu_mask; // This is to make future expansion easier
237 uint32_t avail_cores = 0;
240 /// CHECK IF WE ARE MULTICORE ENABLED....
242 V3_Print("V3 -- Starting VM (%u cores)\n", vm->num_cores);
243 V3_Print("CORE 0 RIP=%p\n", (void *)(addr_t)(vm->cores[0].rip));
246 // Check that enough cores are present in the mask to handle vcores
247 for (i = 0; i < MAX_CORES; i++) {
251 if (core_mask[major] & (0x1 << minor)) {
257 if (vm->num_cores > avail_cores) {
258 PrintError("Attempted to start a VM with too many cores (vm->num_cores = %d, avail_cores = %d, MAX=%d)\n",
259 vm->num_cores, avail_cores, MAX_CORES);
263 #ifdef V3_CONFIG_MULTITHREAD_OS
264 // spawn off new threads, for other cores
265 for (i = 0, vcore_id = 1; (i < MAX_CORES) && (vcore_id < vm->num_cores); i++) {
268 void * core_thread = NULL;
269 struct guest_info * core = &(vm->cores[vcore_id]);
270 char * specified_cpu = v3_cfg_val(core->core_cfg_data, "target_cpu");
271 uint32_t core_idx = 0;
273 if (specified_cpu != NULL) {
274 core_idx = atoi(specified_cpu);
276 if ((core_idx < 0) || (core_idx >= MAX_CORES)) {
277 PrintError("Target CPU out of bounds (%d) (MAX_CORES=%d)\n", core_idx, MAX_CORES);
280 i--; // We reset the logical core idx. Not strictly necessary I guess...
283 if (i == V3_Get_CPU()) {
284 // We skip the local CPU because it is reserved for vcore 0
291 major = core_idx / 8;
292 minor = core_idx % 8;
295 if ((core_mask[major] & (0x1 << minor)) == 0) {
296 PrintError("Logical CPU %d not available for virtual core %d; not started\n",
299 if (specified_cpu != NULL) {
300 PrintError("CPU was specified explicitly (%d). HARD ERROR\n", core_idx);
308 PrintDebug("Starting virtual core %u on logical core %u\n",
311 sprintf(core->exec_name, "%s-%u", vm->name, vcore_id);
313 PrintDebug("run: core=%u, func=0x%p, arg=0x%p, name=%s\n",
314 core_idx, start_core, core, core->exec_name);
316 // TODO: actually manage these threads instead of just launching them
317 core->pcpu_id = core_idx;
318 core_thread = V3_CREATE_THREAD_ON_CPU(core_idx, start_core, core, core->exec_name);
320 if (core_thread == NULL) {
321 PrintError("Thread launch failed\n");
330 sprintf(vm->cores[0].exec_name, "%s", vm->name);
332 vm->cores[0].pcpu_id = V3_Get_CPU();
334 if (start_core(&(vm->cores[0])) != 0) {
335 PrintError("Error starting VM core 0\n");
348 int v3_stop_vm(struct v3_vm_info * vm) {
350 vm->run_state = VM_STOPPED;
352 // force exit all cores via a cross call/IPI
356 int still_running = 0;
358 for (i = 0; i < vm->num_cores; i++) {
359 if (vm->cores[i].core_run_state != CORE_STOPPED) {
364 if (still_running == 0) {
371 V3_Print("VM stopped. Returning\n");
377 int v3_free_vm(struct v3_vm_info * vm) {
379 // deinitialize guest (free memory, etc...)
381 v3_free_vm_devices(vm);
384 for (i = 0; i < vm->num_cores; i++) {
385 v3_free_core(&(vm->cores[i]));
389 v3_free_vm_internal(vm);
401 v3_cpu_mode_t v3_get_host_cpu_mode() {
411 cr4 = (struct cr4_32 *)&(cr4_val);
414 return PROTECTED_PAE;
422 v3_cpu_mode_t v3_get_host_cpu_mode() {
429 #define V3_Yield(addr) \
431 extern struct v3_os_hooks * os_hooks; \
432 if ((os_hooks) && (os_hooks)->yield_cpu) { \
433 (os_hooks)->yield_cpu(); \
439 void v3_yield_cond(struct guest_info * info) {
441 cur_cycle = v3_get_host_time(&info->time_state);
443 if (cur_cycle > (info->yield_start_cycle + info->vm_info->yield_cycle_period)) {
446 PrintDebug("Conditional Yield (cur_cyle=%p, start_cycle=%p, period=%p)\n",
447 (void *)cur_cycle, (void *)info->yield_start_cycle, (void *)info->yield_cycle_period);
450 info->yield_start_cycle = v3_get_host_time(&info->time_state);
456 * unconditional cpu yield
457 * if the yielding thread is a guest context, the guest quantum is reset on resumption
458 * Non guest context threads should call this function with a NULL argument
460 void v3_yield(struct guest_info * info) {
464 info->yield_start_cycle = v3_get_host_time(&info->time_state);
471 void v3_print_cond(const char * fmt, ...) {
472 if (v3_dbg_enable == 1) {
477 vsnprintf(buf, 2048, fmt, ap);
485 #ifdef V3_CONFIG_MULTITHREAD_OS
487 void v3_interrupt_cpu(struct v3_vm_info * vm, int logical_cpu, int vector) {
488 extern struct v3_os_hooks * os_hooks;
490 if ((os_hooks) && (os_hooks)->interrupt_cpu) {
491 (os_hooks)->interrupt_cpu(vm, logical_cpu, vector);
498 int v3_vm_enter(struct guest_info * info) {
499 switch (v3_cpu_types[0]) {
502 case V3_SVM_REV3_CPU:
503 return v3_svm_enter(info);
509 case V3_VMX_EPT_UG_CPU:
510 return v3_vmx_enter(info);
514 PrintError("Attemping to enter a guest on an invalid CPU\n");