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".
21 #include <palacios/vmm_shadow_paging.h>
24 #include <palacios/vmm.h>
25 #include <palacios/vm_guest_mem.h>
26 #include <palacios/vmm_decoder.h>
27 #include <palacios/vmm_ctrl_regs.h>
29 #include <palacios/vmm_hashtable.h>
31 #include <palacios/vmm_direct_paging.h>
36 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
37 #include <palacios/vmm_telemetry.h>
40 #ifdef CONFIG_SYMBIOTIC_SWAP
41 #include <palacios/vmm_sym_swap.h>
44 #ifndef CONFIG_DEBUG_SHADOW_PAGING
46 #define PrintDebug(fmt, args...)
50 static const char default_strategy[] = "VTLB";
53 static struct hashtable * master_shdw_pg_table = NULL;
55 static uint_t shdw_pg_hash_fn(addr_t key) {
56 char * name = (char *)key;
57 return v3_hash_buffer((uint8_t *)name, strlen(name));
60 static int shdw_pg_eq_fn(addr_t key1, addr_t key2) {
61 char * name1 = (char *)key1;
62 char * name2 = (char *)key2;
64 return (strcmp(name1, name2) == 0);
68 int V3_init_shdw_paging() {
69 extern struct v3_shdw_pg_impl * __start__v3_shdw_pg_impls[];
70 extern struct v3_shdw_pg_impl * __stop__v3_shdw_pg_impls[];
71 struct v3_shdw_pg_impl ** tmp_impl = __start__v3_shdw_pg_impls;
74 master_shdw_pg_table = v3_create_htable(0, shdw_pg_hash_fn, shdw_pg_eq_fn);
77 while (tmp_impl != __stop__v3_shdw_pg_impls) {
78 V3_Print("Registering Shadow Paging Impl (%s)\n", (*tmp_impl)->name);
80 if (v3_htable_search(master_shdw_pg_table, (addr_t)((*tmp_impl)->name))) {
81 PrintError("Multiple instances of shadow paging impl (%s)\n", (*tmp_impl)->name);
85 if (v3_htable_insert(master_shdw_pg_table,
86 (addr_t)((*tmp_impl)->name),
87 (addr_t)(*tmp_impl)) == 0) {
88 PrintError("Could not register shadow paging impl (%s)\n", (*tmp_impl)->name);
92 tmp_impl = &(__start__v3_shdw_pg_impls[++i]);
98 int V3_deinit_shdw_paging() {
99 v3_free_htable(master_shdw_pg_table, 0, 0);
110 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
111 static void telemetry_cb(struct v3_vm_info * vm, void * private_data, char * hdr) {
113 for (i = 0; i < vm->num_cores; i++) {
114 struct guest_info * core = &(vm->cores[i]);
116 V3_Print("%s Guest Page faults: %d\n", hdr, core->shdw_pg_state.guest_faults);
123 int v3_init_shdw_pg_state(struct guest_info * core) {
124 struct v3_shdw_pg_state * state = &(core->shdw_pg_state);
125 struct v3_shdw_pg_impl * impl = core->vm_info->shdw_impl.current_impl;
128 state->guest_cr3 = 0;
129 state->guest_cr0 = 0;
130 state->guest_efer.value = 0x0LL;
133 if (impl->local_init(core) == -1) {
134 PrintError("Error in Shadow paging local initialization (%s)\n", impl->name);
139 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
140 v3_add_telemetry_cb(core->vm_info, telemetry_cb, NULL);
147 int v3_deinit_shdw_pg_state(struct guest_info * core) {
148 struct v3_shdw_pg_impl * impl = core->vm_info->shdw_impl.current_impl;
150 if (impl->local_deinit(core) == -1) {
151 PrintError("Error deinitializing shadow paging state\n");
155 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
156 v3_remove_telemetry_cb(core->vm_info, telemetry_cb, NULL);
164 int v3_init_shdw_impl(struct v3_vm_info * vm) {
165 struct v3_shdw_impl_state * impl_state = &(vm->shdw_impl);
166 v3_cfg_tree_t * pg_cfg = v3_cfg_subtree(vm->cfg_data->cfg, "paging");
167 char * pg_mode = v3_cfg_val(pg_cfg, "mode");
168 char * pg_strat = v3_cfg_val(pg_cfg, "strategy");
169 struct v3_shdw_pg_impl * impl = NULL;
171 PrintDebug("Checking if shadow paging requested.\n");
172 if ((pg_mode != NULL) && (strcasecmp(pg_mode, "nested") == 0)) {
173 PrintDebug("Nested paging specified - not initializing shadow paging.\n");
177 if (pg_strat == NULL) {
178 pg_strat = (char *)default_strategy;
181 V3_Print("Initialization of Shadow Paging implementation\n");
183 impl = (struct v3_shdw_pg_impl *)v3_htable_search(master_shdw_pg_table, (addr_t)pg_strat);
186 PrintError("Could not find shadow paging impl (%s)\n", pg_strat);
190 impl_state->current_impl = impl;
192 if (impl->init(vm, pg_cfg) == -1) {
193 PrintError("Could not initialize Shadow paging implemenation (%s)\n", impl->name);
200 int v3_deinit_shdw_impl(struct v3_vm_info * vm) {
201 struct v3_shdw_pg_impl * impl = vm->shdw_impl.current_impl;
203 if (impl->deinit(vm) == -1) {
204 PrintError("Error deinitializing shadow paging implementation\n");
212 // Reads the guest CR3 register
213 // creates new shadow page tables
214 // updates the shadow CR3 register to point to the new pts
215 int v3_activate_shadow_pt(struct guest_info * core) {
216 struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
217 struct v3_shdw_pg_impl * impl = state->current_impl;
218 return impl->activate_shdw_pt(core);
223 // This must flush any caches
224 // and reset the cr3 value to the correct value
225 int v3_invalidate_shadow_pts(struct guest_info * core) {
226 struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
227 struct v3_shdw_pg_impl * impl = state->current_impl;
228 return impl->invalidate_shdw_pt(core);
232 int v3_handle_shadow_pagefault(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
234 if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
235 // If paging is not turned on we need to handle the special cases
236 return v3_handle_passthrough_pagefault(core, fault_addr, error_code);
237 } else if (v3_get_vm_mem_mode(core) == VIRTUAL_MEM) {
238 struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
239 struct v3_shdw_pg_impl * impl = state->current_impl;
241 return impl->handle_pagefault(core, fault_addr, error_code);
243 PrintError("Invalid Memory mode\n");
249 int v3_handle_shadow_invlpg(struct guest_info * core) {
251 struct x86_instr dec_instr;
255 if (v3_get_vm_mem_mode(core) != VIRTUAL_MEM) {
256 // Paging must be turned on...
257 // should handle with some sort of fault I think
258 PrintError("ERROR: INVLPG called in non paged mode\n");
262 if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
263 ret = v3_read_gpa_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
265 ret = v3_read_gva_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
269 PrintError("Could not read instruction into buffer\n");
273 if (v3_decode(core, (addr_t)instr, &dec_instr) == -1) {
274 PrintError("Decoding Error\n");
278 if ((dec_instr.op_type != V3_OP_INVLPG) ||
279 (dec_instr.num_operands != 1) ||
280 (dec_instr.dst_operand.type != MEM_OPERAND)) {
281 PrintError("Decoder Error: Not a valid INVLPG instruction...\n");
285 vaddr = dec_instr.dst_operand.operand;
287 core->rip += dec_instr.instr_length;
290 struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
291 struct v3_shdw_pg_impl * impl = state->current_impl;
293 return impl->handle_invlpg(core, vaddr);
302 int v3_inject_guest_pf(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
303 core->ctrl_regs.cr2 = fault_addr;
305 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
306 core->shdw_pg_state.guest_faults++;
309 return v3_raise_exception_with_error(core, PF_EXCEPTION, *(uint_t *)&error_code);
313 int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access) {
314 /* basically the reasoning is that there can be multiple reasons for a page fault:
315 If there is a permissions failure for a page present in the guest _BUT_
316 the reason for the fault was that the page is not present in the shadow,
317 _THEN_ we have to map the shadow page in and reexecute, this will generate
318 a permissions fault which is _THEN_ valid to send to the guest
319 _UNLESS_ both the guest and shadow have marked the page as not present
323 if (guest_access != PT_ACCESS_OK) {
324 // Guest Access Error
326 if ((shadow_access != PT_ACCESS_NOT_PRESENT) &&
327 (guest_access != PT_ACCESS_NOT_PRESENT)) {
328 // aka (guest permission error)
333 if ((shadow_access == PT_ACCESS_NOT_PRESENT) &&
334 (guest_access == PT_ACCESS_NOT_PRESENT)) {
335 // Page tables completely blank, handle guest first
340 if (guest_access == PT_ACCESS_NOT_PRESENT) {
341 // Page tables completely blank, handle guest first
345 // Otherwise we'll handle the guest fault later...?