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 V3_CONFIG_SHADOW_PAGING_TELEMETRY
  37 #include <palacios/vmm_telemetry.h>
  38 #endif
  39
  40 #ifdef V3_CONFIG_SYMBIOTIC_SWAP
  41 #include <palacios/vmm_sym_swap.h>
  42 #endif
  43
  44 #ifndef V3_CONFIG_DEBUG_SHADOW_PAGING
  45 #undef PrintDebug
  46 #define PrintDebug(fmt, args...)
  47 #endif
  48
  49
  50 static const char default_strategy[] = "VTLB";
  51
  52
  53 static struct hashtable * master_shdw_pg_table = NULL;
  54
  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));
  58 }
  59
  60 static int shdw_pg_eq_fn(addr_t key1, addr_t key2) {
  61     char * name1 = (char *)key1;
  62     char * name2 = (char *)key2;
  63
  64     return (strcmp(name1, name2) == 0);
  65 }
  66
  67
  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;
  72     int i = 0;
  73
  74     master_shdw_pg_table = v3_create_htable(0, shdw_pg_hash_fn, shdw_pg_eq_fn);
  75
  76
  77     while (tmp_impl != __stop__v3_shdw_pg_impls) {
  78         V3_Print("Registering Shadow Paging Impl (%s)\n", (*tmp_impl)->name);
  79
  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);
  82             return -1;
  83         }
  84
  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);
  89             return -1;
  90         }
  91
  92         tmp_impl = &(__start__v3_shdw_pg_impls[++i]);
  93     }
  94
  95     return 0;
  96 }
  97
  98 int V3_deinit_shdw_paging() {
  99     v3_free_htable(master_shdw_pg_table, 0, 0);
 100     return 0;
 101 }
 102
 103
 104
 105 /***
 106  ***  There be dragons
 107  ***/
 108
 109
 110 #ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
 111 static void telemetry_cb(struct v3_vm_info * vm, void * private_data, char * hdr) {
 112     int i = 0;
 113     for (i = 0; i < vm->num_cores; i++) {
 114         struct guest_info * core = &(vm->cores[i]);
 115
 116         V3_Print("%s Guest Page faults: %d\n", hdr, core->shdw_pg_state.guest_faults);
 117     }
 118 }
 119 #endif
 120
 121
 122
 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;
 126
 127
 128     state->guest_cr3 = 0;
 129     state->guest_cr0 = 0;
 130     state->guest_efer.value = 0x0LL;
 131
 132
 133     if (impl->local_init(core) == -1) {
 134         PrintError("Error in Shadow paging local initialization (%s)\n", impl->name);
 135         return -1;
 136     }
 137
 138
 139 #ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
 140     v3_add_telemetry_cb(core->vm_info, telemetry_cb, NULL);
 141 #endif
 142
 143     return 0;
 144 }
 145
 146
 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;
 149
 150     if (impl->local_deinit(core) == -1) {
 151         PrintError("Error deinitializing shadow paging state\n");
 152         return -1;
 153     }
 154
 155
 156     return 0;
 157 }
 158
 159
 160
 161 int v3_init_shdw_impl(struct v3_vm_info * vm) {
 162     struct v3_shdw_impl_state * impl_state = &(vm->shdw_impl);
 163     v3_cfg_tree_t * pg_cfg = v3_cfg_subtree(vm->cfg_data->cfg, "paging");
 164     char * pg_mode = v3_cfg_val(pg_cfg, "mode");
 165     char * pg_strat = v3_cfg_val(pg_cfg, "strategy");
 166     struct v3_shdw_pg_impl * impl = NULL;
 167
 168     PrintDebug("Checking if shadow paging requested.\n");
 169     if ((pg_mode != NULL) && (strcasecmp(pg_mode, "nested") == 0)) {
 170         PrintDebug("Nested paging specified - not initializing shadow paging.\n");
 171         return 0;
 172     }
 173
 174     if (pg_strat == NULL) {
 175         pg_strat = (char *)default_strategy;
 176     }
 177
 178     V3_Print("Initialization of Shadow Paging implementation\n");
 179
 180     impl = (struct v3_shdw_pg_impl *)v3_htable_search(master_shdw_pg_table, (addr_t)pg_strat);
 181
 182     if (impl == NULL) {
 183         PrintError("Could not find shadow paging impl (%s)\n", pg_strat);
 184         return -1;
 185     }
 186
 187     impl_state->current_impl = impl;
 188
 189     if (impl->init(vm, pg_cfg) == -1) {
 190         PrintError("Could not initialize Shadow paging implemenation (%s)\n", impl->name);
 191         return -1;
 192     }
 193
 194     return 0;
 195 }
 196
 197 int v3_deinit_shdw_impl(struct v3_vm_info * vm) {
 198     struct v3_shdw_pg_impl * impl = vm->shdw_impl.current_impl;
 199
 200     if (impl == NULL) {
 201         // Shadow paging not implemented
 202         return 0;
 203     }
 204
 205     if (impl->deinit(vm) == -1) {
 206         PrintError("Error deinitializing shadow paging implementation\n");
 207         return -1;
 208     }
 209
 210     return 0;
 211 }
 212
 213
 214 // Reads the guest CR3 register
 215 // creates new shadow page tables
 216 // updates the shadow CR3 register to point to the new pts
 217 int v3_activate_shadow_pt(struct guest_info * core) {
 218     struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 219     struct v3_shdw_pg_impl * impl = state->current_impl;
 220     return impl->activate_shdw_pt(core);
 221 }
 222
 223
 224
 225 // This must flush any caches
 226 // and reset the cr3 value to the correct value
 227 int v3_invalidate_shadow_pts(struct guest_info * core) {
 228     struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 229     struct v3_shdw_pg_impl * impl = state->current_impl;
 230     return impl->invalidate_shdw_pt(core);
 231 }
 232
 233
 234 int v3_handle_shadow_pagefault(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
 235
 236     if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
 237         // If paging is not turned on we need to handle the special cases
 238         return v3_handle_passthrough_pagefault(core, fault_addr, error_code);
 239     } else if (v3_get_vm_mem_mode(core) == VIRTUAL_MEM) {
 240         struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 241         struct v3_shdw_pg_impl * impl = state->current_impl;
 242
 243         return impl->handle_pagefault(core, fault_addr, error_code);
 244     } else {
 245         PrintError("Invalid Memory mode\n");
 246         return -1;
 247     }
 248 }
 249
 250
 251 int v3_handle_shadow_invlpg(struct guest_info * core) {
 252     uchar_t instr[15];
 253     struct x86_instr dec_instr;
 254     int ret = 0;
 255     addr_t vaddr = 0;
 256
 257     if (v3_get_vm_mem_mode(core) != VIRTUAL_MEM) {
 258         // Paging must be turned on...
 259         // should handle with some sort of fault I think
 260         PrintError("ERROR: INVLPG called in non paged mode\n");
 261         return -1;
 262     }
 263
 264     if (v3_get_vm_mem_mode(core) == PHYSICAL_MEM) {
 265         ret = v3_read_gpa_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
 266     } else {
 267         ret = v3_read_gva_memory(core, get_addr_linear(core, core->rip, &(core->segments.cs)), 15, instr);
 268     }
 269
 270     if (ret == -1) {
 271         PrintError("Could not read instruction into buffer\n");
 272         return -1;
 273     }
 274
 275     if (v3_decode(core, (addr_t)instr, &dec_instr) == -1) {
 276         PrintError("Decoding Error\n");
 277         return -1;
 278     }
 279
 280     if ((dec_instr.op_type != V3_OP_INVLPG) ||
 281         (dec_instr.num_operands != 1) ||
 282         (dec_instr.dst_operand.type != MEM_OPERAND)) {
 283         PrintError("Decoder Error: Not a valid INVLPG instruction...\n");
 284         return -1;
 285     }
 286
 287     vaddr = dec_instr.dst_operand.operand;
 288
 289     core->rip += dec_instr.instr_length;
 290
 291     {
 292         struct v3_shdw_impl_state * state = &(core->vm_info->shdw_impl);
 293         struct v3_shdw_pg_impl * impl = state->current_impl;
 294
 295         return impl->handle_invlpg(core, vaddr);
 296     }
 297 }
 298
 299
 300
 301
 302
 303
 304 int v3_inject_guest_pf(struct guest_info * core, addr_t fault_addr, pf_error_t error_code) {
 305     core->ctrl_regs.cr2 = fault_addr;
 306
 307 #ifdef V3_CONFIG_SHADOW_PAGING_TELEMETRY
 308     core->shdw_pg_state.guest_faults++;
 309 #endif
 310
 311     return v3_raise_exception_with_error(core, PF_EXCEPTION, *(uint_t *)&error_code);
 312 }
 313
 314
 315 int v3_is_guest_pf(pt_access_status_t guest_access, pt_access_status_t shadow_access) {
 316     /* basically the reasoning is that there can be multiple reasons for a page fault:
 317        If there is a permissions failure for a page present in the guest _BUT_
 318        the reason for the fault was that the page is not present in the shadow,
 319        _THEN_ we have to map the shadow page in and reexecute, this will generate
 320        a permissions fault which is _THEN_ valid to send to the guest
 321        _UNLESS_ both the guest and shadow have marked the page as not present
 322
 323        whew...
 324     */
 325     if (guest_access != PT_ACCESS_OK) {
 326         // Guest Access Error
 327
 328         if ((shadow_access != PT_ACCESS_NOT_PRESENT) &&
 329             (guest_access != PT_ACCESS_NOT_PRESENT)) {
 330             // aka (guest permission error)
 331             return 1;
 332         }
 333
 334         /*
 335           if ((shadow_access == PT_ACCESS_NOT_PRESENT) &&
 336           (guest_access == PT_ACCESS_NOT_PRESENT)) {
 337           // Page tables completely blank, handle guest first
 338           return 1;
 339           }
 340         */
 341
 342         if (guest_access == PT_ACCESS_NOT_PRESENT) {
 343             // Page tables completely blank, handle guest first
 344             return 1;
 345         }
 346
 347         // Otherwise we'll handle the guest fault later...?
 348     }
 349
 350     return 0;
 351 }
 352
 353