palacios/include/palacios/vmm_paging.h

   1 #ifndef __VMM_PAGING_H
   2 #define __VMM_PAGING_H
   3
   4
   5 #include <palacios/vmm_types.h>
   6 #include <palacios/vmm_util.h>
   7
   8 /*
   9
  10 In the following, when we say "page table", we mean the whole 2 or 4 layer
  11 page table (PDEs, PTEs), etc.
  12
  13
  14 guest-visible paging state
  15  This is the state that the guest thinks the machine is using
  16  It consists of
  17    - guest physical memory
  18        The physical memory addresses the guest is allowed to use
  19        (see shadow page maps, below)
  20    - guest page tables
  21        (we care about when the current one changes)
  22    - guest paging registers (these are never written to hardware)
  23         CR0
  24         CR3
  25
  26
  27 shadow paging state
  28  This the state that the machine will actually use when the guest
  29  is running.  It consists of:
  30    - current shadow page table
  31         This is the page table actually useed when the guest is running.
  32         It is changed/regenerated when the guest page table changes
  33         It mostly reflects the guest page table, except that it restricts
  34         physical addresses to those the VMM allocates to the guest.
  35    - shadow page maps
  36         This is a mapping from guest physical memory addresses to
  37         the current location of the guest physical memory content.
  38         It maps from regions of physical memory addresses to regions
  39         located in physical memory or elsewhere.
  40         (8192,16384) -> MEM(8912,...)
  41         (0,8191) -> DISK(65536,..)
  42    - guest paging registers (these are written to guest state)
  43         CR0
  44         CR3
  45
  46 host paging state
  47   This is the state we expect to be operative when the VMM is running.
  48   Typically, this is set up by the host os into which we have embedded
  49   the VMM, but we include the description here for clarity.
  50     - current page table
  51         This is the page table we use when we are executing in
  52         the VMM (or the host os)
  53     - paging regisers
  54         CR0
  55         CR3
  56
  57
  58 The reason why the shadow paging state and the host paging state are
  59 distinct is to permit the guest to use any virtual address it wants,
  60 irrespective of the addresses the VMM or the host os use.  These guest
  61 virtual addresses are reflected in the shadow paging state.  When we
  62 exit from the guest, we switch to the host paging state so that any
  63 virtual addresses that overlap between the guest and VMM/host now map
  64 to the physical addresses epxected by the VMM/host.  On AMD SVM, this
  65 switch is done by the hardware.  On Intel VT, the switch is done
  66 by the hardware as well, but we are responsible for manually updating
  67 the host state in the vmcs before entering the guest.
  68 */
  69
  70
  71 #ifdef __V3VEE__
  72
  73 #define MAX_PTE32_ENTRIES          1024
  74 #define MAX_PDE32_ENTRIES          1024
  75
  76 #define MAX_PTE64_ENTRIES          512
  77 #define MAX_PDE64_ENTRIES          512
  78 #define MAX_PDPE64_ENTRIES         512
  79 #define MAX_PML4E64_ENTRIES        512
  80
  81
  82 /* Converts an address into a page table index */
  83 #define PDE32_INDEX(x)  ((((uint_t)x) >> 22) & 0x3ff)
  84 #define PTE32_INDEX(x)  ((((uint_t)x) >> 12) & 0x3ff)
  85
  86 /* Gets the base address needed for a Page Table entry */
  87 #define PD32_BASE_ADDR(x) (((uint_t)x) >> 12)
  88 #define PT32_BASE_ADDR(x) (((uint_t)x) >> 12)
  89 #define PD32_4MB_BASE_ADDR(x) (((uint_t)x) >> 22)
  90
  91 #define PT32_PAGE_ADDR(x)   (((uint_t)x) & 0xfffff000)
  92 #define PT32_PAGE_OFFSET(x) (((uint_t)x) & 0xfff)
  93 #define PT32_PAGE_POWER 12
  94
  95 #define PD32_4MB_PAGE_ADDR(x) (((uint_t)x) & 0xffc00000)
  96 #define PD32_4MB_PAGE_OFFSET(x) (((uint_t)x) & 0x003fffff)
  97 #define PAGE_SIZE_4MB (4096 * 1024)
  98
  99 /* The following should be phased out */
 100 #define PAGE_OFFSET(x)  ((((uint_t)x) & 0xfff))
 101 #define PAGE_ALIGNED_ADDR(x)   (((uint_t) (x)) >> 12)
 102 #define PAGE_ADDR(x)   (PAGE_ALIGNED_ADDR(x) << 12)
 103 #define PAGE_POWER 12
 104 #define PAGE_SIZE 4096
 105 /* ** */
 106
 107
 108
 109
 110 #define CR3_TO_PDE32(cr3) (((ulong_t)cr3) & 0xfffff000)
 111 #define CR3_TO_PDPTRE(cr3) (((ulong_t)cr3) & 0xffffffe0)
 112 #define CR3_TO_PML4E64(cr3)  (((ullong_t)cr3) & 0x000ffffffffff000LL)
 113
 114
 115 /* Accessor functions for the page table structures */
 116 #define PDE32_T_ADDR(x) (((x).pt_base_addr) << 12)
 117 #define PTE32_T_ADDR(x) (((x).page_base_addr) << 12)
 118 #define PDE32_4MB_T_ADDR(x) (((x).page_base_addr) << 22)
 119
 120 /* Page Table Flag Values */
 121 #define PT32_HOOK 0x1
 122
 123
 124 #endif
 125
 126 /* PDE 32 bit PAGE STRUCTURES */
 127 typedef enum {PDE32_ENTRY_NOT_PRESENT, PDE32_ENTRY_PTE32, PDE32_ENTRY_LARGE_PAGE} pde32_entry_type_t;
 128 typedef enum {PT_ACCESS_OK, PT_ENTRY_NOT_PRESENT, PT_WRITE_ERROR, PT_USER_ERROR} pt_access_status_t;
 129
 130 typedef struct pde32 {
 131   uint_t present         : 1;
 132   uint_t writable        : 1;
 133   uint_t user_page       : 1;
 134   uint_t write_through   : 1;
 135   uint_t cache_disable   : 1;
 136   uint_t accessed        : 1;
 137   uint_t reserved        : 1;
 138   uint_t large_page     : 1;
 139   uint_t global_page     : 1;
 140   uint_t vmm_info        : 3;
 141   uint_t pt_base_addr    : 20;
 142 } pde32_t;
 143
 144 typedef struct pde32_4MB {
 145   uint_t present         : 1;
 146   uint_t writable        : 1;
 147   uint_t user_page       : 1;
 148   uint_t write_through   : 1;
 149   uint_t cache_disable   : 1;
 150   uint_t accessed        : 1;
 151   uint_t dirty           : 1;
 152   uint_t one             : 1;
 153   uint_t global_page     : 1;
 154   uint_t vmm_info        : 3;
 155   uint_t pat             : 1;
 156   uint_t rsvd            : 9;
 157   uint_t page_base_addr  : 10;
 158
 159 } pde32_4MB_t;
 160
 161 typedef struct pte32 {
 162   uint_t present         : 1;
 163   uint_t writable        : 1;
 164   uint_t user_page       : 1;
 165   uint_t write_through   : 1;
 166   uint_t cache_disable   : 1;
 167   uint_t accessed        : 1;
 168   uint_t dirty           : 1;
 169   uint_t pte_attr        : 1;
 170   uint_t global_page     : 1;
 171   uint_t vmm_info        : 3;
 172   uint_t page_base_addr  : 20;
 173 } pte32_t;
 174 /* ***** */
 175
 176 /* 32 bit PAE PAGE STRUCTURES */
 177
 178 //
 179 // Fill in
 180 //
 181
 182 /* ********** */
 183
 184
 185 /* LONG MODE 64 bit PAGE STRUCTURES */
 186 typedef struct pml4e64 {
 187   uint_t present        : 1;
 188   uint_t writable       : 1;
 189   uint_t user           : 1;
 190   uint_t pwt            : 1;
 191   uint_t pcd            : 1;
 192   uint_t accessed       : 1;
 193   uint_t reserved       : 1;
 194   uint_t zero           : 2;
 195   uint_t vmm_info       : 3;
 196   uint_t pdp_base_addr_lo : 20;
 197   uint_t pdp_base_addr_hi : 20;
 198   uint_t available      : 11;
 199   uint_t no_execute     : 1;
 200 } pml4e64_t;
 201
 202
 203 typedef struct pdpe64 {
 204   uint_t present        : 1;
 205   uint_t writable       : 1;
 206   uint_t user           : 1;
 207   uint_t pwt            : 1;
 208   uint_t pcd            : 1;
 209   uint_t accessed       : 1;
 210   uint_t reserved       : 1;
 211   uint_t large_pages    : 1;
 212   uint_t zero           : 1;
 213   uint_t vmm_info       : 3;
 214   uint_t pd_base_addr_lo : 20;
 215   uint_t pd_base_addr_hi : 20;
 216   uint_t available      : 11;
 217   uint_t no_execute     : 1;
 218 } pdpe64_t;
 219
 220
 221
 222
 223 typedef struct pde64 {
 224   uint_t present         : 1;
 225   uint_t flags           : 4;
 226   uint_t accessed        : 1;
 227   uint_t reserved        : 1;
 228   uint_t large_pages     : 1;
 229   uint_t reserved2       : 1;
 230   uint_t vmm_info        : 3;
 231   uint_t pt_base_addr_lo    : 20;
 232   uint_t pt_base_addr_hi : 20;
 233   uint_t available       : 11;
 234   uint_t no_execute      : 1;
 235 } pde64_t;
 236
 237 typedef struct pte64 {
 238   uint_t present         : 1;
 239   uint_t flags           : 4;
 240   uint_t accessed        : 1;
 241   uint_t dirty           : 1;
 242   uint_t pte_attr        : 1;
 243   uint_t global_page     : 1;
 244   uint_t vmm_info        : 3;
 245   uint_t page_base_addr_lo  : 20;
 246   uint_t page_base_addr_hi : 20;
 247   uint_t available       : 11;
 248   uint_t no_execute      : 1;
 249 } pte64_t;
 250
 251 /* *************** */
 252
 253 typedef struct pf_error_code {
 254   uint_t present           : 1; // if 0, fault due to page not present
 255   uint_t write             : 1; // if 1, faulting access was a write
 256   uint_t user              : 1; // if 1, faulting access was in user mode
 257   uint_t rsvd_access       : 1; // if 1, fault from reading a 1 from a reserved field (?)
 258   uint_t ifetch            : 1; // if 1, faulting access was an instr fetch (only with NX)
 259   uint_t rsvd              : 27;
 260 } pf_error_t;
 261
 262 typedef enum { PDE32 } paging_mode_t;
 263
 264
 265
 266
 267 void delete_page_tables_pde32(pde32_t * pde);
 268
 269
 270 pde32_entry_type_t pde32_lookup(pde32_t * pd, addr_t addr, addr_t * entry);
 271 int pte32_lookup(pte32_t * pte, addr_t addr, addr_t * entry);
 272
 273 // This assumes that the page table resides in the host address space
 274 // IE. IT DOES NO VM ADDR TRANSLATION
 275 int pt32_lookup(pde32_t * pd, addr_t vaddr, addr_t * paddr);
 276
 277
 278
 279 pt_access_status_t can_access_pde32(pde32_t * pde, addr_t addr, pf_error_t access_type);
 280 pt_access_status_t can_access_pte32(pte32_t * pte, addr_t addr, pf_error_t access_type);
 281
 282
 283
 284
 285
 286 struct guest_info;
 287
 288 pde32_t * create_passthrough_pde32_pts(struct guest_info * guest_info);
 289
 290
 291
 292
 293
 294
 295 void PrintDebugPageTables(pde32_t * pde);
 296
 297
 298 #ifdef __V3VEE__
 299
 300
 301 void PrintPT32(addr_t starting_address, pte32_t * pte);
 302 void PrintPD32(pde32_t * pde);
 303 void PrintPTE32(addr_t virtual_address, pte32_t * pte);
 304 void PrintPDE32(addr_t virtual_address, pde32_t * pde);
 305
 306 #endif // !__V3VEE__
 307
 308
 309
 310 #endif