1 #ifndef __X86_PAGE_H__
2 #define __X86_PAGE_H__
3
4 #include <xen/const.h>
5 #include <xen/page-size.h>
6
7 #define PAGE_ORDER_4K 0
8 #define PAGE_ORDER_2M 9
9 #define PAGE_ORDER_1G 18
10
11 #ifndef __ASSEMBLY__
12 # include <xen/types.h>
13 # include <xen/lib.h>
14 #endif
15
16 #include <asm/x86_64/page.h>
17
18 /* Read a pte atomically from memory. */
19 #define l1e_read(l1ep) \
20 l1e_from_intpte(read_atomic(&l1e_get_intpte(*(l1ep))))
21 #define l2e_read(l2ep) \
22 l2e_from_intpte(read_atomic(&l2e_get_intpte(*(l2ep))))
23 #define l3e_read(l3ep) \
24 l3e_from_intpte(read_atomic(&l3e_get_intpte(*(l3ep))))
25 #define l4e_read(l4ep) \
26 l4e_from_intpte(read_atomic(&l4e_get_intpte(*(l4ep))))
27
28 /* Write a pte atomically to memory. */
29 #define l1e_write(l1ep, l1e) \
30 write_atomic(&l1e_get_intpte(*(l1ep)), l1e_get_intpte(l1e))
31 #define l2e_write(l2ep, l2e) \
32 write_atomic(&l2e_get_intpte(*(l2ep)), l2e_get_intpte(l2e))
33 #define l3e_write(l3ep, l3e) \
34 write_atomic(&l3e_get_intpte(*(l3ep)), l3e_get_intpte(l3e))
35 #define l4e_write(l4ep, l4e) \
36 write_atomic(&l4e_get_intpte(*(l4ep)), l4e_get_intpte(l4e))
37
38 /* Get direct integer representation of a pte's contents (intpte_t). */
39 #define l1e_get_intpte(x) ((x).l1)
40 #define l2e_get_intpte(x) ((x).l2)
41 #define l3e_get_intpte(x) ((x).l3)
42 #define l4e_get_intpte(x) ((x).l4)
43
44 /* Get pfn mapped by pte (unsigned long). */
45 #define l1e_get_pfn(x) \
46 ((unsigned long)(((x).l1 & (PADDR_MASK&PAGE_MASK)) >> PAGE_SHIFT))
47 #define l2e_get_pfn(x) \
48 ((unsigned long)(((x).l2 & (PADDR_MASK&PAGE_MASK)) >> PAGE_SHIFT))
49 #define l3e_get_pfn(x) \
50 ((unsigned long)(((x).l3 & (PADDR_MASK&PAGE_MASK)) >> PAGE_SHIFT))
51 #define l4e_get_pfn(x) \
52 ((unsigned long)(((x).l4 & (PADDR_MASK&PAGE_MASK)) >> PAGE_SHIFT))
53
54 /* Get mfn mapped by pte (mfn_t). */
55 #define l1e_get_mfn(x) _mfn(l1e_get_pfn(x))
56 #define l2e_get_mfn(x) _mfn(l2e_get_pfn(x))
57 #define l3e_get_mfn(x) _mfn(l3e_get_pfn(x))
58 #define l4e_get_mfn(x) _mfn(l4e_get_pfn(x))
59
60 /* Get physical address of page mapped by pte (paddr_t). */
61 #define l1e_get_paddr(x) \
62 ((paddr_t)(((x).l1 & (PADDR_MASK&PAGE_MASK))))
63 #define l2e_get_paddr(x) \
64 ((paddr_t)(((x).l2 & (PADDR_MASK&PAGE_MASK))))
65 #define l3e_get_paddr(x) \
66 ((paddr_t)(((x).l3 & (PADDR_MASK&PAGE_MASK))))
67 #define l4e_get_paddr(x) \
68 ((paddr_t)(((x).l4 & (PADDR_MASK&PAGE_MASK))))
69
70 /* Get pointer to info structure of page mapped by pte (struct page_info *). */
71 #define l1e_get_page(x) mfn_to_page(l1e_get_mfn(x))
72 #define l2e_get_page(x) mfn_to_page(l2e_get_mfn(x))
73 #define l3e_get_page(x) mfn_to_page(l3e_get_mfn(x))
74 #define l4e_get_page(x) mfn_to_page(l4e_get_mfn(x))
75
76 /* Get pte access flags (unsigned int). */
77 #define l1e_get_flags(x) (get_pte_flags((x).l1))
78 #define l2e_get_flags(x) (get_pte_flags((x).l2))
79 #define l3e_get_flags(x) (get_pte_flags((x).l3))
80 #define l4e_get_flags(x) (get_pte_flags((x).l4))
81
82 /* Get pte pkeys (unsigned int). */
83 #define l1e_get_pkey(x) get_pte_pkey((x).l1)
84 #define l2e_get_pkey(x) get_pte_pkey((x).l2)
85 #define l3e_get_pkey(x) get_pte_pkey((x).l3)
86
87 /* Construct an empty pte. */
88 #define l1e_empty() ((l1_pgentry_t) { 0 })
89 #define l2e_empty() ((l2_pgentry_t) { 0 })
90 #define l3e_empty() ((l3_pgentry_t) { 0 })
91 #define l4e_empty() ((l4_pgentry_t) { 0 })
92
93 /* Construct a pte from a pfn and access flags. */
94 #define l1e_from_pfn(pfn, flags) \
95 ((l1_pgentry_t) { ((intpte_t)(pfn) << PAGE_SHIFT) | put_pte_flags(flags) })
96 #define l2e_from_pfn(pfn, flags) \
97 ((l2_pgentry_t) { ((intpte_t)(pfn) << PAGE_SHIFT) | put_pte_flags(flags) })
98 #define l3e_from_pfn(pfn, flags) \
99 ((l3_pgentry_t) { ((intpte_t)(pfn) << PAGE_SHIFT) | put_pte_flags(flags) })
100 #define l4e_from_pfn(pfn, flags) \
101 ((l4_pgentry_t) { ((intpte_t)(pfn) << PAGE_SHIFT) | put_pte_flags(flags) })
102
103 /* Construct a pte from an mfn and access flags. */
104 #define l1e_from_mfn(m, f) l1e_from_pfn(mfn_x(m), f)
105 #define l2e_from_mfn(m, f) l2e_from_pfn(mfn_x(m), f)
106 #define l3e_from_mfn(m, f) l3e_from_pfn(mfn_x(m), f)
107 #define l4e_from_mfn(m, f) l4e_from_pfn(mfn_x(m), f)
108
109 /* Construct a pte from a physical address and access flags. */
110 #ifndef __ASSEMBLY__
l1e_from_paddr(paddr_t pa,unsigned int flags)111 static inline l1_pgentry_t l1e_from_paddr(paddr_t pa, unsigned int flags)
112 {
113 ASSERT((pa & ~(PADDR_MASK & PAGE_MASK)) == 0);
114 return (l1_pgentry_t) { pa | put_pte_flags(flags) };
115 }
l2e_from_paddr(paddr_t pa,unsigned int flags)116 static inline l2_pgentry_t l2e_from_paddr(paddr_t pa, unsigned int flags)
117 {
118 ASSERT((pa & ~(PADDR_MASK & PAGE_MASK)) == 0);
119 return (l2_pgentry_t) { pa | put_pte_flags(flags) };
120 }
l3e_from_paddr(paddr_t pa,unsigned int flags)121 static inline l3_pgentry_t l3e_from_paddr(paddr_t pa, unsigned int flags)
122 {
123 ASSERT((pa & ~(PADDR_MASK & PAGE_MASK)) == 0);
124 return (l3_pgentry_t) { pa | put_pte_flags(flags) };
125 }
l4e_from_paddr(paddr_t pa,unsigned int flags)126 static inline l4_pgentry_t l4e_from_paddr(paddr_t pa, unsigned int flags)
127 {
128 ASSERT((pa & ~(PADDR_MASK & PAGE_MASK)) == 0);
129 return (l4_pgentry_t) { pa | put_pte_flags(flags) };
130 }
131 #endif /* !__ASSEMBLY__ */
132
133 /* Construct a pte from its direct integer representation. */
134 #define l1e_from_intpte(intpte) ((l1_pgentry_t) { (intpte_t)(intpte) })
135 #define l2e_from_intpte(intpte) ((l2_pgentry_t) { (intpte_t)(intpte) })
136 #define l3e_from_intpte(intpte) ((l3_pgentry_t) { (intpte_t)(intpte) })
137 #define l4e_from_intpte(intpte) ((l4_pgentry_t) { (intpte_t)(intpte) })
138
139 /* Construct a pte from a page pointer and access flags. */
140 #define l1e_from_page(page, flags) l1e_from_mfn(page_to_mfn(page), flags)
141 #define l2e_from_page(page, flags) l2e_from_mfn(page_to_mfn(page), flags)
142 #define l3e_from_page(page, flags) l3e_from_mfn(page_to_mfn(page), flags)
143 #define l4e_from_page(page, flags) l4e_from_mfn(page_to_mfn(page), flags)
144
145 /* Add extra flags to an existing pte. */
146 #define l1e_add_flags(x, flags) ((x).l1 |= put_pte_flags(flags))
147 #define l2e_add_flags(x, flags) ((x).l2 |= put_pte_flags(flags))
148 #define l3e_add_flags(x, flags) ((x).l3 |= put_pte_flags(flags))
149 #define l4e_add_flags(x, flags) ((x).l4 |= put_pte_flags(flags))
150
151 /* Remove flags from an existing pte. */
152 #define l1e_remove_flags(x, flags) ((x).l1 &= ~put_pte_flags(flags))
153 #define l2e_remove_flags(x, flags) ((x).l2 &= ~put_pte_flags(flags))
154 #define l3e_remove_flags(x, flags) ((x).l3 &= ~put_pte_flags(flags))
155 #define l4e_remove_flags(x, flags) ((x).l4 &= ~put_pte_flags(flags))
156
157 /* Flip flags in an existing L1 PTE. */
158 #define l1e_flip_flags(x, flags) ((x).l1 ^= put_pte_flags(flags))
159
160 /* Check if a pte's page mapping or significant access flags have changed. */
161 #define l1e_has_changed(x,y,flags) \
162 ( !!(((x).l1 ^ (y).l1) & ((PADDR_MASK&PAGE_MASK)|put_pte_flags(flags))) )
163 #define l2e_has_changed(x,y,flags) \
164 ( !!(((x).l2 ^ (y).l2) & ((PADDR_MASK&PAGE_MASK)|put_pte_flags(flags))) )
165 #define l3e_has_changed(x,y,flags) \
166 ( !!(((x).l3 ^ (y).l3) & ((PADDR_MASK&PAGE_MASK)|put_pte_flags(flags))) )
167 #define l4e_has_changed(x,y,flags) \
168 ( !!(((x).l4 ^ (y).l4) & ((PADDR_MASK&PAGE_MASK)|put_pte_flags(flags))) )
169
170 #define map_l1t_from_l2e(x) (l1_pgentry_t *)map_domain_page(l2e_get_mfn(x))
171 #define map_l2t_from_l3e(x) (l2_pgentry_t *)map_domain_page(l3e_get_mfn(x))
172 #define map_l3t_from_l4e(x) (l3_pgentry_t *)map_domain_page(l4e_get_mfn(x))
173
174 /* Unlike lYe_to_lXe(), lXe_from_lYe() do not rely on the direct map. */
175 #define l1e_from_l2e(l2e_, offset_) ({ \
176 const l1_pgentry_t *l1t_ = map_l1t_from_l2e(l2e_); \
177 l1_pgentry_t l1e_ = l1t_[offset_]; \
178 unmap_domain_page(l1t_); \
179 l1e_; })
180
181 #define l2e_from_l3e(l3e_, offset_) ({ \
182 const l2_pgentry_t *l2t_ = map_l2t_from_l3e(l3e_); \
183 l2_pgentry_t l2e_ = l2t_[offset_]; \
184 unmap_domain_page(l2t_); \
185 l2e_; })
186
187 #define l3e_from_l4e(l4e_, offset_) ({ \
188 const l3_pgentry_t *l3t_ = map_l3t_from_l4e(l4e_); \
189 l3_pgentry_t l3e_ = l3t_[offset_]; \
190 unmap_domain_page(l3t_); \
191 l3e_; })
192
193 /* Given a virtual address, get an entry offset into a page table. */
194 #define l1_table_offset(a) \
195 (((a) >> L1_PAGETABLE_SHIFT) & (L1_PAGETABLE_ENTRIES - 1))
196 #define l2_table_offset(a) \
197 (((a) >> L2_PAGETABLE_SHIFT) & (L2_PAGETABLE_ENTRIES - 1))
198 #define l3_table_offset(a) \
199 (((a) >> L3_PAGETABLE_SHIFT) & (L3_PAGETABLE_ENTRIES - 1))
200 #define l4_table_offset(a) \
201 (((a) >> L4_PAGETABLE_SHIFT) & (L4_PAGETABLE_ENTRIES - 1))
202
203 /* Convert a pointer to a page-table entry into pagetable slot index. */
204 #define pgentry_ptr_to_slot(_p) \
205 (((unsigned long)(_p) & ~PAGE_MASK) / sizeof(*(_p)))
206
207 #ifndef __ASSEMBLY__
208
209 /* Page-table type. */
210 typedef struct { u64 pfn; } pagetable_t;
211 #define pagetable_get_paddr(x) ((paddr_t)(x).pfn << PAGE_SHIFT)
212 #define pagetable_get_page(x) mfn_to_page(pagetable_get_mfn(x))
213 #define pagetable_get_pfn(x) ((x).pfn)
214 #define pagetable_get_mfn(x) _mfn(((x).pfn))
215 #define pagetable_is_null(x) ((x).pfn == 0)
216 #define pagetable_from_pfn(pfn) ((pagetable_t) { (pfn) })
217 #define pagetable_from_mfn(mfn) ((pagetable_t) { mfn_x(mfn) })
218 #define pagetable_from_page(pg) pagetable_from_mfn(page_to_mfn(pg))
219 #define pagetable_from_paddr(p) pagetable_from_pfn((p)>>PAGE_SHIFT)
220 #define pagetable_null() pagetable_from_pfn(0)
221
222 void clear_page_hot(void *pg);
223 void clear_page_cold(void *pg);
224 void copy_page_sse2(void *to, const void *from);
225
226 #define clear_page(_p) clear_page_cold(_p)
227 #define copy_page(_t, _f) copy_page_sse2(_t, _f)
228
229 #ifdef CONFIG_DEBUG
230 void scrub_page_hot(void *ptr);
231 void scrub_page_cold(void *ptr);
232 #endif
233
234 /* Convert between Xen-heap virtual addresses and machine addresses. */
235 #define __pa(x) (virt_to_maddr(x))
236 #define __va(x) (maddr_to_virt(x))
237
238 /* Convert between Xen-heap virtual addresses and machine frame numbers. */
239 #define __virt_to_mfn(va) (virt_to_maddr(va) >> PAGE_SHIFT)
240 #define __mfn_to_virt(mfn) (maddr_to_virt((paddr_t)(mfn) << PAGE_SHIFT))
241
242 /* Convert between machine frame numbers and page-info structures. */
243 #define mfn_to_page(mfn) (frame_table + mfn_to_pdx(mfn))
244 #define page_to_mfn(pg) pdx_to_mfn((unsigned long)((pg) - frame_table))
245
246 /* Convert between machine addresses and page-info structures. */
247 #define maddr_to_page(ma) mfn_to_page(maddr_to_mfn(ma))
248 #define page_to_maddr(pg) mfn_to_maddr(page_to_mfn(pg))
249
250 /* Convert between frame number and address formats. */
251 #define __pfn_to_paddr(pfn) ((paddr_t)(pfn) << PAGE_SHIFT)
252 #define __paddr_to_pfn(pa) ((unsigned long)((pa) >> PAGE_SHIFT))
253 #define gfn_to_gaddr(gfn) __pfn_to_paddr(gfn_x(gfn))
254 #define gaddr_to_gfn(ga) _gfn(__paddr_to_pfn(ga))
255 #define mfn_to_maddr(mfn) __pfn_to_paddr(mfn_x(mfn))
256 #define maddr_to_mfn(ma) _mfn(__paddr_to_pfn(ma))
257
258 /*
259 * We define non-underscored wrappers for above conversion functions. These are
260 * overridden in various source files while underscored versions remain intact.
261 */
262 #define mfn_valid(mfn) __mfn_valid(mfn_x(mfn))
263 #define virt_to_mfn(va) __virt_to_mfn(va)
264 #define mfn_to_virt(mfn) __mfn_to_virt(mfn)
265 #define pfn_to_paddr(pfn) __pfn_to_paddr(pfn)
266 #define paddr_to_pfn(pa) __paddr_to_pfn(pa)
267
268 /* Specialized forms acting on vmap() addresses. */
269 #define vmap_to_mfn(va) xen_map_to_mfn((unsigned long)(va))
270 #define vmap_to_page(va) mfn_to_page(vmap_to_mfn(va))
271
272 #endif /* !defined(__ASSEMBLY__) */
273
274 /* Where to find each level of the linear mapping */
275 #define __linear_l1_table ((l1_pgentry_t *)(LINEAR_PT_VIRT_START))
276 #define __linear_l2_table \
277 ((l2_pgentry_t *)(__linear_l1_table + l1_linear_offset(LINEAR_PT_VIRT_START)))
278 #define __linear_l3_table \
279 ((l3_pgentry_t *)(__linear_l2_table + l2_linear_offset(LINEAR_PT_VIRT_START)))
280 #define __linear_l4_table \
281 ((l4_pgentry_t *)(__linear_l3_table + l3_linear_offset(LINEAR_PT_VIRT_START)))
282
283
284 #ifndef __ASSEMBLY__
285 extern root_pgentry_t idle_pg_table[ROOT_PAGETABLE_ENTRIES];
286 extern l2_pgentry_t *compat_idle_pg_table_l2;
287 extern unsigned int m2p_compat_vstart;
288 extern l2_pgentry_t l2_xenmap[L2_PAGETABLE_ENTRIES],
289 l2_bootmap[4*L2_PAGETABLE_ENTRIES];
290 extern l3_pgentry_t l3_bootmap[L3_PAGETABLE_ENTRIES];
291 extern l2_pgentry_t l2_directmap[4*L2_PAGETABLE_ENTRIES];
292 extern l1_pgentry_t l1_fixmap[L1_PAGETABLE_ENTRIES];
293 void paging_init(void);
294 void efi_update_l4_pgtable(unsigned int l4idx, l4_pgentry_t l4e);
295 #endif /* !defined(__ASSEMBLY__) */
296
297 #define _PAGE_NONE _AC(0x000,U)
298 #define _PAGE_PRESENT _AC(0x001,U)
299 #define _PAGE_RW _AC(0x002,U)
300 #define _PAGE_USER _AC(0x004,U)
301 #define _PAGE_PWT _AC(0x008,U)
302 #define _PAGE_PCD _AC(0x010,U)
303 #define _PAGE_ACCESSED _AC(0x020,U)
304 #define _PAGE_DIRTY _AC(0x040,U)
305 #define _PAGE_PAT _AC(0x080,U)
306 #define _PAGE_PSE _AC(0x080,U)
307 #define _PAGE_GLOBAL _AC(0x100,U)
308 #define _PAGE_AVAIL0 _AC(0x200,U)
309 #define _PAGE_AVAIL1 _AC(0x400,U)
310 #define _PAGE_AVAIL2 _AC(0x800,U)
311 #define _PAGE_AVAIL _AC(0xE00,U)
312 #define _PAGE_PSE_PAT _AC(0x1000,U)
313 #define _PAGE_AVAIL_HIGH (_AC(0x7ff, U) << 12)
314
315 #ifndef __ASSEMBLY__
316 /* Dependency on NX being available can't be expressed. */
317 #define _PAGE_NX (cpu_has_nx ? _PAGE_NX_BIT : 0)
318 #endif
319
320 #define PAGE_CACHE_ATTRS (_PAGE_PAT | _PAGE_PCD | _PAGE_PWT)
321
322 /* Memory types, encoded under Xen's choice of MSR_PAT. */
323 #define _PAGE_WB ( 0)
324 #define _PAGE_WT ( _PAGE_PWT)
325 #define _PAGE_UCM ( _PAGE_PCD )
326 #define _PAGE_UC ( _PAGE_PCD | _PAGE_PWT)
327 #define _PAGE_WC (_PAGE_PAT )
328 #define _PAGE_WP (_PAGE_PAT | _PAGE_PWT)
329
330 /*
331 * Debug option: Ensure that granted mappings are not implicitly unmapped.
332 * WARNING: This will need to be disabled to run OSes that use the spare PTE
333 * bits themselves (e.g., *BSD).
334 */
335 #ifdef NDEBUG
336 #undef _PAGE_GNTTAB
337 #endif
338 #ifndef _PAGE_GNTTAB
339 #define _PAGE_GNTTAB 0
340 #endif
341
342 #define __PAGE_HYPERVISOR_RO (_PAGE_PRESENT | _PAGE_ACCESSED | _PAGE_NX)
343 #define __PAGE_HYPERVISOR_RW (__PAGE_HYPERVISOR_RO | \
344 _PAGE_DIRTY | _PAGE_RW)
345 #define __PAGE_HYPERVISOR_RX (_PAGE_PRESENT | _PAGE_ACCESSED)
346 #define __PAGE_HYPERVISOR (__PAGE_HYPERVISOR_RX | \
347 _PAGE_DIRTY | _PAGE_RW)
348 #define __PAGE_HYPERVISOR_WT (__PAGE_HYPERVISOR | _PAGE_WT)
349 #define __PAGE_HYPERVISOR_UCMINUS (__PAGE_HYPERVISOR | _PAGE_UCM)
350 #define __PAGE_HYPERVISOR_UC (__PAGE_HYPERVISOR | _PAGE_UC)
351 #define __PAGE_HYPERVISOR_WC (__PAGE_HYPERVISOR | _PAGE_WC)
352 #define __PAGE_HYPERVISOR_SHSTK (__PAGE_HYPERVISOR_RO | _PAGE_DIRTY)
353
354 #define MAP_SMALL_PAGES _PAGE_AVAIL0 /* don't use superpages mappings */
355
356 #ifndef __ASSEMBLY__
357
358 /* Convert between PAT/PCD/PWT embedded in PTE flags and 3-bit cacheattr. */
pte_flags_to_cacheattr(unsigned int flags)359 static inline unsigned int pte_flags_to_cacheattr(unsigned int flags)
360 {
361 return ((flags >> 5) & 4) | ((flags >> 3) & 3);
362 }
cacheattr_to_pte_flags(unsigned int cacheattr)363 static inline unsigned int cacheattr_to_pte_flags(unsigned int cacheattr)
364 {
365 return ((cacheattr & 4) << 5) | ((cacheattr & 3) << 3);
366 }
367
368 /* return true if permission increased */
369 static inline bool
perms_strictly_increased(uint32_t old_flags,uint32_t new_flags)370 perms_strictly_increased(uint32_t old_flags, uint32_t new_flags)
371 /* Given the flags of two entries, are the new flags a strict
372 * increase in rights over the old ones? */
373 {
374 uint32_t of = old_flags & (_PAGE_PRESENT|_PAGE_RW|_PAGE_USER|_PAGE_NX_BIT);
375 uint32_t nf = new_flags & (_PAGE_PRESENT|_PAGE_RW|_PAGE_USER|_PAGE_NX_BIT);
376 /* Flip the NX bit, since it's the only one that decreases rights;
377 * we calculate as if it were an "X" bit. */
378 of ^= _PAGE_NX_BIT;
379 nf ^= _PAGE_NX_BIT;
380 /* If the changed bits are all set in the new flags, then rights strictly
381 * increased between old and new. */
382 return ((of | (of ^ nf)) == nf);
383 }
384
invalidate_icache(void)385 static inline void invalidate_icache(void)
386 {
387 /*
388 * There is nothing to be done here as icaches are sufficiently
389 * coherent on x86.
390 */
391 }
392
393 #endif /* !__ASSEMBLY__ */
394
395 #endif /* __X86_PAGE_H__ */
396
397 /*
398 * Local variables:
399 * mode: C
400 * c-file-style: "BSD"
401 * c-basic-offset: 4
402 * tab-width: 4
403 * indent-tabs-mode: nil
404 * End:
405 */
406