Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


fixes to the emulator to handle nested paging
[palacios.git] / palacios / src / palacios / vmm_mem.c
index 49586f1..c244793 100644 (file)
+/* 
+ * This file is part of the Palacios Virtual Machine Monitor developed
+ * by the V3VEE Project with funding from the United States National 
+ * Science Foundation and the Department of Energy.  
+ *
+ * The V3VEE Project is a joint project between Northwestern University
+ * and the University of New Mexico.  You can find out more at 
+ * http://www.v3vee.org
+ *
+ * Copyright (c) 2008, Jack Lange <jarusl@cs.northwestern.edu> 
+ * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org> 
+ * All rights reserved.
+ *
+ * Author: Jack Lange <jarusl@cs.northwestern.edu>
+ *
+ * This is free software.  You are permitted to use,
+ * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
+ */
+
 #include <palacios/vmm_mem.h>
 #include <palacios/vmm.h>
 #include <palacios/vmm_util.h>
+//#include <palacios/vmm_decoder.h>
+#include <palacios/vmm_emulator.h>
 
-extern struct vmm_os_hooks * os_hooks;
 
 
-void init_shadow_region(shadow_region_t * entry,
-                       addr_t               guest_addr_start,
-                       addr_t               guest_addr_end,
-                       guest_region_type_t  guest_region_type,
-                       host_region_type_t   host_region_type)
-{
-  entry->guest_type = guest_region_type;
-  entry->guest_start = guest_addr_start;
-  entry->guest_end = guest_addr_end;
-  entry->host_type = host_region_type;
-  entry->next=entry->prev = NULL;
-}
 
-void init_shadow_region_physical(shadow_region_t * entry,
-                                addr_t               guest_addr_start,
-                                addr_t               guest_addr_end,
-                                guest_region_type_t  guest_region_type,
-                                addr_t               host_addr_start,
-                                host_region_type_t   host_region_type)
-{
-  init_shadow_region(entry, guest_addr_start, guest_addr_end, guest_region_type, host_region_type);
-  entry->host_addr.phys_addr.host_start = host_addr_start;
 
-}
-                   
 
-void init_shadow_map(shadow_map_t * map) {
-  map->num_regions = 0;
+static inline
+struct v3_shadow_region * insert_shadow_region(struct guest_info * info, 
+                                              struct v3_shadow_region * region);
 
-  map->head = NULL;
-}
 
 
-void free_shadow_map(shadow_map_t * map) {
-  shadow_region_t * cursor = map->head;
-  shadow_region_t * tmp = NULL;
+void v3_init_shadow_map(struct guest_info * info) {
+    v3_shdw_map_t * map = &(info->mem_map);
 
-  while(cursor) {
-    tmp = cursor;
-    cursor = cursor->next;
-    VMMFree(tmp);
-  }
+    map->shdw_regions.rb_node = NULL;
+    map->hook_hva = (addr_t)V3_VAddr(V3_AllocPages(1));
 
-  VMMFree(map);
 }
 
-
-
-
-int add_shadow_region(shadow_map_t * map,
-                     shadow_region_t * region) 
-{
-  shadow_region_t * cursor = map->head;
-
-  if ((!cursor) || (cursor->guest_start >= region->guest_end)) {
-    region->prev = NULL;
-    region->next = cursor;
-    map->num_regions++;
-    map->head = region;
-    return 0;
-  }
-
-  while (cursor) {
-    // Check if it overlaps with the current cursor
-    if ((cursor->guest_end > region->guest_start) && (cursor->guest_start < region->guest_start)) {
-      // overlaps not allowed
-      return -1;
-    }
-    
-    if (!(cursor->next)) {
-      // add to the end of the list
-      cursor->next = region;
-      region->prev = cursor;
-      region->next = NULL;
-      map->num_regions++;
-      return 0;
-    } else if (cursor->next->guest_start >= region->guest_end) {
-      // add here
-      region->next = cursor->next;
-      region->prev = cursor;
-      
-      cursor->next->prev = region;
-      cursor->next = region;
-
-      map->num_regions++;
-      
-      return 0;
-    } else if (cursor->next->guest_end < region->guest_start) {
-      cursor = cursor->next;
-    } else {
-      // This cannot happen!
-      // we should panic here
-      return -1;
-    }
-  }
+void v3_delete_shadow_map(struct guest_info * info) {
+    struct rb_node * node = v3_rb_first(&(info->mem_map.shdw_regions));
+    struct v3_shadow_region * reg;
+    struct rb_node * tmp_node = NULL;
   
-  // This cannot happen
-  // We should panic here
-  return -1;
-}
-
+    while (node) {
+       reg = rb_entry(node, struct v3_shadow_region, tree_node);
+       tmp_node = node;
+       node = v3_rb_next(node);
 
-int delete_shadow_region(shadow_map_t * map,
-                        addr_t guest_start,
-                        addr_t guest_end) {
-  return -1;
-}
-
-
-
-shadow_region_t *get_shadow_region_by_index(shadow_map_t *  map,
-                                              uint_t index) {
-  shadow_region_t * reg = map->head;
-  uint_t i = 0;
-
-  while (reg) { 
-    if (i == index) { 
-      return reg;
-    }
-    reg = reg->next;
-    i++;
-  }
-  return NULL;
-}
-
-
-shadow_region_t * get_shadow_region_by_addr(shadow_map_t * map,
-                                              addr_t addr) {
-  shadow_region_t * reg = map->head;
-
-  while (reg) {
-    if ((reg->guest_start <= addr) && (reg->guest_end > addr)) {
-      return reg;
-    } else if (reg->guest_start > addr) {
-      return NULL;
-    } else {
-      reg = reg->next;
+       v3_delete_shadow_region(info, reg);
     }
-  }
-  return NULL;
 }
 
 
 
-host_region_type_t lookup_shadow_map_addr(shadow_map_t * map, addr_t guest_addr, addr_t * host_addr) {
-  shadow_region_t * reg = get_shadow_region_by_addr(map, guest_addr);
 
-  if (!reg) {
-    // No mapping exists
-    return HOST_REGION_INVALID;
-  } else {
-    switch (reg->host_type) {
-    case HOST_REGION_PHYSICAL_MEMORY:
-     *host_addr = (guest_addr - reg->guest_start) + reg->host_addr.phys_addr.host_start;
-     return reg->host_type;
-    case HOST_REGION_MEMORY_MAPPED_DEVICE:
-    case HOST_REGION_UNALLOCATED:
-      // ... 
-    default:
-      *host_addr = 0;
-      return reg->host_type;
+int v3_add_shadow_mem( struct guest_info *  info,
+                      addr_t               guest_addr_start,
+                      addr_t               guest_addr_end,
+                      addr_t               host_addr)
+{
+    struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
+
+    entry->guest_start = guest_addr_start;
+    entry->guest_end = guest_addr_end;
+    entry->host_type = SHDW_REGION_ALLOCATED;
+    entry->host_addr = host_addr;
+    entry->write_hook = NULL;
+    entry->read_hook = NULL;
+    entry->priv_data = NULL;
+
+    if (insert_shadow_region(info, entry)) {
+       V3_Free(entry);
+       return -1;
     }
-  }
-}
 
-
-void print_shadow_map(shadow_map_t * map) {
-  shadow_region_t * cur = map->head;
-  int i = 0;
-
-  PrintDebug("Memory Layout (regions: %d) \n", map->num_regions);
-
-  while (cur) {
-    PrintDebug("%d:  0x%x - 0x%x (%s) -> ", i, cur->guest_start, cur->guest_end - 1,
-              cur->guest_type == GUEST_REGION_PHYSICAL_MEMORY ? "GUEST_REGION_PHYSICAL_MEMORY" :
-              cur->guest_type == GUEST_REGION_NOTHING ? "GUEST_REGION_NOTHING" :
-              cur->guest_type == GUEST_REGION_MEMORY_MAPPED_DEVICE ? "GUEST_REGION_MEMORY_MAPPED_DEVICE" :
-              "UNKNOWN");
-    if (cur->host_type == HOST_REGION_PHYSICAL_MEMORY || 
-       cur->host_type == HOST_REGION_UNALLOCATED ||
-       cur->host_type == HOST_REGION_MEMORY_MAPPED_DEVICE) { 
-      PrintDebug("0x%x", cur->host_addr.phys_addr.host_start);
-    }
-    PrintDebug("(%s)\n",
-              cur->host_type == HOST_REGION_PHYSICAL_MEMORY ? "HOST_REGION_PHYSICAL_MEMORY" :
-              cur->host_type == HOST_REGION_UNALLOCATED ? "HOST_REGION_UNALLOACTED" :
-              cur->host_type == HOST_REGION_NOTHING ? "HOST_REGION_NOTHING" :
-              cur->host_type == HOST_REGION_MEMORY_MAPPED_DEVICE ? "HOST_REGION_MEMORY_MAPPED_DEVICE" :
-              cur->host_type == HOST_REGION_REMOTE ? "HOST_REGION_REMOTE" : 
-              cur->host_type == HOST_REGION_SWAPPED ? "HOST_REGION_SWAPPED" :
-              "UNKNOWN");
-    cur = cur->next;
-    i++;
-  }
+    return 0;
 }
 
 
 
+int v3_hook_write_mem(struct guest_info * info, addr_t guest_addr_start, addr_t guest_addr_end, 
+                     addr_t host_addr,
+                     int (*write)(addr_t guest_addr, void * src, uint_t length, void * priv_data),
+                     void * priv_data) {
 
+    struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
 
 
+    entry->guest_start = guest_addr_start;
+    entry->guest_end = guest_addr_end;
+    entry->host_type = SHDW_REGION_WRITE_HOOK;
+    entry->host_addr = host_addr;
+    entry->write_hook = write;
+    entry->read_hook = NULL;
+    entry->priv_data = priv_data;
 
+    if (insert_shadow_region(info, entry)) {
+       V3_Free(entry);
+       return -1;
+    }
 
+    return 0;  
+}
 
+int v3_hook_full_mem(struct guest_info * info, addr_t guest_addr_start, addr_t guest_addr_end,
+                    int (*read)(addr_t guest_addr, void * dst, uint_t length, void * priv_data),
+                    int (*write)(addr_t guest_addr, void * src, uint_t length, void * priv_data),
+                    void * priv_data) {
+  
+    struct v3_shadow_region * entry = (struct v3_shadow_region *)V3_Malloc(sizeof(struct v3_shadow_region));
+
+    entry->guest_start = guest_addr_start;
+    entry->guest_end = guest_addr_end;
+    entry->host_type = SHDW_REGION_FULL_HOOK;
+    entry->host_addr = (addr_t)NULL;
+    entry->write_hook = write;
+    entry->read_hook = read;
+    entry->priv_data = priv_data;
+  
+    if (insert_shadow_region(info, entry)) {
+       V3_Free(entry);
+       return -1;
+    }
 
-#ifdef VMM_MEM_TEST
-
+    return 0;
+}
 
-#include <stdlib.h>
-#include <stdio.h>
-#include <stdarg.h>
 
 
 
+static inline 
+struct v3_shadow_region * __insert_shadow_region(struct guest_info * info, 
+                                                struct v3_shadow_region * region) {
+    struct rb_node ** p = &(info->mem_map.shdw_regions.rb_node);
+    struct rb_node * parent = NULL;
+    struct v3_shadow_region * tmp_region;
 
+    while (*p) {
+       parent = *p;
+       tmp_region = rb_entry(parent, struct v3_shadow_region, tree_node);
 
-struct vmm_os_hooks * os_hooks;
+       if (region->guest_end <= tmp_region->guest_start) {
+           p = &(*p)->rb_left;
+       } else if (region->guest_start >= tmp_region->guest_end) {
+           p = &(*p)->rb_right;
+       } else {
+           return tmp_region;
+       }
+    }
 
-void * TestMalloc(uint_t size) {
-  return malloc(size);
+    rb_link_node(&(region->tree_node), parent, p);
+  
+    return NULL;
 }
 
-void * TestAllocatePages(int size) {
-  return malloc(4096 * size);
-}
 
+static inline
+struct v3_shadow_region * insert_shadow_region(struct guest_info * info, 
+                                              struct v3_shadow_region * region) {
+    struct v3_shadow_region * ret;
 
-void TestPrint(const char * fmt, ...) {
-  va_list args;
+    if ((ret = __insert_shadow_region(info, region))) {
+       return ret;
+    }
+  
+    v3_rb_insert_color(&(region->tree_node), &(info->mem_map.shdw_regions));
 
-  va_start(args, fmt);
-  vprintf(fmt, args);
-  va_end(args);
+    return NULL;
 }
+                                                
 
-int mem_list_add_test_1(  vmm_mem_list_t * list) {
 
-  uint_t offset = 0;
 
-  PrintDebug("\n\nTesting Memory List\n");
 
-  init_mem_list(list);
 
-  offset = PAGE_SIZE * 6;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + (PAGE_SIZE * 10));
-  add_mem_list_pages(list, offset, 10);
-  print_mem_list(list);
 
 
-  offset = 0;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + PAGE_SIZE * 4);
-  add_mem_list_pages(list, offset, 4);
-  print_mem_list(list);
+int handle_special_page_fault(struct guest_info * info, 
+                             addr_t fault_gva, addr_t fault_gpa, 
+                             pf_error_t access_info) 
+{
+    struct v3_shadow_region * reg = v3_get_shadow_region(info, fault_gpa);
 
-  offset = PAGE_SIZE * 20;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + (PAGE_SIZE * 1));
-  add_mem_list_pages(list, offset, 1);
-  print_mem_list(list);
+    PrintDebug("Handling Special Page Fault\n");
 
-  offset = PAGE_SIZE * 21;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + (PAGE_SIZE * 3));
-  add_mem_list_pages(list, offset, 3);
-  print_mem_list(list);
+    switch (reg->host_type) {
+       case SHDW_REGION_WRITE_HOOK:
+           return v3_handle_mem_wr_hook(info, fault_gva, fault_gpa, reg, access_info);
+       case SHDW_REGION_FULL_HOOK:
+           return v3_handle_mem_full_hook(info, fault_gva, fault_gpa, reg, access_info);
+       default:
+           return -1;
+    }
 
+    return 0;
 
-  offset = PAGE_SIZE * 10;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + (PAGE_SIZE * 30));
-  add_mem_list_pages(list, offset, 30);
-  print_mem_list(list);
+}
 
+int v3_handle_mem_wr_hook(struct guest_info * info, addr_t guest_va, addr_t guest_pa, 
+                         struct v3_shadow_region * reg, pf_error_t access_info) {
 
-  offset = PAGE_SIZE * 5;
-  PrintDebug("Adding 0x%x - 0x%x\n", offset, offset + (PAGE_SIZE * 1));
-  add_mem_list_pages(list, offset, 1);
-  print_mem_list(list);
+    addr_t dst_addr = (addr_t)V3_VAddr((void *)v3_get_shadow_addr(reg, guest_pa));
 
+    if (v3_emulate_write_op(info, guest_va, guest_pa, dst_addr, reg->write_hook, reg->priv_data) == -1) {
+       PrintError("Write hook emulation failed\n");
+       return -1;
+    }
 
-  return 0;
+    return 0;
 }
 
+int v3_handle_mem_full_hook(struct guest_info * info, addr_t guest_va, addr_t guest_pa, 
+                           struct v3_shadow_region * reg, pf_error_t access_info) {
+  
+    addr_t op_addr = info->mem_map.hook_hva;
 
-int mem_layout_add_test_1(vmm_mem_layout_t * layout) {
+    if (access_info.write == 1) {
+       if (v3_emulate_write_op(info, guest_va, guest_pa, op_addr, reg->write_hook, reg->priv_data) == -1) {
+           PrintError("Write Full Hook emulation failed\n");
+           return -1;
+       }
+    } else {
+       if (v3_emulate_read_op(info, guest_va, guest_pa, op_addr, reg->read_hook, reg->write_hook, reg->priv_data) == -1) {
+           PrintError("Read Full Hook emulation failed\n");
+           return -1;
+       }
+    }
 
-  
-  uint_t start = 0;
-  uint_t end = 0;
+    return 0;
+}
 
-  PrintDebug("\n\nTesting Memory Layout\n");
 
-  init_mem_layout(layout);
 
-  start = 0x6000;
-  end = 0x10000;;
-  PrintDebug("Adding 0x%x - 0x%x\n", start, end);
-  add_guest_mem_range(layout, start, end);
-  print_mem_layout(layout);
+struct v3_shadow_region * v3_get_shadow_region(struct guest_info * info, addr_t guest_addr) {
+    struct rb_node * n = info->mem_map.shdw_regions.rb_node;
+    struct v3_shadow_region * reg = NULL;
 
+    while (n) {
+       reg = rb_entry(n, struct v3_shadow_region, tree_node);
 
-  start = 0x1000;
-  end = 0x3000;
-  PrintDebug("Adding 0x%x - 0x%x\n", start, end);
-  add_guest_mem_range(layout, start, end);
-  print_mem_layout(layout);
+       if (guest_addr < reg->guest_start) {
+           n = n->rb_left;
+       } else if (guest_addr >= reg->guest_end) {
+           n = n->rb_right;
+       } else {
+           return reg;
+       }
+    }
 
-  start = 0x2000;
-  end = 0x6000;
-  PrintDebug("Adding 0x%x - 0x%x\n", start, end);
-  add_guest_mem_range(layout, start, end);
-  print_mem_layout(layout);
+    return NULL;
+}
 
-  start = 0x4000;
-  end = 0x5000;
-  PrintDebug("Adding 0x%x - 0x%x\n", start, end);
-  add_guest_mem_range(layout, start, end);
-  print_mem_layout(layout);
 
 
-  start = 0x5000;
-  end = 0x7000;
-  PrintDebug("Adding 0x%x - 0x%x\n", start, end);
-  add_guest_mem_range(layout, start, end);
-  print_mem_layout(layout);
+addr_t v3_get_shadow_addr(struct v3_shadow_region * reg, addr_t guest_addr) {
+    if ( (reg) && 
+        (reg->host_type != SHDW_REGION_FULL_HOOK) &&
+        (reg->host_type != SHDW_REGION_INVALID) ) {
+       return (guest_addr - reg->guest_start) + reg->host_addr;
+    } else {
+       PrintDebug("MEM Region Invalid\n");
+       return 0;
+    }
+}
 
 
 
+void v3_delete_shadow_region(struct guest_info * info, struct v3_shadow_region * reg) {
+    if (reg != NULL) {
+       v3_rb_erase(&(reg->tree_node), &(info->mem_map.shdw_regions));
 
-  return 0;
+       V3_Free(reg);
+    }
 }
 
 
 
-int main(int argc, char ** argv) {
-  struct vmm_os_hooks dummy_hooks;
-  os_hooks = &dummy_hooks;
 
-  vmm_mem_layout_t layout;
-  vmm_mem_list_t list;
+void print_shadow_map(struct guest_info * info) {
+    struct rb_node * node = v3_rb_first(&(info->mem_map.shdw_regions));
+    struct v3_shadow_region * reg;
+    int i = 0;
 
-  os_hooks->malloc = &TestMalloc;
-  os_hooks->free = &free;
-  os_hooks->print_debug = &TestPrint;
-  os_hooks->allocate_pages = &TestAllocatePages;
+    PrintDebug("Memory Layout:\n");
 
+    do {
+       reg = rb_entry(node, struct v3_shadow_region, tree_node);
 
+       PrintDebug("%d:  0x%p - 0x%p -> 0x%p\n", i, 
+                  (void *)(reg->guest_start), 
+                  (void *)(reg->guest_end - 1), 
+                  (void *)(reg->host_addr));
 
-  printf("mem_list_add_test_1: %d\n", mem_list_add_test_1(&list));
-  printf("layout_add_test_1: %d\n", mem_layout_add_test_1(&layout));
-
-  return 0;
+       PrintDebug("\t(%s) (WriteHook = 0x%p) (ReadHook = 0x%p)\n", 
+                  v3_shdw_region_type_to_str(reg->host_type),
+                  (void *)(reg->write_hook), 
+                  (void *)(reg->read_hook));
+    
+       i++;
+    } while ((node = v3_rb_next(node)));
 }
-#endif
 
 
+static const uchar_t  SHDW_REGION_INVALID_STR[] = "SHDW_REGION_INVALID";
+static const uchar_t  SHDW_REGION_WRITE_HOOK_STR[] = "SHDW_REGION_WRITE_HOOK";
+static const uchar_t  SHDW_REGION_FULL_HOOK_STR[] = "SHDW_REGION_FULL_HOOK";
+static const uchar_t  SHDW_REGION_ALLOCATED_STR[] = "SHDW_REGION_ALLOCATED";
 
 
 
+const uchar_t * v3_shdw_region_type_to_str(v3_shdw_region_type_t type) {
+    switch (type) {
+       case SHDW_REGION_WRITE_HOOK:
+           return SHDW_REGION_WRITE_HOOK_STR;
+       case SHDW_REGION_FULL_HOOK:
+           return SHDW_REGION_FULL_HOOK_STR;
+       case SHDW_REGION_ALLOCATED:
+           return SHDW_REGION_ALLOCATED_STR;
+       default:
+           return SHDW_REGION_INVALID_STR;
+    }
+}