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