#include <palacios/vmm_direct_paging.h>
-#ifdef CONFIG_SYMBIOTIC_SWAP
+
+
+
+#ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
+#include <palacios/vmm_telemetry.h>
+#endif
+
+#ifdef V3_CONFIG_SYMBIOTIC_SWAP
#include <palacios/vmm_sym_swap.h>
#endif
-#ifndef CONFIG_DEBUG_SHADOW_PAGING
+#ifndef V3_CONFIG_DEBUG_SHADOW_PAGING
#undef PrintDebug
#define PrintDebug(fmt, args...)
#endif
-/***
- *** There be dragons
- ***/
+static const char default_strategy[] = "VTLB";
-struct shadow_page_data {
- v3_reg_t cr3;
- addr_t page_pa;
-
- struct list_head page_list_node;
+static struct hashtable * master_shdw_pg_table = NULL;
+
+
+struct event_callback {
+ int (*callback)(struct guest_info *core, struct v3_shdw_pg_event *event, void *priv_data);
+ void *priv_data;
+
+ struct list_head node;
};
+static uint_t shdw_pg_hash_fn(addr_t key) {
+ char * name = (char *)key;
+ return v3_hash_buffer((uint8_t *)name, strlen(name));
+}
+
+static int shdw_pg_eq_fn(addr_t key1, addr_t key2) {
+ char * name1 = (char *)key1;
+ char * name2 = (char *)key2;
+
+ return (strcmp(name1, name2) == 0);
+}
+
+static int have_callbacks(struct guest_info *core)
+{
+ return !list_empty(&(core->vm_info->shdw_impl.event_callback_list));
+}
+
+static void dispatch_event(struct guest_info *core, struct v3_shdw_pg_event *event)
+{
+ struct event_callback *cb,*temp;
+
+ list_for_each_entry_safe(cb,
+ temp,
+ &(core->vm_info->shdw_impl.event_callback_list),
+ node) {
+ cb->callback(core,event,cb->priv_data);
+ }
+}
+
+
+int V3_init_shdw_paging() {
+ extern struct v3_shdw_pg_impl * __start__v3_shdw_pg_impls[];
+ extern struct v3_shdw_pg_impl * __stop__v3_shdw_pg_impls[];
+ struct v3_shdw_pg_impl ** tmp_impl = __start__v3_shdw_pg_impls;
+ int i = 0;
+
+ master_shdw_pg_table = v3_create_htable(0, shdw_pg_hash_fn, shdw_pg_eq_fn);
+
+
+ while (tmp_impl != __stop__v3_shdw_pg_impls) {
+ V3_Print(VM_NONE, VCORE_NONE, "Registering Shadow Paging Impl (%s)\n", (*tmp_impl)->name);
+
+ if (v3_htable_search(master_shdw_pg_table, (addr_t)((*tmp_impl)->name))) {
+ PrintError(VM_NONE, VCORE_NONE, "Multiple instances of shadow paging impl (%s)\n", (*tmp_impl)->name);
+ return -1;
+ }
+
+ if (v3_htable_insert(master_shdw_pg_table,
+ (addr_t)((*tmp_impl)->name),
+ (addr_t)(*tmp_impl)) == 0) {
+ PrintError(VM_NONE, VCORE_NONE, "Could not register shadow paging impl (%s)\n", (*tmp_impl)->name);
+ return -1;
+ }
+
+ tmp_impl = &(__start__v3_shdw_pg_impls[++i]);
+ }
+
+ return 0;
+}
+
+int V3_deinit_shdw_paging() {
+ v3_free_htable(master_shdw_pg_table, 0, 0);
+ return 0;
+}
+
+
+/***
+ *** There be dragons
+ ***/
-static struct shadow_page_data * create_new_shadow_pt(struct guest_info * info);
-static int inject_guest_pf(struct guest_info * info, addr_t fault_addr, pf_error_t error_code);
-static int is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access);
+#ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
+static void telemetry_cb(struct v3_vm_info * vm, void * private_data, char * hdr) {
+ int i = 0;
+ for (i = 0; i < vm->num_cores; i++) {
+ struct guest_info * core = &(vm->cores[i]);
-#include "vmm_shadow_paging_32.h"
-#include "vmm_shadow_paging_32pae.h"
-#include "vmm_shadow_paging_64.h"
+ V3_Print(vm, core, "%s Guest Page faults: %d\n", hdr, core->shdw_pg_state.guest_faults);
+ }
+}
+#endif
-int v3_init_shadow_page_state(struct guest_info * info) {
- struct shadow_page_state * state = &(info->shdw_pg_state);
+int v3_init_shdw_pg_state(struct guest_info * core) {
+ struct v3_shdw_pg_state * state = &(core->shdw_pg_state);
+ struct v3_shdw_pg_impl * impl = core->vm_info->shdw_impl.current_impl;
+
state->guest_cr3 = 0;
state->guest_cr0 = 0;
state->guest_efer.value = 0x0LL;
- INIT_LIST_HEAD(&(state->page_list));
+ if (impl->local_init(core) == -1) {
+ PrintError(core->vm_info, core, "Error in Shadow paging local initialization (%s)\n", impl->name);
+ return -1;
+ }
+
+
+#ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
+ v3_add_telemetry_cb(core->vm_info, telemetry_cb, NULL);
+#endif
+
+ return 0;
+}
+
+
+int v3_deinit_shdw_pg_state(struct guest_info * core) {
+ struct v3_shdw_pg_impl * impl = NULL;
+
+ if (!core || !core->vm_info) {
+ return -1;
+ }
+
+ impl = core->vm_info->shdw_impl.current_impl;
+
+ if (impl && impl->local_deinit(core) == -1) {
+ PrintError(core->vm_info, core, "Error deinitializing shadow paging state\n");
+ return -1;
+ }
+
+
+ return 0;
+}
+
+
+
+int v3_init_shdw_impl(struct v3_vm_info * vm) {
+ struct v3_shdw_impl_state * impl_state = &(vm->shdw_impl);
+ v3_cfg_tree_t * pg_cfg = v3_cfg_subtree(vm->cfg_data->cfg, "paging");
+ char * pg_mode = v3_cfg_val(pg_cfg, "mode");
+ char * pg_strat = v3_cfg_val(pg_cfg, "strategy");
+ struct v3_shdw_pg_impl * impl = NULL;
+
+ PrintDebug(vm, VCORE_NONE, "Checking if shadow paging requested.\n");
+ if (pg_mode == NULL) {
+ V3_Print(vm, VCORE_NONE, "No paging mode specified, assuming shadow with defaults\n");
+ pg_mode = "shadow";
+ } else {
+ if (strcasecmp(pg_mode, "nested") == 0) {
+ // this check is repeated here (compare to vmm_config's determine paging mode) since
+ // shadow paging initialization *precedes* per-core pre-config.
+ extern v3_cpu_arch_t v3_mach_type;
+ if ((v3_mach_type == V3_SVM_REV3_CPU) ||
+ (v3_mach_type == V3_VMX_EPT_CPU) ||
+ (v3_mach_type == V3_VMX_EPT_UG_CPU)) {
+ PrintDebug(vm, VCORE_NONE, "Nested paging specified on machine that supports it - not initializing shadow paging\n");
+ return 0;
+ } else {
+ V3_Print(vm, VCORE_NONE, "Nested paging specified but machine does not support it - falling back to shadow paging with defaults\n");
+ pg_mode = "shadow";
+ }
+ } else if (strcasecmp(pg_mode, "shadow") != 0) {
+ V3_Print(vm, VCORE_NONE, "Unknown paging mode '%s' specified - falling back to shadow paging with defaults\n",pg_mode);
+ pg_mode = "shadow";
+ }
+ }
+
+ if (pg_strat == NULL) {
+ pg_strat = (char *)default_strategy;
+ }
+
+ V3_Print(vm, VCORE_NONE,"Initialization of Shadow Paging implementation\n");
+
+ impl = (struct v3_shdw_pg_impl *)v3_htable_search(master_shdw_pg_table, (addr_t)pg_strat);
+
+ if (impl == NULL) {
+ PrintError(vm, VCORE_NONE, "Could not find shadow paging impl (%s)\n", pg_strat);
+ return -1;
+ }
+
+ INIT_LIST_HEAD(&(impl_state->event_callback_list));
+
+ impl_state->current_impl = impl;
+
+ if (impl->init(vm, pg_cfg) == -1) {
+ PrintError(vm, VCORE_NONE, "Could not initialize Shadow paging implemenation (%s)\n", impl->name);
+ return -1;
+ }
+
+
+
return 0;
}
+int v3_deinit_shdw_impl(struct v3_vm_info * vm) {
+ struct v3_shdw_pg_impl * impl = vm->shdw_impl.current_impl;
+ struct event_callback *cb,*temp;
+
+ if (impl == NULL) {
+ // Shadow paging not implemented
+ return 0;
+ }
+
+ if (impl->deinit(vm) == -1) {
+ PrintError(vm, VCORE_NONE,"Error deinitializing shadow paging implementation\n");
+ return -1;
+ }
+
+ list_for_each_entry_safe(cb,
+ temp,
+ &(vm->shdw_impl.event_callback_list),
+ node) {
+ list_del(&(cb->node));
+ V3_Free(cb);
+ }
+
+ return 0;
+}
// Reads the guest CR3 register
// creates new shadow page tables
// updates the shadow CR3 register to point to the new pts
-int v3_activate_shadow_pt(struct guest_info * info) {
- switch (v3_get_vm_cpu_mode(info)) {
-
- case PROTECTED:
- return activate_shadow_pt_32(info);
- case PROTECTED_PAE:
- return activate_shadow_pt_32pae(info);
- case LONG:
- case LONG_32_COMPAT:
- case LONG_16_COMPAT:
- return activate_shadow_pt_64(info);
- default:
- PrintError("Invalid CPU mode: %s\n", v3_cpu_mode_to_str(v3_get_vm_cpu_mode(info)));
- return -1;
- }
+int v3_activate_shadow_pt(struct guest_info * core) {
+ struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
+ struct v3_shdw_pg_impl * impl = state->current_impl;
+
+ if (!have_callbacks(core)) {
+ return impl->activate_shdw_pt(core);
+ } else {
+ int rc;
+ struct v3_shdw_pg_event event_pre={SHADOW_ACTIVATE,SHADOW_PREIMPL,0,{0,0,0,0,0,0}};
+ struct v3_shdw_pg_event event_post={SHADOW_ACTIVATE,SHADOW_POSTIMPL,0,{0,0,0,0,0,0}};
+
+ dispatch_event(core,&event_pre);
- return 0;
+ rc =impl->activate_shdw_pt(core);
+
+ dispatch_event(core,&event_post);
+
+ return rc;
+ }
}
// This must flush any caches
// and reset the cr3 value to the correct value
-int v3_invalidate_shadow_pts(struct guest_info * info) {
- return v3_activate_shadow_pt(info);
+int v3_invalidate_shadow_pts(struct guest_info * core) {
+ struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
+ struct v3_shdw_pg_impl * impl = state->current_impl;
+
+ if (!have_callbacks(core)) {
+ return impl->invalidate_shdw_pt(core);
+ } else {
+ int rc;
+ struct v3_shdw_pg_event event_pre={SHADOW_INVALIDATE,SHADOW_PREIMPL,0,{0,0,0,0,0,0}};
+ struct v3_shdw_pg_event event_post={SHADOW_INVALIDATE,SHADOW_POSTIMPL,0,{0,0,0,0,0,0}};
+
+ dispatch_event(core,&event_pre);
+
+ rc = impl->invalidate_shdw_pt(core);
+
+ dispatch_event(core,&event_post);
+
+ return rc;
+ }
}
-int v3_handle_shadow_pagefault(struct guest_info * info, addr_t fault_addr, pf_error_t error_code) {
-
- if (v3_get_vm_mem_mode(info) == PHYSICAL_MEM) {
+int v3_handle_shadow_pagefault(struct guest_info * core, addr_t fault_addr, pf_error_t error_code)
+{
+ int rc;
+
+
+ if (have_callbacks(core)) {
+ struct v3_shdw_pg_event event={SHADOW_PAGEFAULT,SHADOW_PREIMPL,fault_addr,error_code};
+ dispatch_event(core,&event);
+ }
+
+ if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
// If paging is not turned on we need to handle the special cases
- return v3_handle_passthrough_pagefault(info, fault_addr, error_code);
- } else if (v3_get_vm_mem_mode(info) == VIRTUAL_MEM) {
-
- switch (v3_get_vm_cpu_mode(info)) {
- case PROTECTED:
- return handle_shadow_pagefault_32(info, fault_addr, error_code);
- break;
- case PROTECTED_PAE:
- return handle_shadow_pagefault_32pae(info, fault_addr, error_code);
- case LONG:
- case LONG_32_COMPAT:
- case LONG_16_COMPAT:
- return handle_shadow_pagefault_64(info, fault_addr, error_code);
- break;
- default:
- PrintError("Unhandled CPU Mode: %s\n", v3_cpu_mode_to_str(v3_get_vm_cpu_mode(info)));
- return -1;
- }
+ rc = v3_handle_passthrough_pagefault(core, fault_addr, error_code,NULL,NULL);
+ } else if (v3_get_vm_mem_mode(core) == VIRTUAL_MEM) {
+ struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
+ struct v3_shdw_pg_impl * impl = state->current_impl;
+
+ rc = impl->handle_pagefault(core, fault_addr, error_code);
} else {
- PrintError("Invalid Memory mode\n");
- return -1;
+ PrintError(core->vm_info, core, "Invalid Memory mode\n");
+ rc = -1;
+ }
+
+ if (have_callbacks(core)) {
+ struct v3_shdw_pg_event event={SHADOW_PAGEFAULT,SHADOW_POSTIMPL,fault_addr,error_code};
+ dispatch_event(core,&event);
}
+
+ return rc;
}
-int v3_handle_shadow_invlpg(struct guest_info * info) {
+int v3_handle_shadow_invlpg(struct guest_info * core) {
uchar_t instr[15];
struct x86_instr dec_instr;
int ret = 0;
addr_t vaddr = 0;
- if (v3_get_vm_mem_mode(info) != VIRTUAL_MEM) {
+ if (v3_get_vm_mem_mode(core) != VIRTUAL_MEM) {
// Paging must be turned on...
// should handle with some sort of fault I think
- PrintError("ERROR: INVLPG called in non paged mode\n");
+ PrintError(core->vm_info, core, "ERROR: INVLPG called in non paged mode\n");
return -1;
}
- if (v3_get_vm_mem_mode(info) == PHYSICAL_MEM) {
- ret = read_guest_pa_memory(info, get_addr_linear(info, info->rip, &(info->segments.cs)), 15, instr);
+ if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
+ ret = v3_read_gpa_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
} else {
- ret = read_guest_va_memory(info, get_addr_linear(info, info->rip, &(info->segments.cs)), 15, instr);
+ ret = v3_read_gva_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
}
if (ret == -1) {
- PrintError("Could not read instruction into buffer\n");
+ PrintError(core->vm_info, core, "Could not read instruction into buffer\n");
return -1;
}
- if (v3_decode(info, (addr_t)instr, &dec_instr) == -1) {
- PrintError("Decoding Error\n");
+ if (v3_decode(core, (addr_t)instr, &dec_instr) == -1) {
+ PrintError(core->vm_info, core, "Decoding Error\n");
return -1;
}
if ((dec_instr.op_type != V3_OP_INVLPG) ||
(dec_instr.num_operands != 1) ||
(dec_instr.dst_operand.type != MEM_OPERAND)) {
- PrintError("Decoder Error: Not a valid INVLPG instruction...\n");
+ PrintError(core->vm_info, core, "Decoder Error: Not a valid INVLPG instruction...\n");
return -1;
}
vaddr = dec_instr.dst_operand.operand;
- info->rip += dec_instr.instr_length;
-
- switch (v3_get_vm_cpu_mode(info)) {
- case PROTECTED:
- return handle_shadow_invlpg_32(info, vaddr);
- case PROTECTED_PAE:
- return handle_shadow_invlpg_32pae(info, vaddr);
- case LONG:
- case LONG_32_COMPAT:
- case LONG_16_COMPAT:
- return handle_shadow_invlpg_64(info, vaddr);
- default:
- PrintError("Invalid CPU mode: %s\n", v3_cpu_mode_to_str(v3_get_vm_cpu_mode(info)));
- return -1;
- }
-}
-
+ core->rip += dec_instr.instr_length;
+ {
+ struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
+ struct v3_shdw_pg_impl * impl = state->current_impl;
+ int rc;
+ if (have_callbacks(core)) {
+ struct v3_shdw_pg_event event={SHADOW_INVLPG,SHADOW_PREIMPL,vaddr,{0,0,0,0,0,0}};
+ dispatch_event(core,&event);
+ }
-static struct shadow_page_data * create_new_shadow_pt(struct guest_info * info) {
- struct shadow_page_state * state = &(info->shdw_pg_state);
- v3_reg_t cur_cr3 = info->ctrl_regs.cr3;
- struct shadow_page_data * page_tail = NULL;
- addr_t shdw_page = 0;
-
- if (!list_empty(&(state->page_list))) {
- page_tail = list_tail_entry(&(state->page_list), struct shadow_page_data, page_list_node);
-
- if (page_tail->cr3 != cur_cr3) {
- PrintDebug("Reusing old shadow Page: %p (cur_CR3=%p)(page_cr3=%p) \n",
- (void *)(addr_t)page_tail->page_pa,
- (void *)(addr_t)cur_cr3,
- (void *)(addr_t)(page_tail->cr3));
-
- list_move(&(page_tail->page_list_node), &(state->page_list));
-
- memset(V3_VAddr((void *)(page_tail->page_pa)), 0, PAGE_SIZE_4KB);
-
+ rc=impl->handle_invlpg(core, vaddr);
- return page_tail;
+ if (have_callbacks(core)) {
+ struct v3_shdw_pg_event event={SHADOW_INVLPG,SHADOW_POSTIMPL,vaddr,{0,0,0,0,0,0}};
+ dispatch_event(core,&event);
}
- }
-
- // else
- page_tail = (struct shadow_page_data *)V3_Malloc(sizeof(struct shadow_page_data));
- page_tail->page_pa = (addr_t)V3_AllocPages(1);
+ return rc;
+ }
+}
- PrintDebug("Allocating new shadow Page: %p (cur_cr3=%p)\n",
- (void *)(addr_t)page_tail->page_pa,
- (void *)(addr_t)cur_cr3);
- page_tail->cr3 = cur_cr3;
- list_add(&(page_tail->page_list_node), &(state->page_list));
- shdw_page = (addr_t)V3_VAddr((void *)(page_tail->page_pa));
- memset((void *)shdw_page, 0, PAGE_SIZE_4KB);
- return page_tail;
-}
-static int inject_guest_pf(struct guest_info * info, addr_t fault_addr, pf_error_t error_code) {
+int v3_inject_guest_pf(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
+ core->ctrl_regs.cr2 = fault_addr;
-#ifdef CONFIG_PROFILE_VMM
- if (info->enable_profiler) {
- info->profiler.guest_pf_cnt++;
- }
+#ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
+ core->shdw_pg_state.guest_faults++;
#endif
- info->ctrl_regs.cr2 = fault_addr;
-
- return v3_raise_exception_with_error(info, PF_EXCEPTION, *(uint_t *)&error_code);
+ return v3_raise_exception_with_error(core, PF_EXCEPTION, *(uint_t *)&error_code);
}
-static int is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access) {
+int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access) {
/* basically the reasoning is that there can be multiple reasons for a page fault:
If there is a permissions failure for a page present in the guest _BUT_
the reason for the fault was that the page is not present in the shadow,
}
+int v3_register_shadow_paging_event_callback(struct v3_vm_info *vm,
+ int (*callback)(struct guest_info *core,
+ struct v3_shdw_pg_event *event,
+ void *priv_data),
+ void *priv_data)
+{
+ struct event_callback *ec = V3_Malloc(sizeof(struct event_callback));
+
+ if (!ec) {
+ PrintError(vm, VCORE_NONE, "Unable to allocate for a shadow paging event callback\n");
+ return -1;
+ }
+
+ ec->callback = callback;
+ ec->priv_data = priv_data;
+
+ list_add(&(ec->node),&(vm->shdw_impl.event_callback_list));
+
+ return 0;
+
+}
+
+int v3_unregister_shadow_paging_event_callback(struct v3_vm_info *vm,
+ int (*callback)(struct guest_info *core,
+ struct v3_shdw_pg_event *event,
+ void *priv_data),
+ void *priv_data)
+{
+ struct event_callback *cb,*temp;
+
+ list_for_each_entry_safe(cb,
+ temp,
+ &(vm->shdw_impl.event_callback_list),
+ node) {
+ if ((callback == cb->callback) && (priv_data == cb->priv_data)) {
+ list_del(&(cb->node));
+ V3_Free(cb);
+ return 0;
+ }
+ }
+
+ PrintError(vm, VCORE_NONE, "No callback found!\n");
+
+ return -1;
+}
+
+
