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".
23 #include <palacios/vm_guest.h>
24 #include <palacios/vmm_ctrl_regs.h>
25 #include <palacios/vmm.h>
26 #include <palacios/vmm_decoder.h>
27 #include <palacios/vmcb.h>
28 #include <palacios/vm_guest_mem.h>
29 #include <palacios/vmm_lowlevel.h>
30 #include <palacios/vmm_sprintf.h>
31 #include <palacios/vmm_muxer.h>
32 #include <palacios/vmm_xed.h>
33 #include <palacios/vmm_direct_paging.h>
37 v3_cpu_mode_t v3_get_vm_cpu_mode(struct guest_info * info) {
39 struct efer_64 * efer;
40 struct cr4_32 * cr4 = (struct cr4_32 *)&(info->ctrl_regs.cr4);
41 struct v3_segment * cs = &(info->segments.cs);
42 vmcb_saved_state_t * guest_state = GET_VMCB_SAVE_STATE_AREA((vmcb_t*)(info->vmm_data));
44 if (info->shdw_pg_mode == SHADOW_PAGING) {
45 cr0 = (struct cr0_32 *)&(info->shdw_pg_state.guest_cr0);
46 efer = (struct efer_64 *)&(info->shdw_pg_state.guest_efer);
47 } else if (info->shdw_pg_mode == NESTED_PAGING) {
48 cr0 = (struct cr0_32 *)&(info->ctrl_regs.cr0);
49 efer = (struct efer_64 *)&(guest_state->efer);
51 PrintError("Invalid Paging Mode...\n");
58 } else if ((cr4->pae == 0) && (efer->lme == 0)) {
60 } else if (efer->lme == 0) {
62 } else if ((efer->lme == 1) && (cs->long_mode == 1)) {
65 // What about LONG_16_COMPAT???
66 return LONG_32_COMPAT;
70 // Get address width in bytes
71 uint_t v3_get_addr_width(struct guest_info * info) {
73 struct cr4_32 * cr4 = (struct cr4_32 *)&(info->ctrl_regs.cr4);
74 struct efer_64 * efer;
75 struct v3_segment * cs = &(info->segments.cs);
76 vmcb_saved_state_t * guest_state = GET_VMCB_SAVE_STATE_AREA((vmcb_t*)(info->vmm_data));
78 if (info->shdw_pg_mode == SHADOW_PAGING) {
79 cr0 = (struct cr0_32 *)&(info->shdw_pg_state.guest_cr0);
80 efer = (struct efer_64 *)&(info->shdw_pg_state.guest_efer);
81 } else if (info->shdw_pg_mode == NESTED_PAGING) {
82 cr0 = (struct cr0_32 *)&(info->ctrl_regs.cr0);
83 efer = (struct efer_64 *)&(guest_state->efer);
85 PrintError("Invalid Paging Mode...\n");
92 } else if ((cr4->pae == 0) && (efer->lme == 0)) {
94 } else if (efer->lme == 0) {
96 } else if ((efer->lme == 1) && (cs->long_mode == 1)) {
99 // What about LONG_16_COMPAT???
105 static const uchar_t REAL_STR[] = "Real";
106 static const uchar_t PROTECTED_STR[] = "Protected";
107 static const uchar_t PROTECTED_PAE_STR[] = "Protected+PAE";
108 static const uchar_t LONG_STR[] = "Long";
109 static const uchar_t LONG_32_COMPAT_STR[] = "32bit Compat";
110 static const uchar_t LONG_16_COMPAT_STR[] = "16bit Compat";
112 const uchar_t * v3_cpu_mode_to_str(v3_cpu_mode_t mode) {
117 return PROTECTED_STR;
119 return PROTECTED_PAE_STR;
123 return LONG_32_COMPAT_STR;
125 return LONG_16_COMPAT_STR;
131 v3_mem_mode_t v3_get_vm_mem_mode(struct guest_info * info) {
134 if (info->shdw_pg_mode == SHADOW_PAGING) {
135 cr0 = (struct cr0_32 *)&(info->shdw_pg_state.guest_cr0);
136 } else if (info->shdw_pg_mode == NESTED_PAGING) {
137 cr0 = (struct cr0_32 *)&(info->ctrl_regs.cr0);
139 PrintError("Invalid Paging Mode...\n");
151 static const uchar_t PHYS_MEM_STR[] = "Physical Memory";
152 static const uchar_t VIRT_MEM_STR[] = "Virtual Memory";
154 const uchar_t * v3_mem_mode_to_str(v3_mem_mode_t mode) {
166 void v3_print_segments(struct v3_segments * segs) {
168 struct v3_segment * seg_ptr;
170 seg_ptr=(struct v3_segment *)segs;
172 char *seg_names[] = {"CS", "DS" , "ES", "FS", "GS", "SS" , "LDTR", "GDTR", "IDTR", "TR", NULL};
173 V3_Print("Segments\n");
175 for (i = 0; seg_names[i] != NULL; i++) {
177 V3_Print("\t%s: Sel=%x, base=%p, limit=%x (long_mode=%d, db=%d)\n", seg_names[i], seg_ptr[i].selector,
178 (void *)(addr_t)seg_ptr[i].base, seg_ptr[i].limit,
179 seg_ptr[i].long_mode, seg_ptr[i].db);
185 // We don't handle those fancy 64 bit system segments...
187 int v3_translate_segment(struct guest_info * info, uint16_t selector, struct v3_segment * seg) {
188 struct v3_segment * gdt = &(info->segments.gdtr);
190 uint16_t seg_offset = (selector & ~0x7);
192 struct gen_segment * gen_seg = NULL;
193 struct seg_selector sel;
195 memset(seg, 0, sizeof(struct v3_segment));
197 sel.value = selector;
200 PrintError("LDT translations not supported\n");
204 if (v3_gva_to_hva(info, gdt->base, &gdt_addr) == -1) {
205 PrintError("Unable to translate GDT address\n");
209 seg_addr = gdt_addr + seg_offset;
210 gen_seg = (struct gen_segment *)seg_addr;
213 seg->selector = selector;
215 seg->limit = gen_seg->limit_hi;
217 seg->limit += gen_seg->limit_lo;
219 seg->base = gen_seg->base_hi;
221 seg->base += gen_seg->base_lo;
223 if (gen_seg->granularity == 1) {
228 seg->type = gen_seg->type;
229 seg->system = gen_seg->system;
230 seg->dpl = gen_seg->dpl;
231 seg->present = gen_seg->present;
232 seg->avail = gen_seg->avail;
233 seg->long_mode = gen_seg->long_mode;
234 seg->db = gen_seg->db;
235 seg->granularity = gen_seg->granularity;
243 void v3_print_ctrl_regs(struct guest_info * info) {
244 struct v3_ctrl_regs * regs = &(info->ctrl_regs);
247 char * reg_names[] = {"CR0", "CR2", "CR3", "CR4", "CR8", "FLAGS", NULL};
248 vmcb_saved_state_t * guest_state = GET_VMCB_SAVE_STATE_AREA(info->vmm_data);
250 reg_ptr = (v3_reg_t *)regs;
252 V3_Print("32 bit Ctrl Regs:\n");
254 for (i = 0; reg_names[i] != NULL; i++) {
255 V3_Print("\t%s=0x%p (at %p)\n", reg_names[i], (void *)(addr_t)reg_ptr[i], &(reg_ptr[i]));
258 V3_Print("\tEFER=0x%p\n", (void*)(addr_t)(guest_state->efer));
263 static int safe_gva_to_hva(struct guest_info * info, addr_t linear_addr, addr_t * host_addr) {
264 /* select the proper translation based on guest mode */
265 if (info->mem_mode == PHYSICAL_MEM) {
266 if (v3_gpa_to_hva(info, linear_addr, host_addr) == -1) return -1;
267 } else if (info->mem_mode == VIRTUAL_MEM) {
268 if (v3_gva_to_hva(info, linear_addr, host_addr) == -1) return -1;
273 static int v3_print_disassembly(struct guest_info * info) {
275 addr_t rip, rip_linear, rip_host;
277 /* we don't know where the instructions preceding RIP start, so we just take
278 * a guess and hope the instruction stream synced up with our disassembly
279 * some time before RIP; if it has not we correct RIP at that point
282 /* start disassembly 64 bytes before current RIP, continue 32 bytes after */
283 rip = (addr_t) info->rip - 64;
284 while ((int) (rip - info->rip) < 32) {
285 V3_Print("disassembly step\n");
287 /* always print RIP, even if the instructions before were bad */
288 if (!passed_rip && rip >= info->rip) {
289 if (rip != info->rip) {
290 V3_Print("***** bad disassembly up to this point *****\n");
296 /* look up host virtual address for this instruction */
297 rip_linear = get_addr_linear(info, rip, &(info->segments.cs));
298 if (safe_gva_to_hva(info, rip_linear, &rip_host) < 0) {
303 /* print disassembled instrcution (updates rip) */
304 if (v3_disasm(info, (void *) rip_host, &rip, rip == info->rip) < 0) {
316 void v3_print_guest_state(struct guest_info * info) {
317 addr_t linear_addr = 0;
319 V3_Print("RIP: %p\n", (void *)(addr_t)(info->rip));
320 linear_addr = get_addr_linear(info, info->rip, &(info->segments.cs));
321 V3_Print("RIP Linear: %p\n", (void *)linear_addr);
323 V3_Print("NumExits: %u\n", (uint32_t)info->num_exits);
325 v3_print_segments(&(info->segments));
326 v3_print_ctrl_regs(info);
328 if (info->shdw_pg_mode == SHADOW_PAGING) {
329 V3_Print("Shadow Paging Guest Registers:\n");
330 V3_Print("\tGuest CR0=%p\n", (void *)(addr_t)(info->shdw_pg_state.guest_cr0));
331 V3_Print("\tGuest CR3=%p\n", (void *)(addr_t)(info->shdw_pg_state.guest_cr3));
332 V3_Print("\tGuest EFER=%p\n", (void *)(addr_t)(info->shdw_pg_state.guest_efer.value));
337 v3_print_mem_map(info->vm_info);
339 v3_print_stack(info);
341 // v3_print_disassembly(info);
344 void v3_print_guest_state_all(struct v3_vm_info * vm) {
347 V3_Print("VM Core states for %s\n", vm->name);
349 for (i = 0; i < 80; i++) {
353 for (i = 0; i < vm->num_cores; i++) {
354 v3_print_guest_state(&vm->cores[i]);
357 for (i = 0; i < 80; i++) {
364 static void print_real_mode_stack(struct guest_info *info)
373 ss = info->segments.ss.selector & 0xffff;
374 sp = info->vm_regs.rsp & 0xffff;
375 addr = (((uint32_t)ss)<<4) + sp;
378 V3_Print("Real Mode Stack starting at 0x%x:0x%x (0x%p):\n",ss,sp,(void*)addr);
380 if (info->mem_mode!=PHYSICAL_MEM) {
381 PrintError("Cannot print real mode stack when virtual memory active\n");
385 for (i=0;i<=24;i++,sp+=2) {
386 // note that it's correct for this to wrap around
387 addr = (((uint32_t)ss)<<4) + sp;
388 if (v3_gpa_to_hva(info,addr,&host_addr)) {
389 PrintError("Could not translate physical stack address 0x%p\n",(void*)addr);
392 V3_Print("\t0x%.4x\n",*((uint16_t*)host_addr));
399 void v3_print_stack(struct guest_info * info) {
400 addr_t linear_addr = 0;
401 addr_t host_addr = 0;
403 v3_cpu_mode_t cpu_mode = v3_get_vm_cpu_mode(info);
406 if (cpu_mode==REAL) {
407 print_real_mode_stack(info);
411 // protected mode, 32 or 64 bit
413 linear_addr = get_addr_linear(info, info->vm_regs.rsp, &(info->segments.ss));
415 V3_Print("Stack at %p:\n", (void *)linear_addr);
417 if (info->mem_mode == PHYSICAL_MEM) {
418 if (v3_gpa_to_hva(info, linear_addr, &host_addr) == -1) {
419 PrintError("Could not translate Stack address\n");
422 } else if (info->mem_mode == VIRTUAL_MEM) {
423 if (v3_gva_to_hva(info, linear_addr, &host_addr) == -1) {
424 PrintError("Could not translate Virtual Stack address\n");
429 V3_Print("Host Address of rsp = 0x%p\n", (void *)host_addr);
431 // We start i at one because the current stack pointer points to an unused stack element
432 for (i = 0; i <= 24; i++) {
433 if (cpu_mode == LONG) {
434 V3_Print("\t%p\n", (void *)*(addr_t *)(host_addr + (i * 8)));
437 V3_Print("\t%.8x\n", *(uint32_t *)(host_addr + (i * 4)));
445 void v3_print_GPRs(struct guest_info * info) {
446 struct v3_gprs * regs = &(info->vm_regs);
449 char * reg_names[] = { "RDI", "RSI", "RBP", "RSP", "RBX", "RDX", "RCX", "RAX", NULL};
451 reg_ptr = (v3_reg_t *)regs;
453 V3_Print("32 bit GPRs:\n");
455 for (i = 0; reg_names[i] != NULL; i++) {
456 V3_Print("\t%s=0x%p (at %p)\n", reg_names[i], (void *)(addr_t)reg_ptr[i], &(reg_ptr[i]));
462 void v3_print_GPRs(struct guest_info * info) {
463 struct v3_gprs * regs = &(info->vm_regs);
466 char * reg_names[] = { "RDI", "RSI", "RBP", "RSP", "RBX", "RDX", "RCX", "RAX", \
467 "R8", "R9", "R10", "R11", "R12", "R13", "R14", "R15", NULL};
469 reg_ptr = (v3_reg_t *)regs;
471 V3_Print("64 bit GPRs:\n");
473 for (i = 0; reg_names[i] != NULL; i++) {
474 V3_Print("\t%s=0x%p (at %p)\n", reg_names[i], (void *)(addr_t)reg_ptr[i], &(reg_ptr[i]));
481 #include <palacios/vmcs.h>
482 #include <palacios/vmcb.h>
483 static int info_hcall(struct guest_info * core, uint_t hcall_id, void * priv_data) {
484 v3_cpu_arch_t cpu_type = v3_get_cpu_type(V3_Get_CPU());
487 V3_Print("************** Guest State ************\n");
488 v3_print_guest_state(core);
492 if ((cpu_type == V3_SVM_CPU) || (cpu_type == V3_SVM_REV3_CPU)) {
494 PrintDebugVMCB((vmcb_t *)(core->vmm_data));
498 if ((cpu_type == V3_VMX_CPU) || (cpu_type == V3_VMX_EPT_CPU)) {
504 PrintError("Invalid CPU Type 0x%x\n", cpu_type);
514 #include <palacios/svm.h>
515 #include <palacios/svm_io.h>
516 #include <palacios/svm_msr.h>
520 #include <palacios/vmx.h>
521 #include <palacios/vmx_io.h>
522 #include <palacios/vmx_msr.h>
526 int v3_init_vm(struct v3_vm_info * vm) {
527 v3_cpu_arch_t cpu_type = v3_get_cpu_type(V3_Get_CPU());
529 if (v3_get_foreground_vm() == NULL) {
530 v3_set_foreground_vm(vm);
533 #ifdef CONFIG_INSPECTOR
534 v3_init_inspector(vm);
537 #ifdef CONFIG_TELEMETRY
538 v3_init_telemetry(vm);
541 v3_init_hypercall_map(vm);
544 v3_init_cpuid_map(vm);
545 v3_init_host_events(vm);
546 v3_init_intr_routers(vm);
547 v3_init_ext_manager(vm);
549 // Initialize the memory map
550 if (v3_init_mem_map(vm) == -1) {
551 PrintError("Could not initialize shadow map\n");
555 v3_init_mem_hooks(vm);
557 if (v3_init_shdw_impl(vm) == -1) {
558 PrintError("VM initialization error in shadow implementaion\n");
566 #ifdef CONFIG_SYMBIOTIC
567 v3_init_symbiotic_vm(vm);
577 case V3_SVM_REV3_CPU:
578 v3_init_svm_io_map(vm);
579 v3_init_svm_msr_map(vm);
585 v3_init_vmx_io_map(vm);
586 v3_init_vmx_msr_map(vm);
590 PrintError("Invalid CPU Type 0x%x\n", cpu_type);
594 v3_register_hypercall(vm, GUEST_INFO_HCALL, info_hcall, NULL);
596 V3_Print("GUEST_INFO_HCALL=%x\n", GUEST_INFO_HCALL);
602 int v3_free_vm_internal(struct v3_vm_info * vm) {
603 v3_cpu_arch_t cpu_type = v3_get_cpu_type(V3_Get_CPU());
605 v3_remove_hypercall(vm, GUEST_INFO_HCALL);
609 #ifdef CONFIG_SYMBIOTIC
610 v3_deinit_symbiotic_vm(vm);
617 case V3_SVM_REV3_CPU:
618 v3_deinit_svm_io_map(vm);
619 v3_deinit_svm_msr_map(vm);
625 v3_deinit_vmx_io_map(vm);
626 v3_deinit_vmx_msr_map(vm);
630 PrintError("Invalid CPU Type 0x%x\n", cpu_type);
634 v3_deinit_dev_mgr(vm);
636 v3_deinit_time_vm(vm);
638 v3_deinit_mem_hooks(vm);
639 v3_delete_mem_map(vm);
640 v3_deinit_shdw_impl(vm);
642 v3_deinit_intr_routers(vm);
643 v3_deinit_host_events(vm);
645 v3_deinit_cpuid_map(vm);
646 v3_deinit_msr_map(vm);
647 v3_deinit_io_map(vm);
648 v3_deinit_hypercall_map(vm);
650 #ifdef CONFIG_TELEMETRY
651 v3_deinit_telemetry(vm);
660 int v3_init_core(struct guest_info * core) {
661 v3_cpu_arch_t cpu_type = v3_get_cpu_type(V3_Get_CPU());
662 struct v3_vm_info * vm = core->vm_info;
664 #ifdef CONFIG_INSPECTOR
665 v3_init_inspector_core(core);
669 * Initialize the subsystem data strutures
671 #ifdef CONFIG_TELEMETRY
672 v3_init_core_telemetry(core);
675 if (core->shdw_pg_mode == SHADOW_PAGING) {
676 v3_init_shdw_pg_state(core);
679 v3_init_time_core(core);
680 v3_init_intr_controllers(core);
681 v3_init_exception_state(core);
683 v3_init_decoder(core);
686 #ifdef CONFIG_SYMBIOTIC
687 v3_init_symbiotic_core(core);
696 case V3_SVM_REV3_CPU:
697 if (v3_init_svm_vmcb(core, vm->vm_class) == -1) {
698 PrintError("Error in SVM initialization\n");
706 if (v3_init_vmx_vmcs(core, vm->vm_class) == -1) {
707 PrintError("Error in VMX initialization\n");
713 PrintError("Invalid CPU Type 0x%x\n", cpu_type);
722 int v3_free_core(struct guest_info * core) {
723 v3_cpu_arch_t cpu_type = v3_get_cpu_type(V3_Get_CPU());
726 #ifdef CONFIG_SYMBIOTIC
727 v3_deinit_symbiotic_core(core);
730 v3_deinit_decoder(core);
732 v3_deinit_intr_controllers(core);
733 v3_deinit_time_core(core);
735 if (core->shdw_pg_mode == SHADOW_PAGING) {
736 v3_deinit_shdw_pg_state(core);
739 v3_free_passthrough_pts(core);
741 #ifdef CONFIG_TELEMETRY
742 v3_deinit_core_telemetry(core);
748 case V3_SVM_REV3_CPU:
749 if (v3_deinit_svm_vmcb(core) == -1) {
750 PrintError("Error in SVM initialization\n");
758 if (v3_deinit_vmx_vmcs(core) == -1) {
759 PrintError("Error in VMX initialization\n");
765 PrintError("Invalid CPU Type 0x%x\n", cpu_type);