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
 116
 117 /* Accessor functions for the page table structures */
 118 #define PDE32_T_ADDR(x) (((x).pt_base_addr) << 12)
 119 #define PTE32_T_ADDR(x) (((x).page_base_addr) << 12)
 120 #define PDE32_4MB_T_ADDR(x) (((x).page_base_addr) << 22)
 121
 122 /* Page Table Flag Values */
 123 #define PT32_HOOK 0x1
 124
 125
 126 #endif
 127
 128 /* PDE 32 bit PAGE STRUCTURES */
 129 typedef enum {PDE32_ENTRY_NOT_PRESENT, PDE32_ENTRY_PTE32, PDE32_ENTRY_LARGE_PAGE} pde32_entry_type_t;
 130 typedef enum {PT_ACCESS_OK, PT_ENTRY_NOT_PRESENT, PT_WRITE_ERROR, PT_USER_ERROR} pt_access_status_t;
 131
 132 typedef struct pde32 {
 133   uint_t present         : 1;
 134   uint_t writable        : 1;
 135   uint_t user_page       : 1;
 136   uint_t write_through   : 1;
 137   uint_t cache_disable   : 1;
 138   uint_t accessed        : 1;
 139   uint_t reserved        : 1;
 140   uint_t large_page     : 1;
 141   uint_t global_page     : 1;
 142   uint_t vmm_info        : 3;
 143   uint_t pt_base_addr    : 20;
 144 } pde32_t;
 145
 146 typedef struct pde32_4MB {
 147   uint_t present         : 1;
 148   uint_t writable        : 1;
 149   uint_t user_page       : 1;
 150   uint_t write_through   : 1;
 151   uint_t cache_disable   : 1;
 152   uint_t accessed        : 1;
 153   uint_t dirty           : 1;
 154   uint_t one             : 1;
 155   uint_t global_page     : 1;
 156   uint_t vmm_info        : 3;
 157   uint_t pat             : 1;
 158   uint_t rsvd            : 9;
 159   uint_t page_base_addr  : 10;
 160
 161 } pde32_4MB_t;
 162
 163 typedef struct pte32 {
 164   uint_t present         : 1;
 165   uint_t writable        : 1;
 166   uint_t user_page       : 1;
 167   uint_t write_through   : 1;
 168   uint_t cache_disable   : 1;
 169   uint_t accessed        : 1;
 170   uint_t dirty           : 1;
 171   uint_t pte_attr        : 1;
 172   uint_t global_page     : 1;
 173   uint_t vmm_info        : 3;
 174   uint_t page_base_addr  : 20;
 175 } pte32_t;
 176 /* ***** */
 177
 178 /* 32 bit PAE PAGE STRUCTURES */
 179
 180 //
 181 // Fill in
 182 //
 183
 184 /* ********** */
 185
 186
 187 /* LONG MODE 64 bit PAGE STRUCTURES */
 188 typedef struct pml4e64 {
 189   uint_t present        : 1;
 190   uint_t writable       : 1;
 191   uint_t user           : 1;
 192   uint_t pwt            : 1;
 193   uint_t pcd            : 1;
 194   uint_t accessed       : 1;
 195   uint_t reserved       : 1;
 196   uint_t zero           : 2;
 197   uint_t vmm_info       : 3;
 198   uint_t pdp_base_addr_lo : 20;
 199   uint_t pdp_base_addr_hi : 20;
 200   uint_t available      : 11;
 201   uint_t no_execute     : 1;
 202 } pml4e64_t;
 203
 204
 205 typedef struct pdpe64 {
 206   uint_t present        : 1;
 207   uint_t writable       : 1;
 208   uint_t user           : 1;
 209   uint_t pwt            : 1;
 210   uint_t pcd            : 1;
 211   uint_t accessed       : 1;
 212   uint_t reserved       : 1;
 213   uint_t large_pages    : 1;
 214   uint_t zero           : 1;
 215   uint_t vmm_info       : 3;
 216   uint_t pd_base_addr_lo : 20;
 217   uint_t pd_base_addr_hi : 20;
 218   uint_t available      : 11;
 219   uint_t no_execute     : 1;
 220 } pdpe64_t;
 221
 222
 223
 224
 225 typedef struct pde64 {
 226   uint_t present         : 1;
 227   uint_t flags           : 4;
 228   uint_t accessed        : 1;
 229   uint_t reserved        : 1;
 230   uint_t large_pages     : 1;
 231   uint_t reserved2       : 1;
 232   uint_t vmm_info        : 3;
 233   uint_t pt_base_addr_lo    : 20;
 234   uint_t pt_base_addr_hi : 20;
 235   uint_t available       : 11;
 236   uint_t no_execute      : 1;
 237 } pde64_t;
 238
 239 typedef struct pte64 {
 240   uint_t present         : 1;
 241   uint_t flags           : 4;
 242   uint_t accessed        : 1;
 243   uint_t dirty           : 1;
 244   uint_t pte_attr        : 1;
 245   uint_t global_page     : 1;
 246   uint_t vmm_info        : 3;
 247   uint_t page_base_addr_lo  : 20;
 248   uint_t page_base_addr_hi : 20;
 249   uint_t available       : 11;
 250   uint_t no_execute      : 1;
 251 } pte64_t;
 252
 253 /* *************** */
 254
 255 typedef struct pf_error_code {
 256   uint_t present           : 1; // if 0, fault due to page not present
 257   uint_t write             : 1; // if 1, faulting access was a write
 258   uint_t user              : 1; // if 1, faulting access was in user mode
 259   uint_t rsvd_access       : 1; // if 1, fault from reading a 1 from a reserved field (?)
 260   uint_t ifetch            : 1; // if 1, faulting access was an instr fetch (only with NX)
 261   uint_t rsvd              : 27;
 262 } pf_error_t;
 263
 264 typedef enum { PDE32 } paging_mode_t;
 265
 266
 267
 268
 269 void delete_page_tables_pde32(pde32_t * pde);
 270
 271
 272 pde32_entry_type_t pde32_lookup(pde32_t * pd, addr_t addr, addr_t * entry);
 273 int pte32_lookup(pte32_t * pte, addr_t addr, addr_t * entry);
 274
 275 // This assumes that the page table resides in the host address space
 276 // IE. IT DOES NO VM ADDR TRANSLATION
 277 int pt32_lookup(pde32_t * pd, addr_t vaddr, addr_t * paddr);
 278
 279
 280
 281 pt_access_status_t can_access_pde32(pde32_t * pde, addr_t addr, pf_error_t access_type);
 282 pt_access_status_t can_access_pte32(pte32_t * pte, addr_t addr, pf_error_t access_type);
 283
 284
 285
 286
 287
 288 struct guest_info;
 289
 290 pde32_t * create_passthrough_pde32_pts(struct guest_info * guest_info);
 291
 292
 293
 294
 295
 296
 297 void PrintDebugPageTables(pde32_t * pde);
 298
 299
 300 #ifdef __V3VEE__
 301
 302
 303 void PrintPT32(addr_t starting_address, pte32_t * pte);
 304 void PrintPD32(pde32_t * pde);
 305 void PrintPTE32(addr_t virtual_address, pte32_t * pte);
 306 void PrintPDE32(addr_t virtual_address, pde32_t * pde);
 307
 308 #endif // !__V3VEE__
 309
 310
 311
 312 #endif