palacios/src/palacios/vmm_shadow_paging.c

   1 /*
   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.
   5  *
   6  * The V3VEE Project is a joint project between Northwestern University
   7  * and the University of New Mexico.  You can find out more at
   8  * http://www.v3vee.org
   9  *
  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.
  13  *
  14  * Author: Jack Lange <jarusl@cs.northwestern.edu>
  15  *
  16  * This is free software.  You are permitted to use,
  17  * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
  18  */
  19
  20
  21 #include <palacios/vmm_shadow_paging.h>
  22
  23
  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>
  28
  29 #include <palacios/vmm_hashtable.h>
  30
  31 #include <palacios/vmm_direct_paging.h>
  32
  33
  34
  35
  36 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
  37 #include <palacios/vmm_telemetry.h>
  38 #endif
  39
  40 #ifdef CONFIG_SYMBIOTIC_SWAP
  41 #include <palacios/vmm_sym_swap.h>
  42 #endif
  43
  44 #ifndef CONFIG_DEBUG_SHADOW_PAGING
  45 #undef PrintDebug
  46 #define PrintDebug(fmt, args...)
  47 #endif
  48
  49
  50
  51 static struct hashtable * master_shdw_pg_table = NULL;
  52
  53 static uint_t shdw_pg_hash_fn(addr_t key) {
  54     char * name = (char *)key;
  55     return v3_hash_buffer((uint8_t *)name, strlen(name));
  56 }
  57
  58 static int shdw_pg_eq_fn(addr_t key1, addr_t key2) {
  59     char * name1 = (char *)key1;
  60     char * name2 = (char *)key2;
  61
  62     return (strcmp(name1, name2) == 0);
  63 }
  64
  65
  66 int V3_init_shdw_paging() {
  67     extern struct v3_shdw_pg_impl * __start__v3_shdw_pg_impls[];
  68     extern struct v3_shdw_pg_impl * __stop__v3_shdw_pg_impls[];
  69     struct v3_shdw_pg_impl ** tmp_impl = __start__v3_shdw_pg_impls;
  70     int i = 0;
  71
  72     master_shdw_pg_table = v3_create_htable(0, shdw_pg_hash_fn, shdw_pg_eq_fn);
  73
  74
  75     while (tmp_impl != __stop__v3_shdw_pg_impls) {
  76         V3_Print("Registering Shadow Paging Impl (%s)\n", (*tmp_impl)->name);
  77
  78         if (v3_htable_search(master_shdw_pg_table, (addr_t)((*tmp_impl)->name))) {
  79             PrintError("Multiple instances of shadow paging impl (%s)\n", (*tmp_impl)->name);
  80             return -1;
  81         }
  82
  83         if (v3_htable_insert(master_shdw_pg_table,
  84                              (addr_t)((*tmp_impl)->name),
  85                              (addr_t)(*tmp_impl)) == 0) {
  86             PrintError("Could not register shadow paging impl (%s)\n", (*tmp_impl)->name);
  87             return -1;
  88         }
  89
  90         tmp_impl = &(__start__v3_shdw_pg_impls[++i]);
  91     }
  92
  93     return 0;
  94 }
  95
  96
  97
  98 /***
  99  ***  There be dragons
 100  ***/
 101
 102
 103 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
 104 static void telemetry_cb(struct v3_vm_info * vm, void * private_data, char * hdr) {
 105     int i = 0;
 106     for (i = 0; i < vm->num_cores; i++) {
 107         struct guest_info * core = &(vm->cores[i]);
 108
 109         V3_Print("%s Guest Page faults: %d\n", hdr, core->shdw_pg_state.guest_faults);
 110     }
 111 }
 112 #endif
 113
 114
 115
 116 int v3_init_shdw_pg_state(struct guest_info * core) {
 117     struct v3_shdw_pg_state * state = &(core->shdw_pg_state);
 118     struct v3_shdw_pg_impl * impl = core->vm_info->shdw_impl.current_impl;
 119
 120
 121     state->guest_cr3 = 0;
 122     state->guest_cr0 = 0;
 123     state->guest_efer.value = 0x0LL;
 124
 125
 126     if (impl->local_init(core) == -1) {
 127         PrintError("Error in Shadow paging local initialization (%s)\n", impl->name);
 128         return -1;
 129     }
 130
 131
 132 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
 133     v3_add_telemetry_cb(core->vm_info, telemetry_cb, NULL);
 134 #endif
 135
 136     return 0;
 137 }
 138
 139
 140
 141 int v3_init_shdw_impl(struct v3_vm_info * vm) {
 142     struct v3_shdw_impl_state * impl_state = &(vm->shdw_impl);
 143     v3_cfg_tree_t * pg_cfg = v3_cfg_subtree(vm->cfg_data->cfg, "paging");
 144     char * type_name = v3_cfg_val(pg_cfg, NULL);
 145     char * impl_name = v3_cfg_val(pg_cfg, "mode");
 146     struct v3_shdw_pg_impl * impl = NULL;
 147
 148     if (type_name && (strcasecmp(type_name, "shadow") != 0)) {
 149         PrintDebug("Shadow paging not specified for VM.\n");
 150         return 0;
 151     }
 152
 153     V3_Print("Initialization of Shadow Paging implementation\n");
 154
 155     impl = (struct v3_shdw_pg_impl *)v3_htable_search(master_shdw_pg_table, (addr_t)impl_name);
 156
 157     if (impl == NULL) {
 158         PrintError("Could not find shadow paging impl (%s)\n", impl_name);
 159         return -1;
 160     }
 161
 162     impl_state->current_impl = impl;
 163
 164     if (impl->init(vm, pg_cfg) == -1) {
 165         PrintError("Could not initialize Shadow paging implemenation (%s)\n", impl->name);
 166         return -1;
 167     }
 168
 169
 170
 171
 172     return 0;
 173 }
 174
 175
 176 // Reads the guest CR3 register
 177 // creates new shadow page tables
 178 // updates the shadow CR3 register to point to the new pts
 179 int v3_activate_shadow_pt(struct guest_info * core) {
 180     struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 181     struct v3_shdw_pg_impl * impl = state->current_impl;
 182     return impl->activate_shdw_pt(core);
 183 }
 184
 185
 186
 187 // This must flush any caches
 188 // and reset the cr3 value to the correct value
 189 int v3_invalidate_shadow_pts(struct guest_info * core) {
 190     struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 191     struct v3_shdw_pg_impl * impl = state->current_impl;
 192     return impl->invalidate_shdw_pt(core);
 193 }
 194
 195
 196 int v3_handle_shadow_pagefault(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
 197
 198     if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
 199         // If paging is not turned on we need to handle the special cases
 200         return v3_handle_passthrough_pagefault(core, fault_addr, error_code);
 201     } else if (v3_get_vm_mem_mode(core) == VIRTUAL_MEM) {
 202         struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 203         struct v3_shdw_pg_impl * impl = state->current_impl;
 204
 205         return impl->handle_pagefault(core, fault_addr, error_code);
 206     } else {
 207         PrintError("Invalid Memory mode\n");
 208         return -1;
 209     }
 210 }
 211
 212
 213 int v3_handle_shadow_invlpg(struct guest_info * core) {
 214     uchar_t instr[15];
 215     struct x86_instr dec_instr;
 216     int ret = 0;
 217     addr_t vaddr = 0;
 218
 219     if (v3_get_vm_mem_mode(core) != VIRTUAL_MEM) {
 220         // Paging must be turned on...
 221         // should handle with some sort of fault I think
 222         PrintError("ERROR: INVLPG called in non paged mode\n");
 223         return -1;
 224     }
 225
 226     if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
 227         ret = v3_read_gpa_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
 228     } else {
 229         ret = v3_read_gva_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
 230     }
 231
 232     if (ret == -1) {
 233         PrintError("Could not read instruction into buffer\n");
 234         return -1;
 235     }
 236
 237     if (v3_decode(core, (addr_t)instr, &dec_instr) == -1) {
 238         PrintError("Decoding Error\n");
 239         return -1;
 240     }
 241
 242     if ((dec_instr.op_type != V3_OP_INVLPG) ||
 243         (dec_instr.num_operands != 1) ||
 244         (dec_instr.dst_operand.type != MEM_OPERAND)) {
 245         PrintError("Decoder Error: Not a valid INVLPG instruction...\n");
 246         return -1;
 247     }
 248
 249     vaddr = dec_instr.dst_operand.operand;
 250
 251     core->rip += dec_instr.instr_length;
 252
 253     {
 254         struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 255         struct v3_shdw_pg_impl * impl = state->current_impl;
 256
 257         return impl->handle_invlpg(core, vaddr);
 258     }
 259 }
 260
 261
 262
 263
 264
 265
 266 int v3_inject_guest_pf(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
 267     core->ctrl_regs.cr2 = fault_addr;
 268
 269 #ifdef CONFIG_SHADOW_PAGING_TELEMETRY
 270     core->shdw_pg_state.guest_faults++;
 271 #endif
 272
 273     return v3_raise_exception_with_error(core, PF_EXCEPTION, *(uint_t *)&error_code);
 274 }
 275
 276
 277 int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access) {
 278     /* basically the reasoning is that there can be multiple reasons for a page fault:
 279        If there is a permissions failure for a page present in the guest _BUT_
 280        the reason for the fault was that the page is not present in the shadow,
 281        _THEN_ we have to map the shadow page in and reexecute, this will generate
 282        a permissions fault which is _THEN_ valid to send to the guest
 283        _UNLESS_ both the guest and shadow have marked the page as not present
 284
 285        whew...
 286     */
 287     if (guest_access != PT_ACCESS_OK) {
 288         // Guest Access Error
 289
 290         if ((shadow_access != PT_ACCESS_NOT_PRESENT) &&
 291             (guest_access != PT_ACCESS_NOT_PRESENT)) {
 292             // aka (guest permission error)
 293             return 1;
 294         }
 295
 296         /*
 297           if ((shadow_access == PT_ACCESS_NOT_PRESENT) &&
 298           (guest_access == PT_ACCESS_NOT_PRESENT)) {
 299           // Page tables completely blank, handle guest first
 300           return 1;
 301           }
 302         */
 303
 304         if (guest_access == PT_ACCESS_NOT_PRESENT) {
 305             // Page tables completely blank, handle guest first
 306             return 1;
 307         }
 308
 309         // Otherwise we'll handle the guest fault later...?
 310     }
 311
 312     return 0;
 313 }
 314
 315