GNU Linux-libre 4.14.328-gnu1
[releases.git] / arch / x86 / include / asm / pgtable.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_PGTABLE_H
3 #define _ASM_X86_PGTABLE_H
4
5 #include <linux/mem_encrypt.h>
6 #include <asm/page.h>
7 #include <asm/pgtable_types.h>
8
9 /*
10  * Macro to mark a page protection value as UC-
11  */
12 #define pgprot_noncached(prot)                                          \
13         ((boot_cpu_data.x86 > 3)                                        \
14          ? (__pgprot(pgprot_val(prot) |                                 \
15                      cachemode2protval(_PAGE_CACHE_MODE_UC_MINUS)))     \
16          : (prot))
17
18 /*
19  * Macros to add or remove encryption attribute
20  */
21 #define pgprot_encrypted(prot)  __pgprot(__sme_set(pgprot_val(prot)))
22 #define pgprot_decrypted(prot)  __pgprot(__sme_clr(pgprot_val(prot)))
23
24 #ifndef __ASSEMBLY__
25 #include <asm/x86_init.h>
26
27 extern pgd_t early_top_pgt[PTRS_PER_PGD];
28 int __init __early_make_pgtable(unsigned long address, pmdval_t pmd);
29
30 void ptdump_walk_pgd_level(struct seq_file *m, pgd_t *pgd);
31 void ptdump_walk_pgd_level_debugfs(struct seq_file *m, pgd_t *pgd, bool user);
32 void ptdump_walk_pgd_level_checkwx(void);
33
34 #ifdef CONFIG_DEBUG_WX
35 #define debug_checkwx() ptdump_walk_pgd_level_checkwx()
36 #else
37 #define debug_checkwx() do { } while (0)
38 #endif
39
40 /*
41  * ZERO_PAGE is a global shared page that is always zero: used
42  * for zero-mapped memory areas etc..
43  */
44 extern unsigned long empty_zero_page[PAGE_SIZE / sizeof(unsigned long)]
45         __visible;
46 #define ZERO_PAGE(vaddr) (virt_to_page(empty_zero_page))
47
48 extern spinlock_t pgd_lock;
49 extern struct list_head pgd_list;
50
51 extern struct mm_struct *pgd_page_get_mm(struct page *page);
52
53 extern pmdval_t early_pmd_flags;
54
55 #ifdef CONFIG_PARAVIRT
56 #include <asm/paravirt.h>
57 #else  /* !CONFIG_PARAVIRT */
58 #define set_pte(ptep, pte)              native_set_pte(ptep, pte)
59 #define set_pte_at(mm, addr, ptep, pte) native_set_pte_at(mm, addr, ptep, pte)
60
61 #define set_pte_atomic(ptep, pte)                                       \
62         native_set_pte_atomic(ptep, pte)
63
64 #define set_pmd(pmdp, pmd)              native_set_pmd(pmdp, pmd)
65
66 #ifndef __PAGETABLE_P4D_FOLDED
67 #define set_pgd(pgdp, pgd)              native_set_pgd(pgdp, pgd)
68 #define pgd_clear(pgd)                  native_pgd_clear(pgd)
69 #endif
70
71 #ifndef set_p4d
72 # define set_p4d(p4dp, p4d)             native_set_p4d(p4dp, p4d)
73 #endif
74
75 #ifndef __PAGETABLE_PUD_FOLDED
76 #define p4d_clear(p4d)                  native_p4d_clear(p4d)
77 #endif
78
79 #ifndef set_pud
80 # define set_pud(pudp, pud)             native_set_pud(pudp, pud)
81 #endif
82
83 #ifndef __PAGETABLE_PUD_FOLDED
84 #define pud_clear(pud)                  native_pud_clear(pud)
85 #endif
86
87 #define pte_clear(mm, addr, ptep)       native_pte_clear(mm, addr, ptep)
88 #define pmd_clear(pmd)                  native_pmd_clear(pmd)
89
90 #define pgd_val(x)      native_pgd_val(x)
91 #define __pgd(x)        native_make_pgd(x)
92
93 #ifndef __PAGETABLE_P4D_FOLDED
94 #define p4d_val(x)      native_p4d_val(x)
95 #define __p4d(x)        native_make_p4d(x)
96 #endif
97
98 #ifndef __PAGETABLE_PUD_FOLDED
99 #define pud_val(x)      native_pud_val(x)
100 #define __pud(x)        native_make_pud(x)
101 #endif
102
103 #ifndef __PAGETABLE_PMD_FOLDED
104 #define pmd_val(x)      native_pmd_val(x)
105 #define __pmd(x)        native_make_pmd(x)
106 #endif
107
108 #define pte_val(x)      native_pte_val(x)
109 #define __pte(x)        native_make_pte(x)
110
111 #define arch_end_context_switch(prev)   do {} while(0)
112
113 #endif  /* CONFIG_PARAVIRT */
114
115 /*
116  * The following only work if pte_present() is true.
117  * Undefined behaviour if not..
118  */
119 static inline int pte_dirty(pte_t pte)
120 {
121         return pte_flags(pte) & _PAGE_DIRTY;
122 }
123
124
125 static inline u32 read_pkru(void)
126 {
127         if (boot_cpu_has(X86_FEATURE_OSPKE))
128                 return __read_pkru();
129         return 0;
130 }
131
132 static inline void write_pkru(u32 pkru)
133 {
134         if (boot_cpu_has(X86_FEATURE_OSPKE))
135                 __write_pkru(pkru);
136 }
137
138 static inline int pte_young(pte_t pte)
139 {
140         return pte_flags(pte) & _PAGE_ACCESSED;
141 }
142
143 static inline int pmd_dirty(pmd_t pmd)
144 {
145         return pmd_flags(pmd) & _PAGE_DIRTY;
146 }
147
148 static inline int pmd_young(pmd_t pmd)
149 {
150         return pmd_flags(pmd) & _PAGE_ACCESSED;
151 }
152
153 static inline int pud_dirty(pud_t pud)
154 {
155         return pud_flags(pud) & _PAGE_DIRTY;
156 }
157
158 static inline int pud_young(pud_t pud)
159 {
160         return pud_flags(pud) & _PAGE_ACCESSED;
161 }
162
163 static inline int pte_write(pte_t pte)
164 {
165         return pte_flags(pte) & _PAGE_RW;
166 }
167
168 static inline int pte_huge(pte_t pte)
169 {
170         return pte_flags(pte) & _PAGE_PSE;
171 }
172
173 static inline int pte_global(pte_t pte)
174 {
175         return pte_flags(pte) & _PAGE_GLOBAL;
176 }
177
178 static inline int pte_exec(pte_t pte)
179 {
180         return !(pte_flags(pte) & _PAGE_NX);
181 }
182
183 static inline int pte_special(pte_t pte)
184 {
185         return pte_flags(pte) & _PAGE_SPECIAL;
186 }
187
188 /* Entries that were set to PROT_NONE are inverted */
189
190 static inline u64 protnone_mask(u64 val);
191
192 static inline unsigned long pte_pfn(pte_t pte)
193 {
194         phys_addr_t pfn = pte_val(pte);
195         pfn ^= protnone_mask(pfn);
196         return (pfn & PTE_PFN_MASK) >> PAGE_SHIFT;
197 }
198
199 static inline unsigned long pmd_pfn(pmd_t pmd)
200 {
201         phys_addr_t pfn = pmd_val(pmd);
202         pfn ^= protnone_mask(pfn);
203         return (pfn & pmd_pfn_mask(pmd)) >> PAGE_SHIFT;
204 }
205
206 static inline unsigned long pud_pfn(pud_t pud)
207 {
208         phys_addr_t pfn = pud_val(pud);
209         pfn ^= protnone_mask(pfn);
210         return (pfn & pud_pfn_mask(pud)) >> PAGE_SHIFT;
211 }
212
213 static inline unsigned long p4d_pfn(p4d_t p4d)
214 {
215         return (p4d_val(p4d) & p4d_pfn_mask(p4d)) >> PAGE_SHIFT;
216 }
217
218 static inline unsigned long pgd_pfn(pgd_t pgd)
219 {
220         return (pgd_val(pgd) & PTE_PFN_MASK) >> PAGE_SHIFT;
221 }
222
223 static inline int p4d_large(p4d_t p4d)
224 {
225         /* No 512 GiB pages yet */
226         return 0;
227 }
228
229 #define pte_page(pte)   pfn_to_page(pte_pfn(pte))
230
231 static inline int pmd_large(pmd_t pte)
232 {
233         return pmd_flags(pte) & _PAGE_PSE;
234 }
235
236 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
237 /* NOTE: when predicate huge page, consider also pmd_devmap, or use pmd_large */
238 static inline int pmd_trans_huge(pmd_t pmd)
239 {
240         return (pmd_val(pmd) & (_PAGE_PSE|_PAGE_DEVMAP)) == _PAGE_PSE;
241 }
242
243 #ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
244 static inline int pud_trans_huge(pud_t pud)
245 {
246         return (pud_val(pud) & (_PAGE_PSE|_PAGE_DEVMAP)) == _PAGE_PSE;
247 }
248 #endif
249
250 #define has_transparent_hugepage has_transparent_hugepage
251 static inline int has_transparent_hugepage(void)
252 {
253         return boot_cpu_has(X86_FEATURE_PSE);
254 }
255
256 #ifdef __HAVE_ARCH_PTE_DEVMAP
257 static inline int pmd_devmap(pmd_t pmd)
258 {
259         return !!(pmd_val(pmd) & _PAGE_DEVMAP);
260 }
261
262 #ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
263 static inline int pud_devmap(pud_t pud)
264 {
265         return !!(pud_val(pud) & _PAGE_DEVMAP);
266 }
267 #else
268 static inline int pud_devmap(pud_t pud)
269 {
270         return 0;
271 }
272 #endif
273
274 static inline int pgd_devmap(pgd_t pgd)
275 {
276         return 0;
277 }
278 #endif
279 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
280
281 static inline pte_t pte_set_flags(pte_t pte, pteval_t set)
282 {
283         pteval_t v = native_pte_val(pte);
284
285         return native_make_pte(v | set);
286 }
287
288 static inline pte_t pte_clear_flags(pte_t pte, pteval_t clear)
289 {
290         pteval_t v = native_pte_val(pte);
291
292         return native_make_pte(v & ~clear);
293 }
294
295 static inline pte_t pte_mkclean(pte_t pte)
296 {
297         return pte_clear_flags(pte, _PAGE_DIRTY);
298 }
299
300 static inline pte_t pte_mkold(pte_t pte)
301 {
302         return pte_clear_flags(pte, _PAGE_ACCESSED);
303 }
304
305 static inline pte_t pte_wrprotect(pte_t pte)
306 {
307         return pte_clear_flags(pte, _PAGE_RW);
308 }
309
310 static inline pte_t pte_mkexec(pte_t pte)
311 {
312         return pte_clear_flags(pte, _PAGE_NX);
313 }
314
315 static inline pte_t pte_mkdirty(pte_t pte)
316 {
317         return pte_set_flags(pte, _PAGE_DIRTY | _PAGE_SOFT_DIRTY);
318 }
319
320 static inline pte_t pte_mkyoung(pte_t pte)
321 {
322         return pte_set_flags(pte, _PAGE_ACCESSED);
323 }
324
325 static inline pte_t pte_mkwrite(pte_t pte)
326 {
327         return pte_set_flags(pte, _PAGE_RW);
328 }
329
330 static inline pte_t pte_mkhuge(pte_t pte)
331 {
332         return pte_set_flags(pte, _PAGE_PSE);
333 }
334
335 static inline pte_t pte_clrhuge(pte_t pte)
336 {
337         return pte_clear_flags(pte, _PAGE_PSE);
338 }
339
340 static inline pte_t pte_mkglobal(pte_t pte)
341 {
342         return pte_set_flags(pte, _PAGE_GLOBAL);
343 }
344
345 static inline pte_t pte_clrglobal(pte_t pte)
346 {
347         return pte_clear_flags(pte, _PAGE_GLOBAL);
348 }
349
350 static inline pte_t pte_mkspecial(pte_t pte)
351 {
352         return pte_set_flags(pte, _PAGE_SPECIAL);
353 }
354
355 static inline pte_t pte_mkdevmap(pte_t pte)
356 {
357         return pte_set_flags(pte, _PAGE_SPECIAL|_PAGE_DEVMAP);
358 }
359
360 static inline pmd_t pmd_set_flags(pmd_t pmd, pmdval_t set)
361 {
362         pmdval_t v = native_pmd_val(pmd);
363
364         return native_make_pmd(v | set);
365 }
366
367 static inline pmd_t pmd_clear_flags(pmd_t pmd, pmdval_t clear)
368 {
369         pmdval_t v = native_pmd_val(pmd);
370
371         return native_make_pmd(v & ~clear);
372 }
373
374 static inline pmd_t pmd_mkold(pmd_t pmd)
375 {
376         return pmd_clear_flags(pmd, _PAGE_ACCESSED);
377 }
378
379 static inline pmd_t pmd_mkclean(pmd_t pmd)
380 {
381         return pmd_clear_flags(pmd, _PAGE_DIRTY);
382 }
383
384 static inline pmd_t pmd_wrprotect(pmd_t pmd)
385 {
386         return pmd_clear_flags(pmd, _PAGE_RW);
387 }
388
389 static inline pmd_t pmd_mkdirty(pmd_t pmd)
390 {
391         return pmd_set_flags(pmd, _PAGE_DIRTY | _PAGE_SOFT_DIRTY);
392 }
393
394 static inline pmd_t pmd_mkdevmap(pmd_t pmd)
395 {
396         return pmd_set_flags(pmd, _PAGE_DEVMAP);
397 }
398
399 static inline pmd_t pmd_mkhuge(pmd_t pmd)
400 {
401         return pmd_set_flags(pmd, _PAGE_PSE);
402 }
403
404 static inline pmd_t pmd_mkyoung(pmd_t pmd)
405 {
406         return pmd_set_flags(pmd, _PAGE_ACCESSED);
407 }
408
409 static inline pmd_t pmd_mkwrite(pmd_t pmd)
410 {
411         return pmd_set_flags(pmd, _PAGE_RW);
412 }
413
414 static inline pud_t pud_set_flags(pud_t pud, pudval_t set)
415 {
416         pudval_t v = native_pud_val(pud);
417
418         return native_make_pud(v | set);
419 }
420
421 static inline pud_t pud_clear_flags(pud_t pud, pudval_t clear)
422 {
423         pudval_t v = native_pud_val(pud);
424
425         return native_make_pud(v & ~clear);
426 }
427
428 static inline pud_t pud_mkold(pud_t pud)
429 {
430         return pud_clear_flags(pud, _PAGE_ACCESSED);
431 }
432
433 static inline pud_t pud_mkclean(pud_t pud)
434 {
435         return pud_clear_flags(pud, _PAGE_DIRTY);
436 }
437
438 static inline pud_t pud_wrprotect(pud_t pud)
439 {
440         return pud_clear_flags(pud, _PAGE_RW);
441 }
442
443 static inline pud_t pud_mkdirty(pud_t pud)
444 {
445         return pud_set_flags(pud, _PAGE_DIRTY | _PAGE_SOFT_DIRTY);
446 }
447
448 static inline pud_t pud_mkdevmap(pud_t pud)
449 {
450         return pud_set_flags(pud, _PAGE_DEVMAP);
451 }
452
453 static inline pud_t pud_mkhuge(pud_t pud)
454 {
455         return pud_set_flags(pud, _PAGE_PSE);
456 }
457
458 static inline pud_t pud_mkyoung(pud_t pud)
459 {
460         return pud_set_flags(pud, _PAGE_ACCESSED);
461 }
462
463 static inline pud_t pud_mkwrite(pud_t pud)
464 {
465         return pud_set_flags(pud, _PAGE_RW);
466 }
467
468 #ifdef CONFIG_HAVE_ARCH_SOFT_DIRTY
469 static inline int pte_soft_dirty(pte_t pte)
470 {
471         return pte_flags(pte) & _PAGE_SOFT_DIRTY;
472 }
473
474 static inline int pmd_soft_dirty(pmd_t pmd)
475 {
476         return pmd_flags(pmd) & _PAGE_SOFT_DIRTY;
477 }
478
479 static inline int pud_soft_dirty(pud_t pud)
480 {
481         return pud_flags(pud) & _PAGE_SOFT_DIRTY;
482 }
483
484 static inline pte_t pte_mksoft_dirty(pte_t pte)
485 {
486         return pte_set_flags(pte, _PAGE_SOFT_DIRTY);
487 }
488
489 static inline pmd_t pmd_mksoft_dirty(pmd_t pmd)
490 {
491         return pmd_set_flags(pmd, _PAGE_SOFT_DIRTY);
492 }
493
494 static inline pud_t pud_mksoft_dirty(pud_t pud)
495 {
496         return pud_set_flags(pud, _PAGE_SOFT_DIRTY);
497 }
498
499 static inline pte_t pte_clear_soft_dirty(pte_t pte)
500 {
501         return pte_clear_flags(pte, _PAGE_SOFT_DIRTY);
502 }
503
504 static inline pmd_t pmd_clear_soft_dirty(pmd_t pmd)
505 {
506         return pmd_clear_flags(pmd, _PAGE_SOFT_DIRTY);
507 }
508
509 static inline pud_t pud_clear_soft_dirty(pud_t pud)
510 {
511         return pud_clear_flags(pud, _PAGE_SOFT_DIRTY);
512 }
513
514 #endif /* CONFIG_HAVE_ARCH_SOFT_DIRTY */
515
516 /*
517  * Mask out unsupported bits in a present pgprot.  Non-present pgprots
518  * can use those bits for other purposes, so leave them be.
519  */
520 static inline pgprotval_t massage_pgprot(pgprot_t pgprot)
521 {
522         pgprotval_t protval = pgprot_val(pgprot);
523
524         if (protval & _PAGE_PRESENT)
525                 protval &= __supported_pte_mask;
526
527         return protval;
528 }
529
530 static inline pte_t pfn_pte(unsigned long page_nr, pgprot_t pgprot)
531 {
532         phys_addr_t pfn = (phys_addr_t)page_nr << PAGE_SHIFT;
533         pfn ^= protnone_mask(pgprot_val(pgprot));
534         pfn &= PTE_PFN_MASK;
535         return __pte(pfn | massage_pgprot(pgprot));
536 }
537
538 static inline pmd_t pfn_pmd(unsigned long page_nr, pgprot_t pgprot)
539 {
540         phys_addr_t pfn = (phys_addr_t)page_nr << PAGE_SHIFT;
541         pfn ^= protnone_mask(pgprot_val(pgprot));
542         pfn &= PHYSICAL_PMD_PAGE_MASK;
543         return __pmd(pfn | massage_pgprot(pgprot));
544 }
545
546 static inline pud_t pfn_pud(unsigned long page_nr, pgprot_t pgprot)
547 {
548         phys_addr_t pfn = (phys_addr_t)page_nr << PAGE_SHIFT;
549         pfn ^= protnone_mask(pgprot_val(pgprot));
550         pfn &= PHYSICAL_PUD_PAGE_MASK;
551         return __pud(pfn | massage_pgprot(pgprot));
552 }
553
554 static inline pmd_t pmd_mknotpresent(pmd_t pmd)
555 {
556         return pfn_pmd(pmd_pfn(pmd),
557                       __pgprot(pmd_flags(pmd) & ~(_PAGE_PRESENT|_PAGE_PROTNONE)));
558 }
559
560 static inline pud_t pud_mknotpresent(pud_t pud)
561 {
562         return pfn_pud(pud_pfn(pud),
563               __pgprot(pud_flags(pud) & ~(_PAGE_PRESENT|_PAGE_PROTNONE)));
564 }
565
566 static inline u64 flip_protnone_guard(u64 oldval, u64 val, u64 mask);
567
568 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
569 {
570         pteval_t val = pte_val(pte), oldval = val;
571
572         /*
573          * Chop off the NX bit (if present), and add the NX portion of
574          * the newprot (if present):
575          */
576         val &= _PAGE_CHG_MASK;
577         val |= massage_pgprot(newprot) & ~_PAGE_CHG_MASK;
578         val = flip_protnone_guard(oldval, val, PTE_PFN_MASK);
579         return __pte(val);
580 }
581
582 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
583 {
584         pmdval_t val = pmd_val(pmd), oldval = val;
585
586         val &= _HPAGE_CHG_MASK;
587         val |= massage_pgprot(newprot) & ~_HPAGE_CHG_MASK;
588         val = flip_protnone_guard(oldval, val, PHYSICAL_PMD_PAGE_MASK);
589         return __pmd(val);
590 }
591
592 /*
593  * mprotect needs to preserve PAT and encryption bits when updating
594  * vm_page_prot
595  */
596 #define pgprot_modify pgprot_modify
597 static inline pgprot_t pgprot_modify(pgprot_t oldprot, pgprot_t newprot)
598 {
599         pgprotval_t preservebits = pgprot_val(oldprot) & _PAGE_CHG_MASK;
600         pgprotval_t addbits = pgprot_val(newprot) & ~_PAGE_CHG_MASK;
601         return __pgprot(preservebits | addbits);
602 }
603
604 #define pte_pgprot(x) __pgprot(pte_flags(x))
605 #define pmd_pgprot(x) __pgprot(pmd_flags(x))
606 #define pud_pgprot(x) __pgprot(pud_flags(x))
607 #define p4d_pgprot(x) __pgprot(p4d_flags(x))
608
609 #define canon_pgprot(p) __pgprot(massage_pgprot(p))
610
611 static inline int is_new_memtype_allowed(u64 paddr, unsigned long size,
612                                          enum page_cache_mode pcm,
613                                          enum page_cache_mode new_pcm)
614 {
615         /*
616          * PAT type is always WB for untracked ranges, so no need to check.
617          */
618         if (x86_platform.is_untracked_pat_range(paddr, paddr + size))
619                 return 1;
620
621         /*
622          * Certain new memtypes are not allowed with certain
623          * requested memtype:
624          * - request is uncached, return cannot be write-back
625          * - request is write-combine, return cannot be write-back
626          * - request is write-through, return cannot be write-back
627          * - request is write-through, return cannot be write-combine
628          */
629         if ((pcm == _PAGE_CACHE_MODE_UC_MINUS &&
630              new_pcm == _PAGE_CACHE_MODE_WB) ||
631             (pcm == _PAGE_CACHE_MODE_WC &&
632              new_pcm == _PAGE_CACHE_MODE_WB) ||
633             (pcm == _PAGE_CACHE_MODE_WT &&
634              new_pcm == _PAGE_CACHE_MODE_WB) ||
635             (pcm == _PAGE_CACHE_MODE_WT &&
636              new_pcm == _PAGE_CACHE_MODE_WC)) {
637                 return 0;
638         }
639
640         return 1;
641 }
642
643 pmd_t *populate_extra_pmd(unsigned long vaddr);
644 pte_t *populate_extra_pte(unsigned long vaddr);
645 #endif  /* __ASSEMBLY__ */
646
647 #ifdef CONFIG_X86_32
648 # include <asm/pgtable_32.h>
649 #else
650 # include <asm/pgtable_64.h>
651 #endif
652
653 #ifndef __ASSEMBLY__
654 #include <linux/mm_types.h>
655 #include <linux/mmdebug.h>
656 #include <linux/log2.h>
657 #include <asm/fixmap.h>
658
659 static inline int pte_none(pte_t pte)
660 {
661         return !(pte.pte & ~(_PAGE_KNL_ERRATUM_MASK));
662 }
663
664 #define __HAVE_ARCH_PTE_SAME
665 static inline int pte_same(pte_t a, pte_t b)
666 {
667         return a.pte == b.pte;
668 }
669
670 static inline int pte_present(pte_t a)
671 {
672         return pte_flags(a) & (_PAGE_PRESENT | _PAGE_PROTNONE);
673 }
674
675 #ifdef __HAVE_ARCH_PTE_DEVMAP
676 static inline int pte_devmap(pte_t a)
677 {
678         return (pte_flags(a) & _PAGE_DEVMAP) == _PAGE_DEVMAP;
679 }
680 #endif
681
682 #define pte_accessible pte_accessible
683 static inline bool pte_accessible(struct mm_struct *mm, pte_t a)
684 {
685         if (pte_flags(a) & _PAGE_PRESENT)
686                 return true;
687
688         if ((pte_flags(a) & _PAGE_PROTNONE) &&
689                         mm_tlb_flush_pending(mm))
690                 return true;
691
692         return false;
693 }
694
695 static inline int pmd_present(pmd_t pmd)
696 {
697         /*
698          * Checking for _PAGE_PSE is needed too because
699          * split_huge_page will temporarily clear the present bit (but
700          * the _PAGE_PSE flag will remain set at all times while the
701          * _PAGE_PRESENT bit is clear).
702          */
703         return pmd_flags(pmd) & (_PAGE_PRESENT | _PAGE_PROTNONE | _PAGE_PSE);
704 }
705
706 #ifdef CONFIG_NUMA_BALANCING
707 /*
708  * These work without NUMA balancing but the kernel does not care. See the
709  * comment in include/asm-generic/pgtable.h
710  */
711 static inline int pte_protnone(pte_t pte)
712 {
713         return (pte_flags(pte) & (_PAGE_PROTNONE | _PAGE_PRESENT))
714                 == _PAGE_PROTNONE;
715 }
716
717 static inline int pmd_protnone(pmd_t pmd)
718 {
719         return (pmd_flags(pmd) & (_PAGE_PROTNONE | _PAGE_PRESENT))
720                 == _PAGE_PROTNONE;
721 }
722 #endif /* CONFIG_NUMA_BALANCING */
723
724 static inline int pmd_none(pmd_t pmd)
725 {
726         /* Only check low word on 32-bit platforms, since it might be
727            out of sync with upper half. */
728         unsigned long val = native_pmd_val(pmd);
729         return (val & ~_PAGE_KNL_ERRATUM_MASK) == 0;
730 }
731
732 static inline unsigned long pmd_page_vaddr(pmd_t pmd)
733 {
734         return (unsigned long)__va(pmd_val(pmd) & pmd_pfn_mask(pmd));
735 }
736
737 /*
738  * Currently stuck as a macro due to indirect forward reference to
739  * linux/mmzone.h's __section_mem_map_addr() definition:
740  */
741 #define pmd_page(pmd)   pfn_to_page(pmd_pfn(pmd))
742
743 /*
744  * the pmd page can be thought of an array like this: pmd_t[PTRS_PER_PMD]
745  *
746  * this macro returns the index of the entry in the pmd page which would
747  * control the given virtual address
748  */
749 static inline unsigned long pmd_index(unsigned long address)
750 {
751         return (address >> PMD_SHIFT) & (PTRS_PER_PMD - 1);
752 }
753
754 /*
755  * Conversion functions: convert a page and protection to a page entry,
756  * and a page entry and page directory to the page they refer to.
757  *
758  * (Currently stuck as a macro because of indirect forward reference
759  * to linux/mm.h:page_to_nid())
760  */
761 #define mk_pte(page, pgprot)   pfn_pte(page_to_pfn(page), (pgprot))
762
763 /*
764  * the pte page can be thought of an array like this: pte_t[PTRS_PER_PTE]
765  *
766  * this function returns the index of the entry in the pte page which would
767  * control the given virtual address
768  */
769 static inline unsigned long pte_index(unsigned long address)
770 {
771         return (address >> PAGE_SHIFT) & (PTRS_PER_PTE - 1);
772 }
773
774 static inline pte_t *pte_offset_kernel(pmd_t *pmd, unsigned long address)
775 {
776         return (pte_t *)pmd_page_vaddr(*pmd) + pte_index(address);
777 }
778
779 static inline int pmd_bad(pmd_t pmd)
780 {
781         return (pmd_flags(pmd) & ~_PAGE_USER) != _KERNPG_TABLE;
782 }
783
784 static inline unsigned long pages_to_mb(unsigned long npg)
785 {
786         return npg >> (20 - PAGE_SHIFT);
787 }
788
789 #if CONFIG_PGTABLE_LEVELS > 2
790 static inline int pud_none(pud_t pud)
791 {
792         return (native_pud_val(pud) & ~(_PAGE_KNL_ERRATUM_MASK)) == 0;
793 }
794
795 static inline int pud_present(pud_t pud)
796 {
797         return pud_flags(pud) & _PAGE_PRESENT;
798 }
799
800 static inline unsigned long pud_page_vaddr(pud_t pud)
801 {
802         return (unsigned long)__va(pud_val(pud) & pud_pfn_mask(pud));
803 }
804
805 /*
806  * Currently stuck as a macro due to indirect forward reference to
807  * linux/mmzone.h's __section_mem_map_addr() definition:
808  */
809 #define pud_page(pud)   pfn_to_page(pud_pfn(pud))
810
811 /* Find an entry in the second-level page table.. */
812 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long address)
813 {
814         return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(address);
815 }
816
817 static inline int pud_large(pud_t pud)
818 {
819         return (pud_val(pud) & (_PAGE_PSE | _PAGE_PRESENT)) ==
820                 (_PAGE_PSE | _PAGE_PRESENT);
821 }
822
823 static inline int pud_bad(pud_t pud)
824 {
825         return (pud_flags(pud) & ~(_KERNPG_TABLE | _PAGE_USER)) != 0;
826 }
827 #else
828 static inline int pud_large(pud_t pud)
829 {
830         return 0;
831 }
832 #endif  /* CONFIG_PGTABLE_LEVELS > 2 */
833
834 static inline unsigned long pud_index(unsigned long address)
835 {
836         return (address >> PUD_SHIFT) & (PTRS_PER_PUD - 1);
837 }
838
839 #if CONFIG_PGTABLE_LEVELS > 3
840 static inline int p4d_none(p4d_t p4d)
841 {
842         return (native_p4d_val(p4d) & ~(_PAGE_KNL_ERRATUM_MASK)) == 0;
843 }
844
845 static inline int p4d_present(p4d_t p4d)
846 {
847         return p4d_flags(p4d) & _PAGE_PRESENT;
848 }
849
850 static inline unsigned long p4d_page_vaddr(p4d_t p4d)
851 {
852         return (unsigned long)__va(p4d_val(p4d) & p4d_pfn_mask(p4d));
853 }
854
855 /*
856  * Currently stuck as a macro due to indirect forward reference to
857  * linux/mmzone.h's __section_mem_map_addr() definition:
858  */
859 #define p4d_page(p4d)   pfn_to_page(p4d_pfn(p4d))
860
861 /* Find an entry in the third-level page table.. */
862 static inline pud_t *pud_offset(p4d_t *p4d, unsigned long address)
863 {
864         return (pud_t *)p4d_page_vaddr(*p4d) + pud_index(address);
865 }
866
867 static inline int p4d_bad(p4d_t p4d)
868 {
869         unsigned long ignore_flags = _KERNPG_TABLE | _PAGE_USER;
870
871         if (IS_ENABLED(CONFIG_PAGE_TABLE_ISOLATION))
872                 ignore_flags |= _PAGE_NX;
873
874         return (p4d_flags(p4d) & ~ignore_flags) != 0;
875 }
876 #endif  /* CONFIG_PGTABLE_LEVELS > 3 */
877
878 static inline unsigned long p4d_index(unsigned long address)
879 {
880         return (address >> P4D_SHIFT) & (PTRS_PER_P4D - 1);
881 }
882
883 #if CONFIG_PGTABLE_LEVELS > 4
884 static inline int pgd_present(pgd_t pgd)
885 {
886         return pgd_flags(pgd) & _PAGE_PRESENT;
887 }
888
889 static inline unsigned long pgd_page_vaddr(pgd_t pgd)
890 {
891         return (unsigned long)__va((unsigned long)pgd_val(pgd) & PTE_PFN_MASK);
892 }
893
894 /*
895  * Currently stuck as a macro due to indirect forward reference to
896  * linux/mmzone.h's __section_mem_map_addr() definition:
897  */
898 #define pgd_page(pgd)   pfn_to_page(pgd_pfn(pgd))
899
900 /* to find an entry in a page-table-directory. */
901 static inline p4d_t *p4d_offset(pgd_t *pgd, unsigned long address)
902 {
903         return (p4d_t *)pgd_page_vaddr(*pgd) + p4d_index(address);
904 }
905
906 static inline int pgd_bad(pgd_t pgd)
907 {
908         unsigned long ignore_flags = _PAGE_USER;
909
910         if (IS_ENABLED(CONFIG_PAGE_TABLE_ISOLATION))
911                 ignore_flags |= _PAGE_NX;
912
913         return (pgd_flags(pgd) & ~ignore_flags) != _KERNPG_TABLE;
914 }
915
916 static inline int pgd_none(pgd_t pgd)
917 {
918         /*
919          * There is no need to do a workaround for the KNL stray
920          * A/D bit erratum here.  PGDs only point to page tables
921          * except on 32-bit non-PAE which is not supported on
922          * KNL.
923          */
924         return !native_pgd_val(pgd);
925 }
926 #endif  /* CONFIG_PGTABLE_LEVELS > 4 */
927
928 #endif  /* __ASSEMBLY__ */
929
930 /*
931  * the pgd page can be thought of an array like this: pgd_t[PTRS_PER_PGD]
932  *
933  * this macro returns the index of the entry in the pgd page which would
934  * control the given virtual address
935  */
936 #define pgd_index(address) (((address) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
937
938 /*
939  * pgd_offset() returns a (pgd_t *)
940  * pgd_index() is used get the offset into the pgd page's array of pgd_t's;
941  */
942 #define pgd_offset_pgd(pgd, address) (pgd + pgd_index((address)))
943 /*
944  * a shortcut to get a pgd_t in a given mm
945  */
946 #define pgd_offset(mm, address) pgd_offset_pgd((mm)->pgd, (address))
947 /*
948  * a shortcut which implies the use of the kernel's pgd, instead
949  * of a process's
950  */
951 #define pgd_offset_k(address) pgd_offset(&init_mm, (address))
952
953
954 #define KERNEL_PGD_BOUNDARY     pgd_index(PAGE_OFFSET)
955 #define KERNEL_PGD_PTRS         (PTRS_PER_PGD - KERNEL_PGD_BOUNDARY)
956
957 #ifndef __ASSEMBLY__
958
959 extern int direct_gbpages;
960 void init_mem_mapping(void);
961 void early_alloc_pgt_buf(void);
962 extern void memblock_find_dma_reserve(void);
963
964 #ifdef CONFIG_X86_64
965 /* Realmode trampoline initialization. */
966 extern pgd_t trampoline_pgd_entry;
967 static inline void __meminit init_trampoline_default(void)
968 {
969         /* Default trampoline pgd value */
970         trampoline_pgd_entry = init_top_pgt[pgd_index(__PAGE_OFFSET)];
971 }
972 # ifdef CONFIG_RANDOMIZE_MEMORY
973 void __meminit init_trampoline(void);
974 # else
975 #  define init_trampoline init_trampoline_default
976 # endif
977 #else
978 static inline void init_trampoline(void) { }
979 #endif
980
981 /* local pte updates need not use xchg for locking */
982 static inline pte_t native_local_ptep_get_and_clear(pte_t *ptep)
983 {
984         pte_t res = *ptep;
985
986         /* Pure native function needs no input for mm, addr */
987         native_pte_clear(NULL, 0, ptep);
988         return res;
989 }
990
991 static inline pmd_t native_local_pmdp_get_and_clear(pmd_t *pmdp)
992 {
993         pmd_t res = *pmdp;
994
995         native_pmd_clear(pmdp);
996         return res;
997 }
998
999 static inline pud_t native_local_pudp_get_and_clear(pud_t *pudp)
1000 {
1001         pud_t res = *pudp;
1002
1003         native_pud_clear(pudp);
1004         return res;
1005 }
1006
1007 static inline void native_set_pte_at(struct mm_struct *mm, unsigned long addr,
1008                                      pte_t *ptep , pte_t pte)
1009 {
1010         native_set_pte(ptep, pte);
1011 }
1012
1013 static inline void set_pmd_at(struct mm_struct *mm, unsigned long addr,
1014                               pmd_t *pmdp, pmd_t pmd)
1015 {
1016         native_set_pmd(pmdp, pmd);
1017 }
1018
1019 static inline void set_pud_at(struct mm_struct *mm, unsigned long addr,
1020                               pud_t *pudp, pud_t pud)
1021 {
1022         native_set_pud(pudp, pud);
1023 }
1024
1025 /*
1026  * We only update the dirty/accessed state if we set
1027  * the dirty bit by hand in the kernel, since the hardware
1028  * will do the accessed bit for us, and we don't want to
1029  * race with other CPU's that might be updating the dirty
1030  * bit at the same time.
1031  */
1032 struct vm_area_struct;
1033
1034 #define  __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
1035 extern int ptep_set_access_flags(struct vm_area_struct *vma,
1036                                  unsigned long address, pte_t *ptep,
1037                                  pte_t entry, int dirty);
1038
1039 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
1040 extern int ptep_test_and_clear_young(struct vm_area_struct *vma,
1041                                      unsigned long addr, pte_t *ptep);
1042
1043 #define __HAVE_ARCH_PTEP_CLEAR_YOUNG_FLUSH
1044 extern int ptep_clear_flush_young(struct vm_area_struct *vma,
1045                                   unsigned long address, pte_t *ptep);
1046
1047 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
1048 static inline pte_t ptep_get_and_clear(struct mm_struct *mm, unsigned long addr,
1049                                        pte_t *ptep)
1050 {
1051         pte_t pte = native_ptep_get_and_clear(ptep);
1052         return pte;
1053 }
1054
1055 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR_FULL
1056 static inline pte_t ptep_get_and_clear_full(struct mm_struct *mm,
1057                                             unsigned long addr, pte_t *ptep,
1058                                             int full)
1059 {
1060         pte_t pte;
1061         if (full) {
1062                 /*
1063                  * Full address destruction in progress; paravirt does not
1064                  * care about updates and native needs no locking
1065                  */
1066                 pte = native_local_ptep_get_and_clear(ptep);
1067         } else {
1068                 pte = ptep_get_and_clear(mm, addr, ptep);
1069         }
1070         return pte;
1071 }
1072
1073 #define __HAVE_ARCH_PTEP_SET_WRPROTECT
1074 static inline void ptep_set_wrprotect(struct mm_struct *mm,
1075                                       unsigned long addr, pte_t *ptep)
1076 {
1077         clear_bit(_PAGE_BIT_RW, (unsigned long *)&ptep->pte);
1078 }
1079
1080 #define flush_tlb_fix_spurious_fault(vma, address) do { } while (0)
1081
1082 #define mk_pmd(page, pgprot)   pfn_pmd(page_to_pfn(page), (pgprot))
1083
1084 #define  __HAVE_ARCH_PMDP_SET_ACCESS_FLAGS
1085 extern int pmdp_set_access_flags(struct vm_area_struct *vma,
1086                                  unsigned long address, pmd_t *pmdp,
1087                                  pmd_t entry, int dirty);
1088 extern int pudp_set_access_flags(struct vm_area_struct *vma,
1089                                  unsigned long address, pud_t *pudp,
1090                                  pud_t entry, int dirty);
1091
1092 #define __HAVE_ARCH_PMDP_TEST_AND_CLEAR_YOUNG
1093 extern int pmdp_test_and_clear_young(struct vm_area_struct *vma,
1094                                      unsigned long addr, pmd_t *pmdp);
1095 extern int pudp_test_and_clear_young(struct vm_area_struct *vma,
1096                                      unsigned long addr, pud_t *pudp);
1097
1098 #define __HAVE_ARCH_PMDP_CLEAR_YOUNG_FLUSH
1099 extern int pmdp_clear_flush_young(struct vm_area_struct *vma,
1100                                   unsigned long address, pmd_t *pmdp);
1101
1102
1103 #define __HAVE_ARCH_PMD_WRITE
1104 static inline int pmd_write(pmd_t pmd)
1105 {
1106         return pmd_flags(pmd) & _PAGE_RW;
1107 }
1108
1109 #define __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR
1110 static inline pmd_t pmdp_huge_get_and_clear(struct mm_struct *mm, unsigned long addr,
1111                                        pmd_t *pmdp)
1112 {
1113         return native_pmdp_get_and_clear(pmdp);
1114 }
1115
1116 #define __HAVE_ARCH_PUDP_HUGE_GET_AND_CLEAR
1117 static inline pud_t pudp_huge_get_and_clear(struct mm_struct *mm,
1118                                         unsigned long addr, pud_t *pudp)
1119 {
1120         return native_pudp_get_and_clear(pudp);
1121 }
1122
1123 #define __HAVE_ARCH_PMDP_SET_WRPROTECT
1124 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
1125                                       unsigned long addr, pmd_t *pmdp)
1126 {
1127         clear_bit(_PAGE_BIT_RW, (unsigned long *)pmdp);
1128 }
1129
1130 #define pud_write pud_write
1131 static inline int pud_write(pud_t pud)
1132 {
1133         return pud_flags(pud) & _PAGE_RW;
1134 }
1135
1136 /*
1137  * clone_pgd_range(pgd_t *dst, pgd_t *src, int count);
1138  *
1139  *  dst - pointer to pgd range anwhere on a pgd page
1140  *  src - ""
1141  *  count - the number of pgds to copy.
1142  *
1143  * dst and src can be on the same page, but the range must not overlap,
1144  * and must not cross a page boundary.
1145  */
1146 static inline void clone_pgd_range(pgd_t *dst, pgd_t *src, int count)
1147 {
1148         memcpy(dst, src, count * sizeof(pgd_t));
1149 #ifdef CONFIG_PAGE_TABLE_ISOLATION
1150         if (!static_cpu_has(X86_FEATURE_PTI))
1151                 return;
1152         /* Clone the user space pgd as well */
1153         memcpy(kernel_to_user_pgdp(dst), kernel_to_user_pgdp(src),
1154                count * sizeof(pgd_t));
1155 #endif
1156 }
1157
1158 #define PTE_SHIFT ilog2(PTRS_PER_PTE)
1159 static inline int page_level_shift(enum pg_level level)
1160 {
1161         return (PAGE_SHIFT - PTE_SHIFT) + level * PTE_SHIFT;
1162 }
1163 static inline unsigned long page_level_size(enum pg_level level)
1164 {
1165         return 1UL << page_level_shift(level);
1166 }
1167 static inline unsigned long page_level_mask(enum pg_level level)
1168 {
1169         return ~(page_level_size(level) - 1);
1170 }
1171
1172 /*
1173  * The x86 doesn't have any external MMU info: the kernel page
1174  * tables contain all the necessary information.
1175  */
1176 static inline void update_mmu_cache(struct vm_area_struct *vma,
1177                 unsigned long addr, pte_t *ptep)
1178 {
1179 }
1180 static inline void update_mmu_cache_pmd(struct vm_area_struct *vma,
1181                 unsigned long addr, pmd_t *pmd)
1182 {
1183 }
1184 static inline void update_mmu_cache_pud(struct vm_area_struct *vma,
1185                 unsigned long addr, pud_t *pud)
1186 {
1187 }
1188
1189 #ifdef CONFIG_HAVE_ARCH_SOFT_DIRTY
1190 static inline pte_t pte_swp_mksoft_dirty(pte_t pte)
1191 {
1192         return pte_set_flags(pte, _PAGE_SWP_SOFT_DIRTY);
1193 }
1194
1195 static inline int pte_swp_soft_dirty(pte_t pte)
1196 {
1197         return pte_flags(pte) & _PAGE_SWP_SOFT_DIRTY;
1198 }
1199
1200 static inline pte_t pte_swp_clear_soft_dirty(pte_t pte)
1201 {
1202         return pte_clear_flags(pte, _PAGE_SWP_SOFT_DIRTY);
1203 }
1204
1205 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
1206 static inline pmd_t pmd_swp_mksoft_dirty(pmd_t pmd)
1207 {
1208         return pmd_set_flags(pmd, _PAGE_SWP_SOFT_DIRTY);
1209 }
1210
1211 static inline int pmd_swp_soft_dirty(pmd_t pmd)
1212 {
1213         return pmd_flags(pmd) & _PAGE_SWP_SOFT_DIRTY;
1214 }
1215
1216 static inline pmd_t pmd_swp_clear_soft_dirty(pmd_t pmd)
1217 {
1218         return pmd_clear_flags(pmd, _PAGE_SWP_SOFT_DIRTY);
1219 }
1220 #endif
1221 #endif
1222
1223 #define PKRU_AD_BIT 0x1u
1224 #define PKRU_WD_BIT 0x2u
1225 #define PKRU_BITS_PER_PKEY 2
1226
1227 static inline bool __pkru_allows_read(u32 pkru, u16 pkey)
1228 {
1229         int pkru_pkey_bits = pkey * PKRU_BITS_PER_PKEY;
1230         return !(pkru & (PKRU_AD_BIT << pkru_pkey_bits));
1231 }
1232
1233 static inline bool __pkru_allows_write(u32 pkru, u16 pkey)
1234 {
1235         int pkru_pkey_bits = pkey * PKRU_BITS_PER_PKEY;
1236         /*
1237          * Access-disable disables writes too so we need to check
1238          * both bits here.
1239          */
1240         return !(pkru & ((PKRU_AD_BIT|PKRU_WD_BIT) << pkru_pkey_bits));
1241 }
1242
1243 static inline u16 pte_flags_pkey(unsigned long pte_flags)
1244 {
1245 #ifdef CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
1246         /* ifdef to avoid doing 59-bit shift on 32-bit values */
1247         return (pte_flags & _PAGE_PKEY_MASK) >> _PAGE_BIT_PKEY_BIT0;
1248 #else
1249         return 0;
1250 #endif
1251 }
1252
1253 static inline bool __pkru_allows_pkey(u16 pkey, bool write)
1254 {
1255         u32 pkru = read_pkru();
1256
1257         if (!__pkru_allows_read(pkru, pkey))
1258                 return false;
1259         if (write && !__pkru_allows_write(pkru, pkey))
1260                 return false;
1261
1262         return true;
1263 }
1264
1265 /*
1266  * 'pteval' can come from a PTE, PMD or PUD.  We only check
1267  * _PAGE_PRESENT, _PAGE_USER, and _PAGE_RW in here which are the
1268  * same value on all 3 types.
1269  */
1270 static inline bool __pte_access_permitted(unsigned long pteval, bool write)
1271 {
1272         unsigned long need_pte_bits = _PAGE_PRESENT|_PAGE_USER;
1273
1274         if (write)
1275                 need_pte_bits |= _PAGE_RW;
1276
1277         if ((pteval & need_pte_bits) != need_pte_bits)
1278                 return 0;
1279
1280         return __pkru_allows_pkey(pte_flags_pkey(pteval), write);
1281 }
1282
1283 #define pte_access_permitted pte_access_permitted
1284 static inline bool pte_access_permitted(pte_t pte, bool write)
1285 {
1286         return __pte_access_permitted(pte_val(pte), write);
1287 }
1288
1289 #define pmd_access_permitted pmd_access_permitted
1290 static inline bool pmd_access_permitted(pmd_t pmd, bool write)
1291 {
1292         return __pte_access_permitted(pmd_val(pmd), write);
1293 }
1294
1295 #define pud_access_permitted pud_access_permitted
1296 static inline bool pud_access_permitted(pud_t pud, bool write)
1297 {
1298         return __pte_access_permitted(pud_val(pud), write);
1299 }
1300
1301 #define __HAVE_ARCH_PFN_MODIFY_ALLOWED 1
1302 extern bool pfn_modify_allowed(unsigned long pfn, pgprot_t prot);
1303
1304 static inline bool arch_has_pfn_modify_check(void)
1305 {
1306         return boot_cpu_has_bug(X86_BUG_L1TF);
1307 }
1308
1309 #include <asm-generic/pgtable.h>
1310 #endif  /* __ASSEMBLY__ */
1311
1312 #endif /* _ASM_X86_PGTABLE_H */