]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/asm-x86/pgtable.h
x86: pgtable: unify pte accessors
[mirror_ubuntu-focal-kernel.git] / include / asm-x86 / pgtable.h
CommitLineData
6c386655
JF
1#ifndef _ASM_X86_PGTABLE_H
2#define _ASM_X86_PGTABLE_H
3
4#define USER_PTRS_PER_PGD ((TASK_SIZE-1)/PGDIR_SIZE+1)
5#define FIRST_USER_ADDRESS 0
6
7#define _PAGE_BIT_PRESENT 0
8#define _PAGE_BIT_RW 1
9#define _PAGE_BIT_USER 2
10#define _PAGE_BIT_PWT 3
11#define _PAGE_BIT_PCD 4
12#define _PAGE_BIT_ACCESSED 5
13#define _PAGE_BIT_DIRTY 6
14#define _PAGE_BIT_FILE 6
15#define _PAGE_BIT_PSE 7 /* 4 MB (or 2MB) page */
16#define _PAGE_BIT_GLOBAL 8 /* Global TLB entry PPro+ */
17#define _PAGE_BIT_UNUSED1 9 /* available for programmer */
18#define _PAGE_BIT_UNUSED2 10
19#define _PAGE_BIT_UNUSED3 11
20#define _PAGE_BIT_NX 63 /* No execute: only valid after cpuid check */
21
61f38226
IM
22#define _PAGE_PRESENT (_AC(1, L)<<_PAGE_BIT_PRESENT)
23#define _PAGE_RW (_AC(1, L)<<_PAGE_BIT_RW)
24#define _PAGE_USER (_AC(1, L)<<_PAGE_BIT_USER)
25#define _PAGE_PWT (_AC(1, L)<<_PAGE_BIT_PWT)
26#define _PAGE_PCD (_AC(1, L)<<_PAGE_BIT_PCD)
27#define _PAGE_ACCESSED (_AC(1, L)<<_PAGE_BIT_ACCESSED)
28#define _PAGE_DIRTY (_AC(1, L)<<_PAGE_BIT_DIRTY)
29#define _PAGE_PSE (_AC(1, L)<<_PAGE_BIT_PSE) /* 2MB page */
30#define _PAGE_GLOBAL (_AC(1, L)<<_PAGE_BIT_GLOBAL) /* Global TLB entry */
31#define _PAGE_UNUSED1 (_AC(1, L)<<_PAGE_BIT_UNUSED1)
32#define _PAGE_UNUSED2 (_AC(1, L)<<_PAGE_BIT_UNUSED2)
33#define _PAGE_UNUSED3 (_AC(1, L)<<_PAGE_BIT_UNUSED3)
6c386655
JF
34
35#if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
36#define _PAGE_NX (_AC(1, ULL) << _PAGE_BIT_NX)
37#else
38#define _PAGE_NX 0
39#endif
40
41/* If _PAGE_PRESENT is clear, we use these: */
42#define _PAGE_FILE _PAGE_DIRTY /* nonlinear file mapping, saved PTE; unset:swap */
43#define _PAGE_PROTNONE _PAGE_PSE /* if the user mapped it with PROT_NONE;
44 pte_present gives true */
45
46#define _PAGE_TABLE (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | _PAGE_ACCESSED | _PAGE_DIRTY)
47#define _KERNPG_TABLE (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED | _PAGE_DIRTY)
48
49#define _PAGE_CHG_MASK (PTE_MASK | _PAGE_ACCESSED | _PAGE_DIRTY)
50
51#define PAGE_NONE __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
52#define PAGE_SHARED __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | _PAGE_ACCESSED | _PAGE_NX)
53
54#define PAGE_SHARED_EXEC __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | _PAGE_ACCESSED)
55#define PAGE_COPY_NOEXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | _PAGE_ACCESSED | _PAGE_NX)
56#define PAGE_COPY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | _PAGE_ACCESSED)
57#define PAGE_COPY PAGE_COPY_NOEXEC
58#define PAGE_READONLY __pgprot(_PAGE_PRESENT | _PAGE_USER | _PAGE_ACCESSED | _PAGE_NX)
59#define PAGE_READONLY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | _PAGE_ACCESSED)
60
61#ifdef CONFIG_X86_32
62#define _PAGE_KERNEL_EXEC \
63 (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED)
64#define _PAGE_KERNEL (_PAGE_KERNEL_EXEC | _PAGE_NX)
65
66#ifndef __ASSEMBLY__
67extern unsigned long long __PAGE_KERNEL, __PAGE_KERNEL_EXEC;
68#endif /* __ASSEMBLY__ */
69#else
70#define __PAGE_KERNEL_EXEC \
71 (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED)
72#define __PAGE_KERNEL (__PAGE_KERNEL_EXEC | _PAGE_NX)
73#endif
74
75#define __PAGE_KERNEL_RO (__PAGE_KERNEL & ~_PAGE_RW)
76#define __PAGE_KERNEL_RX (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
77#define __PAGE_KERNEL_NOCACHE (__PAGE_KERNEL | _PAGE_PCD | _PAGE_PWT)
78#define __PAGE_KERNEL_VSYSCALL (__PAGE_KERNEL_RX | _PAGE_USER)
79#define __PAGE_KERNEL_VSYSCALL_NOCACHE (__PAGE_KERNEL_VSYSCALL | _PAGE_PCD | _PAGE_PWT)
80#define __PAGE_KERNEL_LARGE (__PAGE_KERNEL | _PAGE_PSE)
81#define __PAGE_KERNEL_LARGE_EXEC (__PAGE_KERNEL_EXEC | _PAGE_PSE)
82
83#ifdef CONFIG_X86_32
84# define MAKE_GLOBAL(x) __pgprot((x))
85#else
86# define MAKE_GLOBAL(x) __pgprot((x) | _PAGE_GLOBAL)
87#endif
88
89#define PAGE_KERNEL MAKE_GLOBAL(__PAGE_KERNEL)
90#define PAGE_KERNEL_RO MAKE_GLOBAL(__PAGE_KERNEL_RO)
91#define PAGE_KERNEL_EXEC MAKE_GLOBAL(__PAGE_KERNEL_EXEC)
92#define PAGE_KERNEL_RX MAKE_GLOBAL(__PAGE_KERNEL_RX)
93#define PAGE_KERNEL_NOCACHE MAKE_GLOBAL(__PAGE_KERNEL_NOCACHE)
94#define PAGE_KERNEL_LARGE MAKE_GLOBAL(__PAGE_KERNEL_LARGE)
95#define PAGE_KERNEL_LARGE_EXEC MAKE_GLOBAL(__PAGE_KERNEL_LARGE_EXEC)
96#define PAGE_KERNEL_VSYSCALL MAKE_GLOBAL(__PAGE_KERNEL_VSYSCALL)
97#define PAGE_KERNEL_VSYSCALL_NOCACHE MAKE_GLOBAL(__PAGE_KERNEL_VSYSCALL_NOCACHE)
98
99/* xwr */
100#define __P000 PAGE_NONE
101#define __P001 PAGE_READONLY
102#define __P010 PAGE_COPY
103#define __P011 PAGE_COPY
104#define __P100 PAGE_READONLY_EXEC
105#define __P101 PAGE_READONLY_EXEC
106#define __P110 PAGE_COPY_EXEC
107#define __P111 PAGE_COPY_EXEC
108
109#define __S000 PAGE_NONE
110#define __S001 PAGE_READONLY
111#define __S010 PAGE_SHARED
112#define __S011 PAGE_SHARED
113#define __S100 PAGE_READONLY_EXEC
114#define __S101 PAGE_READONLY_EXEC
115#define __S110 PAGE_SHARED_EXEC
116#define __S111 PAGE_SHARED_EXEC
117
4614139c 118#ifndef __ASSEMBLY__
195466dc 119
4614139c
JF
120/*
121 * The following only work if pte_present() is true.
122 * Undefined behaviour if not..
123 */
124static inline int pte_dirty(pte_t pte) { return pte_val(pte) & _PAGE_DIRTY; }
125static inline int pte_young(pte_t pte) { return pte_val(pte) & _PAGE_ACCESSED; }
126static inline int pte_write(pte_t pte) { return pte_val(pte) & _PAGE_RW; }
127static inline int pte_file(pte_t pte) { return pte_val(pte) & _PAGE_FILE; }
128static inline int pte_huge(pte_t pte) { return pte_val(pte) & _PAGE_PSE; }
129
130static inline int pmd_large(pmd_t pte) {
131 return (pmd_val(pte) & (_PAGE_PSE|_PAGE_PRESENT)) ==
132 (_PAGE_PSE|_PAGE_PRESENT);
133}
134
135static inline pte_t pte_mkclean(pte_t pte) { return __pte(pte_val(pte) & ~_PAGE_DIRTY); }
136static inline pte_t pte_mkold(pte_t pte) { return __pte(pte_val(pte) & ~_PAGE_ACCESSED); }
137static inline pte_t pte_wrprotect(pte_t pte) { return __pte(pte_val(pte) & ~_PAGE_RW); }
138static inline pte_t pte_mkexec(pte_t pte) { return __pte(pte_val(pte) & ~_PAGE_NX); }
139static inline pte_t pte_mkdirty(pte_t pte) { return __pte(pte_val(pte) | _PAGE_DIRTY); }
140static inline pte_t pte_mkyoung(pte_t pte) { return __pte(pte_val(pte) | _PAGE_ACCESSED); }
141static inline pte_t pte_mkwrite(pte_t pte) { return __pte(pte_val(pte) | _PAGE_RW); }
142static inline pte_t pte_mkhuge(pte_t pte) { return __pte(pte_val(pte) | _PAGE_PSE); }
143static inline pte_t pte_clrhuge(pte_t pte) { return __pte(pte_val(pte) & ~_PAGE_PSE); }
144
6fdc05d4
JF
145extern pteval_t __supported_pte_mask;
146
147static inline pte_t pfn_pte(unsigned long page_nr, pgprot_t pgprot)
148{
149 return __pte((((phys_addr_t)page_nr << PAGE_SHIFT) |
150 pgprot_val(pgprot)) & __supported_pte_mask);
151}
152
153static inline pmd_t pfn_pmd(unsigned long page_nr, pgprot_t pgprot)
154{
155 return __pmd((((phys_addr_t)page_nr << PAGE_SHIFT) |
156 pgprot_val(pgprot)) & __supported_pte_mask);
157}
158
38472311
IM
159static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
160{
161 pteval_t val = pte_val(pte);
162
163 /*
164 * Chop off the NX bit (if present), and add the NX portion of
165 * the newprot (if present):
166 */
167 val &= _PAGE_CHG_MASK & ~_PAGE_NX;
168 val |= pgprot_val(newprot) & __supported_pte_mask;
169
170 return __pte(val);
171}
172
4614139c
JF
173#endif /* __ASSEMBLY__ */
174
96a388de
TG
175#ifdef CONFIG_X86_32
176# include "pgtable_32.h"
177#else
178# include "pgtable_64.h"
179#endif
6c386655 180
195466dc
JF
181#ifndef __ASSEMBLY__
182
183#ifndef CONFIG_PARAVIRT
184/*
185 * Rules for using pte_update - it must be called after any PTE update which
186 * has not been done using the set_pte / clear_pte interfaces. It is used by
187 * shadow mode hypervisors to resynchronize the shadow page tables. Kernel PTE
188 * updates should either be sets, clears, or set_pte_atomic for P->P
189 * transitions, which means this hook should only be called for user PTEs.
190 * This hook implies a P->P protection or access change has taken place, which
191 * requires a subsequent TLB flush. The notification can optionally be delayed
192 * until the TLB flush event by using the pte_update_defer form of the
193 * interface, but care must be taken to assure that the flush happens while
194 * still holding the same page table lock so that the shadow and primary pages
195 * do not become out of sync on SMP.
196 */
197#define pte_update(mm, addr, ptep) do { } while (0)
198#define pte_update_defer(mm, addr, ptep) do { } while (0)
199#endif
200
201/* local pte updates need not use xchg for locking */
202static inline pte_t native_local_ptep_get_and_clear(pte_t *ptep)
203{
204 pte_t res = *ptep;
205
206 /* Pure native function needs no input for mm, addr */
207 native_pte_clear(NULL, 0, ptep);
208 return res;
209}
210
211/*
212 * We only update the dirty/accessed state if we set
213 * the dirty bit by hand in the kernel, since the hardware
214 * will do the accessed bit for us, and we don't want to
215 * race with other CPU's that might be updating the dirty
216 * bit at the same time.
217 */
218#define __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
219#define ptep_set_access_flags(vma, address, ptep, entry, dirty) \
220({ \
221 int __changed = !pte_same(*(ptep), entry); \
222 if (__changed && dirty) { \
223 *ptep = entry; \
224 pte_update_defer((vma)->vm_mm, (address), (ptep)); \
225 flush_tlb_page(vma, address); \
226 } \
227 __changed; \
228})
229
230#define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
231#define ptep_test_and_clear_young(vma, addr, ptep) ({ \
232 int __ret = 0; \
233 if (pte_young(*(ptep))) \
234 __ret = test_and_clear_bit(_PAGE_BIT_ACCESSED, \
235 &(ptep)->pte); \
236 if (__ret) \
237 pte_update((vma)->vm_mm, addr, ptep); \
238 __ret; \
239})
240
241#define __HAVE_ARCH_PTEP_CLEAR_YOUNG_FLUSH
242#define ptep_clear_flush_young(vma, address, ptep) \
243({ \
244 int __young; \
245 __young = ptep_test_and_clear_young((vma), (address), (ptep)); \
246 if (__young) \
247 flush_tlb_page(vma, address); \
248 __young; \
249})
250
251#define __HAVE_ARCH_PTEP_GET_AND_CLEAR
252static inline pte_t ptep_get_and_clear(struct mm_struct *mm, unsigned long addr, pte_t *ptep)
253{
254 pte_t pte = native_ptep_get_and_clear(ptep);
255 pte_update(mm, addr, ptep);
256 return pte;
257}
258
259#define __HAVE_ARCH_PTEP_GET_AND_CLEAR_FULL
260static inline pte_t ptep_get_and_clear_full(struct mm_struct *mm, unsigned long addr, pte_t *ptep, int full)
261{
262 pte_t pte;
263 if (full) {
264 /*
265 * Full address destruction in progress; paravirt does not
266 * care about updates and native needs no locking
267 */
268 pte = native_local_ptep_get_and_clear(ptep);
269 } else {
270 pte = ptep_get_and_clear(mm, addr, ptep);
271 }
272 return pte;
273}
274
275#define __HAVE_ARCH_PTEP_SET_WRPROTECT
276static inline void ptep_set_wrprotect(struct mm_struct *mm, unsigned long addr, pte_t *ptep)
277{
278 clear_bit(_PAGE_BIT_RW, &ptep->pte);
279 pte_update(mm, addr, ptep);
280}
281
282#ifndef CONFIG_PARAVIRT
283#define pte_clear(mm, addr, ptep) native_pte_clear(mm, addr, ptep)
284#endif /* !CONFIG_PARAVIRT */
285
286#include <asm-generic/pgtable.h>
287#endif /* __ASSEMBLY__ */
288
6c386655 289#endif /* _ASM_X86_PGTABLE_H */