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_mem.h>
21 #include <palacios/vmm.h>
22 #include <palacios/vmm_util.h>
23 #include <palacios/vmm_emulator.h>
24 #include <palacios/vm_guest.h>
26 #include <palacios/vmm_shadow_paging.h>
27 #include <palacios/vmm_direct_paging.h>
29 #define MEM_OFFSET_HCALL 0x1000
33 struct v3_shadow_region * insert_shadow_region(struct guest_info * info,
34 struct v3_shadow_region * region);
37 static int mem_offset_hypercall(struct guest_info * info, uint_t hcall_id, void * private_data) {
38 PrintDebug("V3Vee: Memory offset hypercall (offset=%p)\n",
39 (void *)(info->mem_map.base_region.host_addr));
41 info->vm_regs.rbx = info->mem_map.base_region.host_addr;
47 int v3_init_shadow_map(struct guest_info * info) {
48 v3_shdw_map_t * map = &(info->mem_map);
49 addr_t mem_pages = info->mem_size >> 12;
51 map->shdw_regions.rb_node = NULL;
52 map->hook_hva = (addr_t)V3_VAddr(V3_AllocPages(1));
54 // There is an underlying region that contains all of the guest memory
55 // PrintDebug("Mapping %d pages of memory (%u bytes)\n", (int)mem_pages, (uint_t)info->mem_size);
57 map->base_region.guest_start = 0;
58 map->base_region.guest_end = mem_pages * PAGE_SIZE_4KB;
59 map->base_region.host_type = SHDW_REGION_ALLOCATED;
60 map->base_region.host_addr = (addr_t)V3_AllocPages(mem_pages);
63 if ((void *)map->base_region.host_addr == NULL) {
64 PrintError("Could not allocate Guest memory\n");
68 //memset(V3_VAddr((void *)map->base_region.host_addr), 0xffffffff, map->base_region.guest_end);
70 v3_register_hypercall(info, MEM_OFFSET_HCALL, mem_offset_hypercall, NULL);
75 void v3_delete_shadow_map(struct guest_info * info) {
76 struct rb_node * node = v3_rb_first(&(info->mem_map.shdw_regions));
77 struct v3_shadow_region * reg;
78 struct rb_node * tmp_node = NULL;
81 reg = rb_entry(node, struct v3_shadow_region, tree_node);
83 node = v3_rb_next(node);
85 v3_delete_shadow_region(info, reg);
88 V3_FreePage((void *)(info->mem_map.base_region.host_addr));
89 V3_FreePage(V3_PAddr((void *)(info->mem_map.hook_hva)));
95 int v3_add_shadow_mem( struct guest_info * info,
96 addr_t guest_addr_start,
97 addr_t guest_addr_end,
100 struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
102 entry->guest_start = guest_addr_start;
103 entry->guest_end = guest_addr_end;
104 entry->host_type = SHDW_REGION_ALLOCATED;
105 entry->host_addr = host_addr;
106 entry->write_hook = NULL;
107 entry->read_hook = NULL;
108 entry->priv_data = NULL;
110 if (insert_shadow_region(info, entry)) {
120 int v3_hook_write_mem(struct guest_info * info, addr_t guest_addr_start, addr_t guest_addr_end,
122 int (*write)(addr_t guest_addr, void * src, uint_t length, void * priv_data),
125 struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
128 entry->guest_start = guest_addr_start;
129 entry->guest_end = guest_addr_end;
130 entry->host_type = SHDW_REGION_WRITE_HOOK;
131 entry->host_addr = host_addr;
132 entry->write_hook = write;
133 entry->read_hook = NULL;
134 entry->priv_data = priv_data;
136 if (insert_shadow_region(info, entry)) {
144 int v3_hook_full_mem(struct guest_info * info, addr_t guest_addr_start, addr_t guest_addr_end,
145 int (*read)(addr_t guest_addr, void * dst, uint_t length, void * priv_data),
146 int (*write)(addr_t guest_addr, void * src, uint_t length, void * priv_data),
149 struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
151 entry->guest_start = guest_addr_start;
152 entry->guest_end = guest_addr_end;
153 entry->host_type = SHDW_REGION_FULL_HOOK;
154 entry->host_addr = (addr_t)NULL;
155 entry->write_hook = write;
156 entry->read_hook = read;
157 entry->priv_data = priv_data;
159 if (insert_shadow_region(info, entry)) {
168 // This will unhook the memory hook registered at start address
169 // We do not support unhooking subregions
170 int v3_unhook_mem(struct guest_info * info, addr_t guest_addr_start) {
171 struct v3_shadow_region * reg = v3_get_shadow_region(info, guest_addr_start);
173 if ((reg->host_type != SHDW_REGION_FULL_HOOK) ||
174 (reg->host_type != SHDW_REGION_WRITE_HOOK)) {
175 PrintError("Trying to unhook a non hooked memory region (addr=%p)\n", (void *)guest_addr_start);
179 v3_delete_shadow_region(info, reg);
187 struct v3_shadow_region * __insert_shadow_region(struct guest_info * info,
188 struct v3_shadow_region * region) {
189 struct rb_node ** p = &(info->mem_map.shdw_regions.rb_node);
190 struct rb_node * parent = NULL;
191 struct v3_shadow_region * tmp_region;
195 tmp_region = rb_entry(parent, struct v3_shadow_region, tree_node);
197 if (region->guest_end <= tmp_region->guest_start) {
199 } else if (region->guest_start >= tmp_region->guest_end) {
206 rb_link_node(&(region->tree_node), parent, p);
213 struct v3_shadow_region * insert_shadow_region(struct guest_info * info,
214 struct v3_shadow_region * region) {
215 struct v3_shadow_region * ret;
217 if ((ret = __insert_shadow_region(info, region))) {
221 v3_rb_insert_color(&(region->tree_node), &(info->mem_map.shdw_regions));
225 // flush virtual page tables
226 // 3 cases shadow, shadow passthrough, and nested
227 if (info->shdw_pg_mode == SHADOW_PAGING) {
228 v3_mem_mode_t mem_mode = v3_get_vm_mem_mode(info);
230 if (mem_mode == PHYSICAL_MEM) {
233 for (cur_addr = region->guest_start;
234 cur_addr < region->guest_end;
235 cur_addr += PAGE_SIZE_4KB) {
236 v3_invalidate_passthrough_addr(info, cur_addr);
239 v3_invalidate_shadow_pts(info);
242 } else if (info->shdw_pg_mode == NESTED_PAGING) {
245 for (cur_addr = region->guest_start;
246 cur_addr < region->guest_end;
247 cur_addr += PAGE_SIZE_4KB) {
249 v3_invalidate_nested_addr(info, cur_addr);
259 int handle_special_page_fault(struct guest_info * info,
260 addr_t fault_gva, addr_t fault_gpa,
261 pf_error_t access_info)
263 struct v3_shadow_region * reg = v3_get_shadow_region(info, fault_gpa);
265 PrintDebug("Handling Special Page Fault\n");
267 switch (reg->host_type) {
268 case SHDW_REGION_WRITE_HOOK:
269 return v3_handle_mem_wr_hook(info, fault_gva, fault_gpa, reg, access_info);
270 case SHDW_REGION_FULL_HOOK:
271 return v3_handle_mem_full_hook(info, fault_gva, fault_gpa, reg, access_info);
280 int v3_handle_mem_wr_hook(struct guest_info * info, addr_t guest_va, addr_t guest_pa,
281 struct v3_shadow_region * reg, pf_error_t access_info) {
283 addr_t dst_addr = (addr_t)V3_VAddr((void *)v3_get_shadow_addr(reg, guest_pa));
285 if (v3_emulate_write_op(info, guest_va, guest_pa, dst_addr,
286 reg->write_hook, reg->priv_data) == -1) {
287 PrintError("Write hook emulation failed\n");
294 int v3_handle_mem_full_hook(struct guest_info * info, addr_t guest_va, addr_t guest_pa,
295 struct v3_shadow_region * reg, pf_error_t access_info) {
297 addr_t op_addr = info->mem_map.hook_hva;
299 if (access_info.write == 1) {
300 if (v3_emulate_write_op(info, guest_va, guest_pa, op_addr,
301 reg->write_hook, reg->priv_data) == -1) {
302 PrintError("Write Full Hook emulation failed\n");
306 if (v3_emulate_read_op(info, guest_va, guest_pa, op_addr,
307 reg->read_hook, reg->write_hook,
308 reg->priv_data) == -1) {
309 PrintError("Read Full Hook emulation failed\n");
319 struct v3_shadow_region * v3_get_shadow_region(struct guest_info * info, addr_t guest_addr) {
320 struct rb_node * n = info->mem_map.shdw_regions.rb_node;
321 struct v3_shadow_region * reg = NULL;
324 reg = rb_entry(n, struct v3_shadow_region, tree_node);
326 if (guest_addr < reg->guest_start) {
328 } else if (guest_addr >= reg->guest_end) {
336 // There is not registered region, so we check if its a valid address in the base region
338 if (guest_addr > info->mem_map.base_region.guest_end) {
339 PrintError("Guest Address Exceeds Base Memory Size (ga=%p), (limit=%p)\n",
340 (void *)guest_addr, (void *)info->mem_map.base_region.guest_end);
341 v3_print_mem_map(info);
346 return &(info->mem_map.base_region);
350 void v3_delete_shadow_region(struct guest_info * info, struct v3_shadow_region * reg) {
355 // flush virtual page tables
356 // 3 cases shadow, shadow passthrough, and nested
357 if (info->shdw_pg_mode == SHADOW_PAGING) {
358 v3_mem_mode_t mem_mode = v3_get_vm_mem_mode(info);
360 if (mem_mode == PHYSICAL_MEM) {
363 for (cur_addr = reg->guest_start;
364 cur_addr < reg->guest_end;
365 cur_addr += PAGE_SIZE_4KB) {
366 v3_invalidate_passthrough_addr(info, cur_addr);
369 v3_invalidate_shadow_pts(info);
372 } else if (info->shdw_pg_mode == NESTED_PAGING) {
375 for (cur_addr = reg->guest_start;
376 cur_addr < reg->guest_end;
377 cur_addr += PAGE_SIZE_4KB) {
379 v3_invalidate_nested_addr(info, cur_addr);
384 v3_rb_erase(&(reg->tree_node), &(info->mem_map.shdw_regions));
388 // flush virtual page tables
389 // 3 cases shadow, shadow passthrough, and nested
396 addr_t v3_get_shadow_addr(struct v3_shadow_region * reg, addr_t guest_addr) {
398 (reg->host_type != SHDW_REGION_FULL_HOOK)) {
399 return (guest_addr - reg->guest_start) + reg->host_addr;
401 // PrintError("MEM Region Invalid\n");
409 void v3_print_mem_map(struct guest_info * info) {
410 struct rb_node * node = v3_rb_first(&(info->mem_map.shdw_regions));
411 struct v3_shadow_region * reg = &(info->mem_map.base_region);
414 V3_Print("Memory Layout:\n");
417 V3_Print("Base Region: 0x%p - 0x%p -> 0x%p\n",
418 (void *)(reg->guest_start),
419 (void *)(reg->guest_end - 1),
420 (void *)(reg->host_addr));
423 // If the memory map is empty, don't print it
429 reg = rb_entry(node, struct v3_shadow_region, tree_node);
431 V3_Print("%d: 0x%p - 0x%p -> 0x%p\n", i,
432 (void *)(reg->guest_start),
433 (void *)(reg->guest_end - 1),
434 (void *)(reg->host_addr));
436 V3_Print("\t(%s) (WriteHook = 0x%p) (ReadHook = 0x%p)\n",
437 v3_shdw_region_type_to_str(reg->host_type),
438 (void *)(reg->write_hook),
439 (void *)(reg->read_hook));
442 } while ((node = v3_rb_next(node)));
446 static const uchar_t SHDW_REGION_WRITE_HOOK_STR[] = "SHDW_REGION_WRITE_HOOK";
447 static const uchar_t SHDW_REGION_FULL_HOOK_STR[] = "SHDW_REGION_FULL_HOOK";
448 static const uchar_t SHDW_REGION_ALLOCATED_STR[] = "SHDW_REGION_ALLOCATED";
450 const uchar_t * v3_shdw_region_type_to_str(v3_shdw_region_type_t type) {
452 case SHDW_REGION_WRITE_HOOK:
453 return SHDW_REGION_WRITE_HOOK_STR;
454 case SHDW_REGION_FULL_HOOK:
455 return SHDW_REGION_FULL_HOOK_STR;
456 case SHDW_REGION_ALLOCATED:
457 return SHDW_REGION_ALLOCATED_STR;
459 return (uchar_t *)"SHDW_REGION_INVALID";