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_config.h>
21 #include <palacios/vmm.h>
22 #include <palacios/vmm_debug.h>
23 #include <palacios/vmm_msr.h>
24 #include <palacios/vmm_decoder.h>
25 #include <palacios/vmm_telemetry.h>
26 #include <palacios/vmm_mem.h>
27 #include <palacios/vmm_hypercall.h>
28 #include <palacios/vmm_dev_mgr.h>
29 #include <palacios/vmm_cpuid.h>
30 #include <palacios/vmm_xml.h>
31 #include <palacios/vmm_io.h>
32 #include <palacios/vmm_msr.h>
33 #include <palacios/vmm_sprintf.h>
39 #include <palacios/vmm_host_events.h>
41 #include "vmm_config_class.h"
43 // This is used to access the configuration file index table
50 struct file_idx_table {
52 struct file_hdr hdrs[0];
58 static int setup_memory_map(struct v3_vm_info * vm, v3_cfg_tree_t * cfg);
59 static int setup_extensions(struct v3_vm_info * vm, v3_cfg_tree_t * cfg);
60 static int setup_devices(struct v3_vm_info * vm, v3_cfg_tree_t * cfg);
64 char * v3_cfg_val(v3_cfg_tree_t * tree, char * tag) {
65 char * attrib = (char *)v3_xml_attr(tree, tag);
66 v3_cfg_tree_t * child_entry = v3_xml_child(tree, tag);
69 if ((child_entry != NULL) && (attrib != NULL)) {
70 PrintError("Duplicate Configuration parameters present for %s\n", tag);
75 val = v3_xml_txt(child_entry);
86 v3_cfg_tree_t * v3_cfg_subtree(v3_cfg_tree_t * tree, char * tag) {
87 return v3_xml_child(tree, tag);
90 v3_cfg_tree_t * v3_cfg_next_branch(v3_cfg_tree_t * tree) {
91 return v3_xml_next(tree);
96 struct v3_cfg_file * v3_cfg_get_file(struct v3_vm_info * vm, char * tag) {
97 struct v3_cfg_file * file = NULL;
99 file = (struct v3_cfg_file *)v3_htable_search(vm->cfg_data->file_table, (addr_t)tag);
105 static uint_t file_hash_fn(addr_t key) {
106 char * name = (char *)key;
107 return v3_hash_buffer((uchar_t *)name, strlen(name));
110 static int file_eq_fn(addr_t key1, addr_t key2) {
111 char * name1 = (char *)key1;
112 char * name2 = (char *)key2;
114 return (strcmp(name1, name2) == 0);
117 static struct v3_config * parse_config(void * cfg_blob) {
118 struct v3_config * cfg = NULL;
121 struct file_idx_table * files = NULL;
122 v3_cfg_tree_t * file_tree = NULL;
124 V3_Print("cfg data at %p\n", cfg_blob);
126 if (memcmp(cfg_blob, "v3vee\0\0\0", 8) != 0) {
127 PrintError("Invalid Configuration Header\n");
133 cfg = (struct v3_config *)V3_Malloc(sizeof(struct v3_config));
136 PrintError("Unable to allocate while parsing\n");
140 memset(cfg, 0, sizeof(struct v3_config));
142 cfg->blob = cfg_blob;
143 INIT_LIST_HEAD(&(cfg->file_list));
144 cfg->file_table = v3_create_htable(0, file_hash_fn, file_eq_fn);
146 if (!(cfg->file_table)) {
147 PrintError("Unable to allocate hash table while parsing\n");
152 xml_len = *(uint32_t *)(cfg_blob + offset);
155 cfg->cfg = (v3_cfg_tree_t *)v3_xml_parse((uint8_t *)(cfg_blob + offset));
160 files = (struct file_idx_table *)(cfg_blob + offset);
162 V3_Print("Number of files in cfg: %d\n", (uint32_t)(files->num_files));
164 file_tree = v3_cfg_subtree(v3_cfg_subtree(cfg->cfg, "files"), "file");
167 char * id = v3_cfg_val(file_tree, "id");
168 char * index = v3_cfg_val(file_tree, "index");
169 int idx = atoi(index);
170 struct file_hdr * hdr = &(files->hdrs[idx]);
171 struct v3_cfg_file * file = NULL;
173 file = (struct v3_cfg_file *)V3_Malloc(sizeof(struct v3_cfg_file));
176 PrintError("Could not allocate file structure\n");
177 v3_free_htable(cfg->file_table,0,0);
182 V3_Print("File index=%d id=%s\n", idx, id);
184 strncpy(file->tag, id, V3_MAX_TAG_LEN);
185 file->size = hdr->size;
186 file->data = cfg_blob + hdr->offset;
188 V3_Print("Storing file data offset = %d, size=%d\n", (uint32_t)hdr->offset, hdr->size);
189 V3_Print("file data at %p\n", file->data);
190 list_add( &(file->file_node), &(cfg->file_list));
192 V3_Print("Keying file to name\n");
193 v3_htable_insert(cfg->file_table, (addr_t)(file->tag), (addr_t)(file));
195 V3_Print("Iterating to next file\n");
197 file_tree = v3_cfg_next_branch(file_tree);
200 V3_Print("Configuration parsed successfully\n");
206 static inline uint32_t get_alignment(char * align_str) {
207 // default is 4KB alignment
208 uint32_t alignment = PAGE_SIZE_4KB;
210 if (align_str != NULL) {
211 if (strcasecmp(align_str, "2MB") == 0) {
212 alignment = PAGE_SIZE_2MB;
213 } else if (strcasecmp(align_str, "4MB") == 0) {
214 alignment = PAGE_SIZE_4MB;
218 #ifndef V3_CONFIG_ALIGNED_PG_ALLOC
219 if (alignment != PAGE_SIZE_4KB) {
220 PrintError("Aligned page allocations are not supported in this host (requested alignment=%d)\n", alignment);
221 PrintError("Ignoring alignment request\n");
229 static int pre_config_vm(struct v3_vm_info * vm, v3_cfg_tree_t * vm_cfg) {
230 char * memory_str = v3_cfg_val(vm_cfg, "memory");
231 char * schedule_hz_str = v3_cfg_val(vm_cfg, "schedule_hz");
232 char * vm_class = v3_cfg_val(vm_cfg, "class");
233 char * align_str = v3_cfg_val(v3_cfg_subtree(vm_cfg, "memory"), "alignment");
234 uint32_t sched_hz = 100; // set the schedule frequency to 100 HZ
238 PrintError("Memory is a required configuration parameter\n");
242 PrintDebug("Memory=%s\n", memory_str);
244 PrintDebug("Alignment=%s\n", align_str);
246 PrintDebug("Alignment defaulted to 4KB.\n");
249 // Amount of ram the Guest will have, always in MB
250 vm->mem_size = (addr_t)atoi(memory_str) * 1024 * 1024;
251 vm->mem_align = get_alignment(align_str);
254 PrintDebug("Alignment for %lu bytes of memory computed as 0x%x\n", vm->mem_size, vm->mem_align);
256 if (strcasecmp(vm_class, "PC") == 0) {
257 vm->vm_class = V3_PC_VM;
259 PrintError("Invalid VM class\n");
263 #ifdef V3_CONFIG_TELEMETRY
265 char * telemetry = v3_cfg_val(vm_cfg, "telemetry");
267 // This should go first, because other subsystems will depend on the guest_info flag
268 if ((telemetry) && (strcasecmp(telemetry, "enable") == 0)) {
269 vm->enable_telemetry = 1;
271 vm->enable_telemetry = 0;
276 if (v3_init_vm(vm) == -1) {
277 PrintError("Failed to initialize VM\n");
283 if (schedule_hz_str) {
284 sched_hz = atoi(schedule_hz_str);
287 PrintDebug("CPU_KHZ = %d, schedule_freq=%p\n", V3_CPU_KHZ(),
288 (void *)(addr_t)sched_hz);
290 vm->yield_cycle_period = (V3_CPU_KHZ() * 1000) / sched_hz;
296 static int determine_paging_mode(struct guest_info * info, v3_cfg_tree_t * core_cfg) {
297 extern v3_cpu_arch_t v3_mach_type;
299 v3_cfg_tree_t * vm_tree = info->vm_info->cfg_data->cfg;
300 v3_cfg_tree_t * pg_tree = v3_cfg_subtree(vm_tree, "paging");
301 char * pg_mode = v3_cfg_val(pg_tree, "mode");
303 PrintDebug("Paging mode specified as %s\n", pg_mode);
306 if ((strcasecmp(pg_mode, "nested") == 0)) {
307 // we assume symmetric cores, so if core 0 has nested paging they all do
308 if ((v3_mach_type == V3_SVM_REV3_CPU) ||
309 (v3_mach_type == V3_VMX_EPT_CPU) ||
310 (v3_mach_type == V3_VMX_EPT_UG_CPU)) {
312 V3_Print("Setting paging mode to NESTED\n");
313 info->shdw_pg_mode = NESTED_PAGING;
315 PrintError("Nested paging not supported on this hardware. Defaulting to shadow paging\n");
316 info->shdw_pg_mode = SHADOW_PAGING;
318 } else if ((strcasecmp(pg_mode, "shadow") == 0)) {
319 V3_Print("Setting paging mode to SHADOW\n");
320 info->shdw_pg_mode = SHADOW_PAGING;
322 PrintError("Invalid paging mode (%s) specified in configuration. Defaulting to shadow paging\n", pg_mode);
323 info->shdw_pg_mode = SHADOW_PAGING;
326 V3_Print("No paging type specified in configuration. Defaulting to shadow paging\n");
327 info->shdw_pg_mode = SHADOW_PAGING;
331 if (v3_cfg_val(pg_tree, "large_pages") != NULL) {
332 if (strcasecmp(v3_cfg_val(pg_tree, "large_pages"), "true") == 0) {
333 info->use_large_pages = 1;
334 PrintDebug("Use of large pages in memory virtualization enabled.\n");
340 static int pre_config_core(struct guest_info * info, v3_cfg_tree_t * core_cfg) {
341 if (determine_paging_mode(info, core_cfg) != 0) {
345 if (v3_init_core(info) == -1) {
346 PrintError("Error Initializing Core\n");
350 if (info->vm_info->vm_class == V3_PC_VM) {
351 if (pre_config_pc_core(info, core_cfg) == -1) {
352 PrintError("PC Post configuration failure\n");
356 PrintError("Invalid VM Class\n");
365 static int post_config_vm(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
369 // Configure the memory map for the guest
370 if (setup_memory_map(vm, cfg) == -1) {
371 PrintError("Setting up guest memory map failed...\n");
376 if (vm->vm_class == V3_PC_VM) {
377 if (post_config_pc(vm, cfg) == -1) {
378 PrintError("PC Post configuration failure\n");
382 PrintError("Invalid VM Class\n");
388 * Initialize configured devices
390 if (setup_devices(vm, cfg) == -1) {
391 PrintError("Failed to setup devices\n");
396 // v3_print_io_map(info);
397 v3_print_msr_map(vm);
403 * Initialize configured extensions
405 if (setup_extensions(vm, cfg) == -1) {
406 PrintError("Failed to setup extensions\n");
411 vm->run_state = VM_STOPPED;
418 static int post_config_core(struct guest_info * info, v3_cfg_tree_t * cfg) {
421 if (v3_init_core_extensions(info) == -1) {
422 PrintError("Error intializing extension core states\n");
426 if (info->vm_info->vm_class == V3_PC_VM) {
427 if (post_config_pc_core(info, cfg) == -1) {
428 PrintError("PC Post configuration failure\n");
432 PrintError("Invalid VM Class\n");
442 static struct v3_vm_info * allocate_guest(int num_cores) {
443 int guest_state_size = sizeof(struct v3_vm_info) + (sizeof(struct guest_info) * num_cores);
444 struct v3_vm_info * vm = V3_Malloc(guest_state_size);
447 PrintError("Unable to allocate space for guest data structures\n");
453 memset(vm, 0, guest_state_size);
455 vm->num_cores = num_cores;
457 for (i = 0; i < num_cores; i++) {
458 vm->cores[i].core_run_state = CORE_INVALID;
461 vm->run_state = VM_INVALID;
468 struct v3_vm_info * v3_config_guest(void * cfg_blob, void * priv_data) {
469 extern v3_cpu_arch_t v3_mach_type;
470 struct v3_config * cfg_data = NULL;
471 struct v3_vm_info * vm = NULL;
474 v3_cfg_tree_t * cores_cfg = NULL;
475 v3_cfg_tree_t * per_core_cfg = NULL;
477 if (v3_mach_type == V3_INVALID_CPU) {
478 PrintError("Configuring guest on invalid CPU\n");
482 cfg_data = parse_config(cfg_blob);
485 PrintError("Could not parse configuration\n");
489 cores_cfg = v3_cfg_subtree(cfg_data->cfg, "cores");
492 PrintError("Could not find core configuration (new config format required)\n");
496 num_cores = atoi(v3_cfg_val(cores_cfg, "count"));
497 if (num_cores == 0) {
498 PrintError("No cores specified in configuration\n");
502 V3_Print("Configuring %d cores\n", num_cores);
504 vm = allocate_guest(num_cores);
507 PrintError("Could not allocate %d core guest\n", vm->num_cores);
511 vm->host_priv_data = priv_data;
513 vm->cfg_data = cfg_data;
515 V3_Print("Preconfiguration\n");
517 if (pre_config_vm(vm, vm->cfg_data->cfg) == -1) {
518 PrintError("Error in preconfiguration\n");
522 V3_Print("Per core configuration\n");
523 per_core_cfg = v3_cfg_subtree(cores_cfg, "core");
525 // per core configuration
526 for (i = 0; i < vm->num_cores; i++) {
527 struct guest_info * info = &(vm->cores[i]);
531 info->core_cfg_data = per_core_cfg;
533 if (pre_config_core(info, per_core_cfg) == -1) {
534 PrintError("Error in core %d preconfiguration\n", i);
539 per_core_cfg = v3_cfg_next_branch(per_core_cfg);
543 V3_Print("Post Configuration\n");
545 if (post_config_vm(vm, vm->cfg_data->cfg) == -1) {
546 PrintError("Error in postconfiguration\n");
551 per_core_cfg = v3_cfg_subtree(cores_cfg, "core");
553 // per core configuration
554 for (i = 0; i < vm->num_cores; i++) {
555 struct guest_info * info = &(vm->cores[i]);
557 post_config_core(info, per_core_cfg);
559 per_core_cfg = v3_cfg_next_branch(per_core_cfg);
562 V3_Print("Configuration successfull\n");
569 int v3_free_config(struct v3_vm_info * vm) {
571 v3_free_htable(vm->cfg_data->file_table, 1, 0);
573 v3_xml_free(vm->cfg_data->cfg);
575 V3_Free(vm->cfg_data);
582 static int setup_memory_map(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
583 v3_cfg_tree_t * mem_region = v3_cfg_subtree(v3_cfg_subtree(cfg, "memmap"), "region");
586 addr_t start_addr = atox(v3_cfg_val(mem_region, "start"));
587 addr_t end_addr = atox(v3_cfg_val(mem_region, "end"));
588 addr_t host_addr = atox(v3_cfg_val(mem_region, "host_addr"));
591 if (v3_add_shadow_mem(vm, V3_MEM_CORE_ANY, start_addr, end_addr, host_addr) == -1) {
592 PrintError("Could not map memory region: %p-%p => %p\n",
593 (void *)start_addr, (void *)end_addr, (void *)host_addr);
597 mem_region = v3_cfg_next_branch(mem_region);
604 static int setup_extensions(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
605 v3_cfg_tree_t * extension = v3_cfg_subtree(v3_cfg_subtree(cfg, "extensions"), "extension");
608 char * ext_name = v3_cfg_val(extension, "name");
611 PrintError("Extension has no name\n");
615 V3_Print("Configuring extension %s\n", ext_name);
617 if (v3_add_extension(vm, ext_name, extension) == -1) {
618 PrintError("Error adding extension %s\n", ext_name);
622 extension = v3_cfg_next_branch(extension);
629 static int setup_devices(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
630 v3_cfg_tree_t * device = v3_cfg_subtree(v3_cfg_subtree(cfg, "devices"), "device");
634 char * dev_class = v3_cfg_val(device, "class");
636 V3_Print("configuring device %s\n", dev_class);
638 if (v3_create_device(vm, dev_class, device) == -1) {
639 PrintError("Error creating device %s\n", dev_class);
643 device = v3_cfg_next_branch(device);
646 v3_print_dev_mgr(vm);