Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * This kernel test validates architecture page table helpers and
4 * accessors and helps in verifying their continued compliance with
5 * expected generic MM semantics.
6 *
7 * Copyright (C) 2019 ARM Ltd.
8 *
9 * Author: Anshuman Khandual <anshuman.khandual@arm.com>
10 */
11#define pr_fmt(fmt) "debug_vm_pgtable: [%-25s]: " fmt, __func__
12
13#include <linux/gfp.h>
14#include <linux/highmem.h>
15#include <linux/hugetlb.h>
16#include <linux/kernel.h>
17#include <linux/kconfig.h>
18#include <linux/mm.h>
19#include <linux/mman.h>
20#include <linux/mm_types.h>
21#include <linux/module.h>
22#include <linux/pfn_t.h>
23#include <linux/printk.h>
24#include <linux/pgtable.h>
25#include <linux/random.h>
26#include <linux/spinlock.h>
27#include <linux/swap.h>
28#include <linux/swapops.h>
29#include <linux/start_kernel.h>
30#include <linux/sched/mm.h>
31#include <linux/io.h>
32#include <asm/pgalloc.h>
33#include <asm/tlbflush.h>
34
35/*
36 * Please refer Documentation/vm/arch_pgtable_helpers.rst for the semantics
37 * expectations that are being validated here. All future changes in here
38 * or the documentation need to be in sync.
39 */
40
41#define VMFLAGS (VM_READ|VM_WRITE|VM_EXEC)
42
43/*
44 * On s390 platform, the lower 4 bits are used to identify given page table
45 * entry type. But these bits might affect the ability to clear entries with
46 * pxx_clear() because of how dynamic page table folding works on s390. So
47 * while loading up the entries do not change the lower 4 bits. It does not
48 * have affect any other platform. Also avoid the 62nd bit on ppc64 that is
49 * used to mark a pte entry.
50 */
51#define S390_SKIP_MASK GENMASK(3, 0)
52#if __BITS_PER_LONG == 64
53#define PPC64_SKIP_MASK GENMASK(62, 62)
54#else
55#define PPC64_SKIP_MASK 0x0
56#endif
57#define ARCH_SKIP_MASK (S390_SKIP_MASK | PPC64_SKIP_MASK)
58#define RANDOM_ORVALUE (GENMASK(BITS_PER_LONG - 1, 0) & ~ARCH_SKIP_MASK)
59#define RANDOM_NZVALUE GENMASK(7, 0)
60
61static void __init pte_basic_tests(unsigned long pfn, int idx)
62{
63 pgprot_t prot = protection_map[idx];
64 pte_t pte = pfn_pte(pfn, prot);
65 unsigned long val = idx, *ptr = &val;
66
67 pr_debug("Validating PTE basic (%pGv)\n", ptr);
68
69 /*
70 * This test needs to be executed after the given page table entry
71 * is created with pfn_pte() to make sure that protection_map[idx]
72 * does not have the dirty bit enabled from the beginning. This is
73 * important for platforms like arm64 where (!PTE_RDONLY) indicate
74 * dirty bit being set.
75 */
76 WARN_ON(pte_dirty(pte_wrprotect(pte)));
77
78 WARN_ON(!pte_same(pte, pte));
79 WARN_ON(!pte_young(pte_mkyoung(pte_mkold(pte))));
80 WARN_ON(!pte_dirty(pte_mkdirty(pte_mkclean(pte))));
81 WARN_ON(!pte_write(pte_mkwrite(pte_wrprotect(pte))));
82 WARN_ON(pte_young(pte_mkold(pte_mkyoung(pte))));
83 WARN_ON(pte_dirty(pte_mkclean(pte_mkdirty(pte))));
84 WARN_ON(pte_write(pte_wrprotect(pte_mkwrite(pte))));
85 WARN_ON(pte_dirty(pte_wrprotect(pte_mkclean(pte))));
86 WARN_ON(!pte_dirty(pte_wrprotect(pte_mkdirty(pte))));
87}
88
89static void __init pte_advanced_tests(struct mm_struct *mm,
90 struct vm_area_struct *vma, pte_t *ptep,
91 unsigned long pfn, unsigned long vaddr,
92 pgprot_t prot)
93{
94 pte_t pte;
95
96 /*
97 * Architectures optimize set_pte_at by avoiding TLB flush.
98 * This requires set_pte_at to be not used to update an
99 * existing pte entry. Clear pte before we do set_pte_at
100 */
101
102 pr_debug("Validating PTE advanced\n");
103 pte = pfn_pte(pfn, prot);
104 set_pte_at(mm, vaddr, ptep, pte);
105 ptep_set_wrprotect(mm, vaddr, ptep);
106 pte = ptep_get(ptep);
107 WARN_ON(pte_write(pte));
108 ptep_get_and_clear(mm, vaddr, ptep);
109 pte = ptep_get(ptep);
110 WARN_ON(!pte_none(pte));
111
112 pte = pfn_pte(pfn, prot);
113 pte = pte_wrprotect(pte);
114 pte = pte_mkclean(pte);
115 set_pte_at(mm, vaddr, ptep, pte);
116 pte = pte_mkwrite(pte);
117 pte = pte_mkdirty(pte);
118 ptep_set_access_flags(vma, vaddr, ptep, pte, 1);
119 pte = ptep_get(ptep);
120 WARN_ON(!(pte_write(pte) && pte_dirty(pte)));
121 ptep_get_and_clear_full(mm, vaddr, ptep, 1);
122 pte = ptep_get(ptep);
123 WARN_ON(!pte_none(pte));
124
125 pte = pfn_pte(pfn, prot);
126 pte = pte_mkyoung(pte);
127 set_pte_at(mm, vaddr, ptep, pte);
128 ptep_test_and_clear_young(vma, vaddr, ptep);
129 pte = ptep_get(ptep);
130 WARN_ON(pte_young(pte));
131}
132
133static void __init pte_savedwrite_tests(unsigned long pfn, pgprot_t prot)
134{
135 pte_t pte = pfn_pte(pfn, prot);
136
137 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
138 return;
139
140 pr_debug("Validating PTE saved write\n");
141 WARN_ON(!pte_savedwrite(pte_mk_savedwrite(pte_clear_savedwrite(pte))));
142 WARN_ON(pte_savedwrite(pte_clear_savedwrite(pte_mk_savedwrite(pte))));
143}
144
145#ifdef CONFIG_TRANSPARENT_HUGEPAGE
146static void __init pmd_basic_tests(unsigned long pfn, int idx)
147{
148 pgprot_t prot = protection_map[idx];
149 unsigned long val = idx, *ptr = &val;
150 pmd_t pmd;
151
152 if (!has_transparent_hugepage())
153 return;
154
155 pr_debug("Validating PMD basic (%pGv)\n", ptr);
156 pmd = pfn_pmd(pfn, prot);
157
158 /*
159 * This test needs to be executed after the given page table entry
160 * is created with pfn_pmd() to make sure that protection_map[idx]
161 * does not have the dirty bit enabled from the beginning. This is
162 * important for platforms like arm64 where (!PTE_RDONLY) indicate
163 * dirty bit being set.
164 */
165 WARN_ON(pmd_dirty(pmd_wrprotect(pmd)));
166
167
168 WARN_ON(!pmd_same(pmd, pmd));
169 WARN_ON(!pmd_young(pmd_mkyoung(pmd_mkold(pmd))));
170 WARN_ON(!pmd_dirty(pmd_mkdirty(pmd_mkclean(pmd))));
171 WARN_ON(!pmd_write(pmd_mkwrite(pmd_wrprotect(pmd))));
172 WARN_ON(pmd_young(pmd_mkold(pmd_mkyoung(pmd))));
173 WARN_ON(pmd_dirty(pmd_mkclean(pmd_mkdirty(pmd))));
174 WARN_ON(pmd_write(pmd_wrprotect(pmd_mkwrite(pmd))));
175 WARN_ON(pmd_dirty(pmd_wrprotect(pmd_mkclean(pmd))));
176 WARN_ON(!pmd_dirty(pmd_wrprotect(pmd_mkdirty(pmd))));
177 /*
178 * A huge page does not point to next level page table
179 * entry. Hence this must qualify as pmd_bad().
180 */
181 WARN_ON(!pmd_bad(pmd_mkhuge(pmd)));
182}
183
184static void __init pmd_advanced_tests(struct mm_struct *mm,
185 struct vm_area_struct *vma, pmd_t *pmdp,
186 unsigned long pfn, unsigned long vaddr,
187 pgprot_t prot, pgtable_t pgtable)
188{
189 pmd_t pmd;
190
191 if (!has_transparent_hugepage())
192 return;
193
194 pr_debug("Validating PMD advanced\n");
195 /* Align the address wrt HPAGE_PMD_SIZE */
196 vaddr &= HPAGE_PMD_MASK;
197
198 pgtable_trans_huge_deposit(mm, pmdp, pgtable);
199
200 pmd = pfn_pmd(pfn, prot);
201 set_pmd_at(mm, vaddr, pmdp, pmd);
202 pmdp_set_wrprotect(mm, vaddr, pmdp);
203 pmd = READ_ONCE(*pmdp);
204 WARN_ON(pmd_write(pmd));
205 pmdp_huge_get_and_clear(mm, vaddr, pmdp);
206 pmd = READ_ONCE(*pmdp);
207 WARN_ON(!pmd_none(pmd));
208
209 pmd = pfn_pmd(pfn, prot);
210 pmd = pmd_wrprotect(pmd);
211 pmd = pmd_mkclean(pmd);
212 set_pmd_at(mm, vaddr, pmdp, pmd);
213 pmd = pmd_mkwrite(pmd);
214 pmd = pmd_mkdirty(pmd);
215 pmdp_set_access_flags(vma, vaddr, pmdp, pmd, 1);
216 pmd = READ_ONCE(*pmdp);
217 WARN_ON(!(pmd_write(pmd) && pmd_dirty(pmd)));
218 pmdp_huge_get_and_clear_full(vma, vaddr, pmdp, 1);
219 pmd = READ_ONCE(*pmdp);
220 WARN_ON(!pmd_none(pmd));
221
222 pmd = pmd_mkhuge(pfn_pmd(pfn, prot));
223 pmd = pmd_mkyoung(pmd);
224 set_pmd_at(mm, vaddr, pmdp, pmd);
225 pmdp_test_and_clear_young(vma, vaddr, pmdp);
226 pmd = READ_ONCE(*pmdp);
227 WARN_ON(pmd_young(pmd));
228
229 /* Clear the pte entries */
230 pmdp_huge_get_and_clear(mm, vaddr, pmdp);
231 pgtable = pgtable_trans_huge_withdraw(mm, pmdp);
232}
233
234static void __init pmd_leaf_tests(unsigned long pfn, pgprot_t prot)
235{
236 pmd_t pmd;
237
238 if (!has_transparent_hugepage())
239 return;
240
241 pr_debug("Validating PMD leaf\n");
242 pmd = pfn_pmd(pfn, prot);
243
244 /*
245 * PMD based THP is a leaf entry.
246 */
247 pmd = pmd_mkhuge(pmd);
248 WARN_ON(!pmd_leaf(pmd));
249}
250
251static void __init pmd_savedwrite_tests(unsigned long pfn, pgprot_t prot)
252{
253 pmd_t pmd;
254
255 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
256 return;
257
258 if (!has_transparent_hugepage())
259 return;
260
261 pr_debug("Validating PMD saved write\n");
262 pmd = pfn_pmd(pfn, prot);
263 WARN_ON(!pmd_savedwrite(pmd_mk_savedwrite(pmd_clear_savedwrite(pmd))));
264 WARN_ON(pmd_savedwrite(pmd_clear_savedwrite(pmd_mk_savedwrite(pmd))));
265}
266
267#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
268static void __init pud_basic_tests(struct mm_struct *mm, unsigned long pfn, int idx)
269{
270 pgprot_t prot = protection_map[idx];
271 unsigned long val = idx, *ptr = &val;
272 pud_t pud;
273
274 if (!has_transparent_hugepage())
275 return;
276
277 pr_debug("Validating PUD basic (%pGv)\n", ptr);
278 pud = pfn_pud(pfn, prot);
279
280 /*
281 * This test needs to be executed after the given page table entry
282 * is created with pfn_pud() to make sure that protection_map[idx]
283 * does not have the dirty bit enabled from the beginning. This is
284 * important for platforms like arm64 where (!PTE_RDONLY) indicate
285 * dirty bit being set.
286 */
287 WARN_ON(pud_dirty(pud_wrprotect(pud)));
288
289 WARN_ON(!pud_same(pud, pud));
290 WARN_ON(!pud_young(pud_mkyoung(pud_mkold(pud))));
291 WARN_ON(!pud_dirty(pud_mkdirty(pud_mkclean(pud))));
292 WARN_ON(pud_dirty(pud_mkclean(pud_mkdirty(pud))));
293 WARN_ON(!pud_write(pud_mkwrite(pud_wrprotect(pud))));
294 WARN_ON(pud_write(pud_wrprotect(pud_mkwrite(pud))));
295 WARN_ON(pud_young(pud_mkold(pud_mkyoung(pud))));
296 WARN_ON(pud_dirty(pud_wrprotect(pud_mkclean(pud))));
297 WARN_ON(!pud_dirty(pud_wrprotect(pud_mkdirty(pud))));
298
299 if (mm_pmd_folded(mm))
300 return;
301
302 /*
303 * A huge page does not point to next level page table
304 * entry. Hence this must qualify as pud_bad().
305 */
306 WARN_ON(!pud_bad(pud_mkhuge(pud)));
307}
308
309static void __init pud_advanced_tests(struct mm_struct *mm,
310 struct vm_area_struct *vma, pud_t *pudp,
311 unsigned long pfn, unsigned long vaddr,
312 pgprot_t prot)
313{
314 pud_t pud;
315
316 if (!has_transparent_hugepage())
317 return;
318
319 pr_debug("Validating PUD advanced\n");
320 /* Align the address wrt HPAGE_PUD_SIZE */
321 vaddr &= HPAGE_PUD_MASK;
322
323 pud = pfn_pud(pfn, prot);
324 set_pud_at(mm, vaddr, pudp, pud);
325 pudp_set_wrprotect(mm, vaddr, pudp);
326 pud = READ_ONCE(*pudp);
327 WARN_ON(pud_write(pud));
328
329#ifndef __PAGETABLE_PMD_FOLDED
330 pudp_huge_get_and_clear(mm, vaddr, pudp);
331 pud = READ_ONCE(*pudp);
332 WARN_ON(!pud_none(pud));
333#endif /* __PAGETABLE_PMD_FOLDED */
334 pud = pfn_pud(pfn, prot);
335 pud = pud_wrprotect(pud);
336 pud = pud_mkclean(pud);
337 set_pud_at(mm, vaddr, pudp, pud);
338 pud = pud_mkwrite(pud);
339 pud = pud_mkdirty(pud);
340 pudp_set_access_flags(vma, vaddr, pudp, pud, 1);
341 pud = READ_ONCE(*pudp);
342 WARN_ON(!(pud_write(pud) && pud_dirty(pud)));
343
344#ifndef __PAGETABLE_PMD_FOLDED
345 pudp_huge_get_and_clear_full(mm, vaddr, pudp, 1);
346 pud = READ_ONCE(*pudp);
347 WARN_ON(!pud_none(pud));
348#endif /* __PAGETABLE_PMD_FOLDED */
349
350 pud = pfn_pud(pfn, prot);
351 pud = pud_mkyoung(pud);
352 set_pud_at(mm, vaddr, pudp, pud);
353 pudp_test_and_clear_young(vma, vaddr, pudp);
354 pud = READ_ONCE(*pudp);
355 WARN_ON(pud_young(pud));
356
357 pudp_huge_get_and_clear(mm, vaddr, pudp);
358}
359
360static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot)
361{
362 pud_t pud;
363
364 if (!has_transparent_hugepage())
365 return;
366
367 pr_debug("Validating PUD leaf\n");
368 pud = pfn_pud(pfn, prot);
369 /*
370 * PUD based THP is a leaf entry.
371 */
372 pud = pud_mkhuge(pud);
373 WARN_ON(!pud_leaf(pud));
374}
375#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
376static void __init pud_basic_tests(struct mm_struct *mm, unsigned long pfn, int idx) { }
377static void __init pud_advanced_tests(struct mm_struct *mm,
378 struct vm_area_struct *vma, pud_t *pudp,
379 unsigned long pfn, unsigned long vaddr,
380 pgprot_t prot)
381{
382}
383static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot) { }
384#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
385#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
386static void __init pmd_basic_tests(unsigned long pfn, int idx) { }
387static void __init pud_basic_tests(struct mm_struct *mm, unsigned long pfn, int idx) { }
388static void __init pmd_advanced_tests(struct mm_struct *mm,
389 struct vm_area_struct *vma, pmd_t *pmdp,
390 unsigned long pfn, unsigned long vaddr,
391 pgprot_t prot, pgtable_t pgtable)
392{
393}
394static void __init pud_advanced_tests(struct mm_struct *mm,
395 struct vm_area_struct *vma, pud_t *pudp,
396 unsigned long pfn, unsigned long vaddr,
397 pgprot_t prot)
398{
399}
400static void __init pmd_leaf_tests(unsigned long pfn, pgprot_t prot) { }
401static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot) { }
402static void __init pmd_savedwrite_tests(unsigned long pfn, pgprot_t prot) { }
403#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
404
405#ifdef CONFIG_HAVE_ARCH_HUGE_VMAP
406static void __init pmd_huge_tests(pmd_t *pmdp, unsigned long pfn, pgprot_t prot)
407{
408 pmd_t pmd;
409
410 if (!arch_vmap_pmd_supported(prot))
411 return;
412
413 pr_debug("Validating PMD huge\n");
414 /*
415 * X86 defined pmd_set_huge() verifies that the given
416 * PMD is not a populated non-leaf entry.
417 */
418 WRITE_ONCE(*pmdp, __pmd(0));
419 WARN_ON(!pmd_set_huge(pmdp, __pfn_to_phys(pfn), prot));
420 WARN_ON(!pmd_clear_huge(pmdp));
421 pmd = READ_ONCE(*pmdp);
422 WARN_ON(!pmd_none(pmd));
423}
424
425static void __init pud_huge_tests(pud_t *pudp, unsigned long pfn, pgprot_t prot)
426{
427 pud_t pud;
428
429 if (!arch_vmap_pud_supported(prot))
430 return;
431
432 pr_debug("Validating PUD huge\n");
433 /*
434 * X86 defined pud_set_huge() verifies that the given
435 * PUD is not a populated non-leaf entry.
436 */
437 WRITE_ONCE(*pudp, __pud(0));
438 WARN_ON(!pud_set_huge(pudp, __pfn_to_phys(pfn), prot));
439 WARN_ON(!pud_clear_huge(pudp));
440 pud = READ_ONCE(*pudp);
441 WARN_ON(!pud_none(pud));
442}
443#else /* !CONFIG_HAVE_ARCH_HUGE_VMAP */
444static void __init pmd_huge_tests(pmd_t *pmdp, unsigned long pfn, pgprot_t prot) { }
445static void __init pud_huge_tests(pud_t *pudp, unsigned long pfn, pgprot_t prot) { }
446#endif /* CONFIG_HAVE_ARCH_HUGE_VMAP */
447
448static void __init p4d_basic_tests(unsigned long pfn, pgprot_t prot)
449{
450 p4d_t p4d;
451
452 pr_debug("Validating P4D basic\n");
453 memset(&p4d, RANDOM_NZVALUE, sizeof(p4d_t));
454 WARN_ON(!p4d_same(p4d, p4d));
455}
456
457static void __init pgd_basic_tests(unsigned long pfn, pgprot_t prot)
458{
459 pgd_t pgd;
460
461 pr_debug("Validating PGD basic\n");
462 memset(&pgd, RANDOM_NZVALUE, sizeof(pgd_t));
463 WARN_ON(!pgd_same(pgd, pgd));
464}
465
466#ifndef __PAGETABLE_PUD_FOLDED
467static void __init pud_clear_tests(struct mm_struct *mm, pud_t *pudp)
468{
469 pud_t pud = READ_ONCE(*pudp);
470
471 if (mm_pmd_folded(mm))
472 return;
473
474 pr_debug("Validating PUD clear\n");
475 pud = __pud(pud_val(pud) | RANDOM_ORVALUE);
476 WRITE_ONCE(*pudp, pud);
477 pud_clear(pudp);
478 pud = READ_ONCE(*pudp);
479 WARN_ON(!pud_none(pud));
480}
481
482static void __init pud_populate_tests(struct mm_struct *mm, pud_t *pudp,
483 pmd_t *pmdp)
484{
485 pud_t pud;
486
487 if (mm_pmd_folded(mm))
488 return;
489
490 pr_debug("Validating PUD populate\n");
491 /*
492 * This entry points to next level page table page.
493 * Hence this must not qualify as pud_bad().
494 */
495 pud_populate(mm, pudp, pmdp);
496 pud = READ_ONCE(*pudp);
497 WARN_ON(pud_bad(pud));
498}
499#else /* !__PAGETABLE_PUD_FOLDED */
500static void __init pud_clear_tests(struct mm_struct *mm, pud_t *pudp) { }
501static void __init pud_populate_tests(struct mm_struct *mm, pud_t *pudp,
502 pmd_t *pmdp)
503{
504}
505#endif /* PAGETABLE_PUD_FOLDED */
506
507#ifndef __PAGETABLE_P4D_FOLDED
508static void __init p4d_clear_tests(struct mm_struct *mm, p4d_t *p4dp)
509{
510 p4d_t p4d = READ_ONCE(*p4dp);
511
512 if (mm_pud_folded(mm))
513 return;
514
515 pr_debug("Validating P4D clear\n");
516 p4d = __p4d(p4d_val(p4d) | RANDOM_ORVALUE);
517 WRITE_ONCE(*p4dp, p4d);
518 p4d_clear(p4dp);
519 p4d = READ_ONCE(*p4dp);
520 WARN_ON(!p4d_none(p4d));
521}
522
523static void __init p4d_populate_tests(struct mm_struct *mm, p4d_t *p4dp,
524 pud_t *pudp)
525{
526 p4d_t p4d;
527
528 if (mm_pud_folded(mm))
529 return;
530
531 pr_debug("Validating P4D populate\n");
532 /*
533 * This entry points to next level page table page.
534 * Hence this must not qualify as p4d_bad().
535 */
536 pud_clear(pudp);
537 p4d_clear(p4dp);
538 p4d_populate(mm, p4dp, pudp);
539 p4d = READ_ONCE(*p4dp);
540 WARN_ON(p4d_bad(p4d));
541}
542
543static void __init pgd_clear_tests(struct mm_struct *mm, pgd_t *pgdp)
544{
545 pgd_t pgd = READ_ONCE(*pgdp);
546
547 if (mm_p4d_folded(mm))
548 return;
549
550 pr_debug("Validating PGD clear\n");
551 pgd = __pgd(pgd_val(pgd) | RANDOM_ORVALUE);
552 WRITE_ONCE(*pgdp, pgd);
553 pgd_clear(pgdp);
554 pgd = READ_ONCE(*pgdp);
555 WARN_ON(!pgd_none(pgd));
556}
557
558static void __init pgd_populate_tests(struct mm_struct *mm, pgd_t *pgdp,
559 p4d_t *p4dp)
560{
561 pgd_t pgd;
562
563 if (mm_p4d_folded(mm))
564 return;
565
566 pr_debug("Validating PGD populate\n");
567 /*
568 * This entry points to next level page table page.
569 * Hence this must not qualify as pgd_bad().
570 */
571 p4d_clear(p4dp);
572 pgd_clear(pgdp);
573 pgd_populate(mm, pgdp, p4dp);
574 pgd = READ_ONCE(*pgdp);
575 WARN_ON(pgd_bad(pgd));
576}
577#else /* !__PAGETABLE_P4D_FOLDED */
578static void __init p4d_clear_tests(struct mm_struct *mm, p4d_t *p4dp) { }
579static void __init pgd_clear_tests(struct mm_struct *mm, pgd_t *pgdp) { }
580static void __init p4d_populate_tests(struct mm_struct *mm, p4d_t *p4dp,
581 pud_t *pudp)
582{
583}
584static void __init pgd_populate_tests(struct mm_struct *mm, pgd_t *pgdp,
585 p4d_t *p4dp)
586{
587}
588#endif /* PAGETABLE_P4D_FOLDED */
589
590static void __init pte_clear_tests(struct mm_struct *mm, pte_t *ptep,
591 unsigned long pfn, unsigned long vaddr,
592 pgprot_t prot)
593{
594 pte_t pte = pfn_pte(pfn, prot);
595
596 pr_debug("Validating PTE clear\n");
597#ifndef CONFIG_RISCV
598 pte = __pte(pte_val(pte) | RANDOM_ORVALUE);
599#endif
600 set_pte_at(mm, vaddr, ptep, pte);
601 barrier();
602 pte_clear(mm, vaddr, ptep);
603 pte = ptep_get(ptep);
604 WARN_ON(!pte_none(pte));
605}
606
607static void __init pmd_clear_tests(struct mm_struct *mm, pmd_t *pmdp)
608{
609 pmd_t pmd = READ_ONCE(*pmdp);
610
611 pr_debug("Validating PMD clear\n");
612 pmd = __pmd(pmd_val(pmd) | RANDOM_ORVALUE);
613 WRITE_ONCE(*pmdp, pmd);
614 pmd_clear(pmdp);
615 pmd = READ_ONCE(*pmdp);
616 WARN_ON(!pmd_none(pmd));
617}
618
619static void __init pmd_populate_tests(struct mm_struct *mm, pmd_t *pmdp,
620 pgtable_t pgtable)
621{
622 pmd_t pmd;
623
624 pr_debug("Validating PMD populate\n");
625 /*
626 * This entry points to next level page table page.
627 * Hence this must not qualify as pmd_bad().
628 */
629 pmd_populate(mm, pmdp, pgtable);
630 pmd = READ_ONCE(*pmdp);
631 WARN_ON(pmd_bad(pmd));
632}
633
634static void __init pte_special_tests(unsigned long pfn, pgprot_t prot)
635{
636 pte_t pte = pfn_pte(pfn, prot);
637
638 if (!IS_ENABLED(CONFIG_ARCH_HAS_PTE_SPECIAL))
639 return;
640
641 pr_debug("Validating PTE special\n");
642 WARN_ON(!pte_special(pte_mkspecial(pte)));
643}
644
645static void __init pte_protnone_tests(unsigned long pfn, pgprot_t prot)
646{
647 pte_t pte = pfn_pte(pfn, prot);
648
649 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
650 return;
651
652 pr_debug("Validating PTE protnone\n");
653 WARN_ON(!pte_protnone(pte));
654 WARN_ON(!pte_present(pte));
655}
656
657#ifdef CONFIG_TRANSPARENT_HUGEPAGE
658static void __init pmd_protnone_tests(unsigned long pfn, pgprot_t prot)
659{
660 pmd_t pmd;
661
662 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
663 return;
664
665 if (!has_transparent_hugepage())
666 return;
667
668 pr_debug("Validating PMD protnone\n");
669 pmd = pmd_mkhuge(pfn_pmd(pfn, prot));
670 WARN_ON(!pmd_protnone(pmd));
671 WARN_ON(!pmd_present(pmd));
672}
673#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
674static void __init pmd_protnone_tests(unsigned long pfn, pgprot_t prot) { }
675#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
676
677#ifdef CONFIG_ARCH_HAS_PTE_DEVMAP
678static void __init pte_devmap_tests(unsigned long pfn, pgprot_t prot)
679{
680 pte_t pte = pfn_pte(pfn, prot);
681
682 pr_debug("Validating PTE devmap\n");
683 WARN_ON(!pte_devmap(pte_mkdevmap(pte)));
684}
685
686#ifdef CONFIG_TRANSPARENT_HUGEPAGE
687static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot)
688{
689 pmd_t pmd;
690
691 if (!has_transparent_hugepage())
692 return;
693
694 pr_debug("Validating PMD devmap\n");
695 pmd = pfn_pmd(pfn, prot);
696 WARN_ON(!pmd_devmap(pmd_mkdevmap(pmd)));
697}
698
699#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
700static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot)
701{
702 pud_t pud;
703
704 if (!has_transparent_hugepage())
705 return;
706
707 pr_debug("Validating PUD devmap\n");
708 pud = pfn_pud(pfn, prot);
709 WARN_ON(!pud_devmap(pud_mkdevmap(pud)));
710}
711#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
712static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
713#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
714#else /* CONFIG_TRANSPARENT_HUGEPAGE */
715static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot) { }
716static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
717#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
718#else
719static void __init pte_devmap_tests(unsigned long pfn, pgprot_t prot) { }
720static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot) { }
721static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
722#endif /* CONFIG_ARCH_HAS_PTE_DEVMAP */
723
724static void __init pte_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
725{
726 pte_t pte = pfn_pte(pfn, prot);
727
728 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
729 return;
730
731 pr_debug("Validating PTE soft dirty\n");
732 WARN_ON(!pte_soft_dirty(pte_mksoft_dirty(pte)));
733 WARN_ON(pte_soft_dirty(pte_clear_soft_dirty(pte)));
734}
735
736static void __init pte_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
737{
738 pte_t pte = pfn_pte(pfn, prot);
739
740 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
741 return;
742
743 pr_debug("Validating PTE swap soft dirty\n");
744 WARN_ON(!pte_swp_soft_dirty(pte_swp_mksoft_dirty(pte)));
745 WARN_ON(pte_swp_soft_dirty(pte_swp_clear_soft_dirty(pte)));
746}
747
748#ifdef CONFIG_TRANSPARENT_HUGEPAGE
749static void __init pmd_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
750{
751 pmd_t pmd;
752
753 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
754 return;
755
756 if (!has_transparent_hugepage())
757 return;
758
759 pr_debug("Validating PMD soft dirty\n");
760 pmd = pfn_pmd(pfn, prot);
761 WARN_ON(!pmd_soft_dirty(pmd_mksoft_dirty(pmd)));
762 WARN_ON(pmd_soft_dirty(pmd_clear_soft_dirty(pmd)));
763}
764
765static void __init pmd_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
766{
767 pmd_t pmd;
768
769 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY) ||
770 !IS_ENABLED(CONFIG_ARCH_ENABLE_THP_MIGRATION))
771 return;
772
773 if (!has_transparent_hugepage())
774 return;
775
776 pr_debug("Validating PMD swap soft dirty\n");
777 pmd = pfn_pmd(pfn, prot);
778 WARN_ON(!pmd_swp_soft_dirty(pmd_swp_mksoft_dirty(pmd)));
779 WARN_ON(pmd_swp_soft_dirty(pmd_swp_clear_soft_dirty(pmd)));
780}
781#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
782static void __init pmd_soft_dirty_tests(unsigned long pfn, pgprot_t prot) { }
783static void __init pmd_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
784{
785}
786#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
787
788static void __init pte_swap_tests(unsigned long pfn, pgprot_t prot)
789{
790 swp_entry_t swp;
791 pte_t pte;
792
793 pr_debug("Validating PTE swap\n");
794 pte = pfn_pte(pfn, prot);
795 swp = __pte_to_swp_entry(pte);
796 pte = __swp_entry_to_pte(swp);
797 WARN_ON(pfn != pte_pfn(pte));
798}
799
800#ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
801static void __init pmd_swap_tests(unsigned long pfn, pgprot_t prot)
802{
803 swp_entry_t swp;
804 pmd_t pmd;
805
806 if (!has_transparent_hugepage())
807 return;
808
809 pr_debug("Validating PMD swap\n");
810 pmd = pfn_pmd(pfn, prot);
811 swp = __pmd_to_swp_entry(pmd);
812 pmd = __swp_entry_to_pmd(swp);
813 WARN_ON(pfn != pmd_pfn(pmd));
814}
815#else /* !CONFIG_ARCH_ENABLE_THP_MIGRATION */
816static void __init pmd_swap_tests(unsigned long pfn, pgprot_t prot) { }
817#endif /* CONFIG_ARCH_ENABLE_THP_MIGRATION */
818
819static void __init swap_migration_tests(void)
820{
821 struct page *page;
822 swp_entry_t swp;
823
824 if (!IS_ENABLED(CONFIG_MIGRATION))
825 return;
826
827 pr_debug("Validating swap migration\n");
828 /*
829 * swap_migration_tests() requires a dedicated page as it needs to
830 * be locked before creating a migration entry from it. Locking the
831 * page that actually maps kernel text ('start_kernel') can be real
832 * problematic. Lets allocate a dedicated page explicitly for this
833 * purpose that will be freed subsequently.
834 */
835 page = alloc_page(GFP_KERNEL);
836 if (!page) {
837 pr_err("page allocation failed\n");
838 return;
839 }
840
841 /*
842 * make_migration_entry() expects given page to be
843 * locked, otherwise it stumbles upon a BUG_ON().
844 */
845 __SetPageLocked(page);
846 swp = make_writable_migration_entry(page_to_pfn(page));
847 WARN_ON(!is_migration_entry(swp));
848 WARN_ON(!is_writable_migration_entry(swp));
849
850 swp = make_readable_migration_entry(swp_offset(swp));
851 WARN_ON(!is_migration_entry(swp));
852 WARN_ON(is_writable_migration_entry(swp));
853
854 swp = make_readable_migration_entry(page_to_pfn(page));
855 WARN_ON(!is_migration_entry(swp));
856 WARN_ON(is_writable_migration_entry(swp));
857 __ClearPageLocked(page);
858 __free_page(page);
859}
860
861#ifdef CONFIG_HUGETLB_PAGE
862static void __init hugetlb_basic_tests(unsigned long pfn, pgprot_t prot)
863{
864 struct page *page;
865 pte_t pte;
866
867 pr_debug("Validating HugeTLB basic\n");
868 /*
869 * Accessing the page associated with the pfn is safe here,
870 * as it was previously derived from a real kernel symbol.
871 */
872 page = pfn_to_page(pfn);
873 pte = mk_huge_pte(page, prot);
874
875 WARN_ON(!huge_pte_dirty(huge_pte_mkdirty(pte)));
876 WARN_ON(!huge_pte_write(huge_pte_mkwrite(huge_pte_wrprotect(pte))));
877 WARN_ON(huge_pte_write(huge_pte_wrprotect(huge_pte_mkwrite(pte))));
878
879#ifdef CONFIG_ARCH_WANT_GENERAL_HUGETLB
880 pte = pfn_pte(pfn, prot);
881
882 WARN_ON(!pte_huge(pte_mkhuge(pte)));
883#endif /* CONFIG_ARCH_WANT_GENERAL_HUGETLB */
884}
885#else /* !CONFIG_HUGETLB_PAGE */
886static void __init hugetlb_basic_tests(unsigned long pfn, pgprot_t prot) { }
887#endif /* CONFIG_HUGETLB_PAGE */
888
889#ifdef CONFIG_TRANSPARENT_HUGEPAGE
890static void __init pmd_thp_tests(unsigned long pfn, pgprot_t prot)
891{
892 pmd_t pmd;
893
894 if (!has_transparent_hugepage())
895 return;
896
897 pr_debug("Validating PMD based THP\n");
898 /*
899 * pmd_trans_huge() and pmd_present() must return positive after
900 * MMU invalidation with pmd_mkinvalid(). This behavior is an
901 * optimization for transparent huge page. pmd_trans_huge() must
902 * be true if pmd_page() returns a valid THP to avoid taking the
903 * pmd_lock when others walk over non transhuge pmds (i.e. there
904 * are no THP allocated). Especially when splitting a THP and
905 * removing the present bit from the pmd, pmd_trans_huge() still
906 * needs to return true. pmd_present() should be true whenever
907 * pmd_trans_huge() returns true.
908 */
909 pmd = pfn_pmd(pfn, prot);
910 WARN_ON(!pmd_trans_huge(pmd_mkhuge(pmd)));
911
912#ifndef __HAVE_ARCH_PMDP_INVALIDATE
913 WARN_ON(!pmd_trans_huge(pmd_mkinvalid(pmd_mkhuge(pmd))));
914 WARN_ON(!pmd_present(pmd_mkinvalid(pmd_mkhuge(pmd))));
915#endif /* __HAVE_ARCH_PMDP_INVALIDATE */
916}
917
918#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
919static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot)
920{
921 pud_t pud;
922
923 if (!has_transparent_hugepage())
924 return;
925
926 pr_debug("Validating PUD based THP\n");
927 pud = pfn_pud(pfn, prot);
928 WARN_ON(!pud_trans_huge(pud_mkhuge(pud)));
929
930 /*
931 * pud_mkinvalid() has been dropped for now. Enable back
932 * these tests when it comes back with a modified pud_present().
933 *
934 * WARN_ON(!pud_trans_huge(pud_mkinvalid(pud_mkhuge(pud))));
935 * WARN_ON(!pud_present(pud_mkinvalid(pud_mkhuge(pud))));
936 */
937}
938#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
939static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot) { }
940#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
941#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
942static void __init pmd_thp_tests(unsigned long pfn, pgprot_t prot) { }
943static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot) { }
944#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
945
946static unsigned long __init get_random_vaddr(void)
947{
948 unsigned long random_vaddr, random_pages, total_user_pages;
949
950 total_user_pages = (TASK_SIZE - FIRST_USER_ADDRESS) / PAGE_SIZE;
951
952 random_pages = get_random_long() % total_user_pages;
953 random_vaddr = FIRST_USER_ADDRESS + random_pages * PAGE_SIZE;
954
955 return random_vaddr;
956}
957
958static int __init debug_vm_pgtable(void)
959{
960 struct vm_area_struct *vma;
961 struct mm_struct *mm;
962 pgd_t *pgdp;
963 p4d_t *p4dp, *saved_p4dp;
964 pud_t *pudp, *saved_pudp;
965 pmd_t *pmdp, *saved_pmdp, pmd;
966 pte_t *ptep;
967 pgtable_t saved_ptep;
968 pgprot_t prot, protnone;
969 phys_addr_t paddr;
970 unsigned long vaddr, pte_aligned, pmd_aligned;
971 unsigned long pud_aligned, p4d_aligned, pgd_aligned;
972 spinlock_t *ptl = NULL;
973 int idx;
974
975 pr_info("Validating architecture page table helpers\n");
976 prot = vm_get_page_prot(VMFLAGS);
977 vaddr = get_random_vaddr();
978 mm = mm_alloc();
979 if (!mm) {
980 pr_err("mm_struct allocation failed\n");
981 return 1;
982 }
983
984 /*
985 * __P000 (or even __S000) will help create page table entries with
986 * PROT_NONE permission as required for pxx_protnone_tests().
987 */
988 protnone = __P000;
989
990 vma = vm_area_alloc(mm);
991 if (!vma) {
992 pr_err("vma allocation failed\n");
993 return 1;
994 }
995
996 /*
997 * PFN for mapping at PTE level is determined from a standard kernel
998 * text symbol. But pfns for higher page table levels are derived by
999 * masking lower bits of this real pfn. These derived pfns might not
1000 * exist on the platform but that does not really matter as pfn_pxx()
1001 * helpers will still create appropriate entries for the test. This
1002 * helps avoid large memory block allocations to be used for mapping
1003 * at higher page table levels.
1004 */
1005 paddr = __pa_symbol(&start_kernel);
1006
1007 pte_aligned = (paddr & PAGE_MASK) >> PAGE_SHIFT;
1008 pmd_aligned = (paddr & PMD_MASK) >> PAGE_SHIFT;
1009 pud_aligned = (paddr & PUD_MASK) >> PAGE_SHIFT;
1010 p4d_aligned = (paddr & P4D_MASK) >> PAGE_SHIFT;
1011 pgd_aligned = (paddr & PGDIR_MASK) >> PAGE_SHIFT;
1012 WARN_ON(!pfn_valid(pte_aligned));
1013
1014 pgdp = pgd_offset(mm, vaddr);
1015 p4dp = p4d_alloc(mm, pgdp, vaddr);
1016 pudp = pud_alloc(mm, p4dp, vaddr);
1017 pmdp = pmd_alloc(mm, pudp, vaddr);
1018 /*
1019 * Allocate pgtable_t
1020 */
1021 if (pte_alloc(mm, pmdp)) {
1022 pr_err("pgtable allocation failed\n");
1023 return 1;
1024 }
1025
1026 /*
1027 * Save all the page table page addresses as the page table
1028 * entries will be used for testing with random or garbage
1029 * values. These saved addresses will be used for freeing
1030 * page table pages.
1031 */
1032 pmd = READ_ONCE(*pmdp);
1033 saved_p4dp = p4d_offset(pgdp, 0UL);
1034 saved_pudp = pud_offset(p4dp, 0UL);
1035 saved_pmdp = pmd_offset(pudp, 0UL);
1036 saved_ptep = pmd_pgtable(pmd);
1037
1038 /*
1039 * Iterate over the protection_map[] to make sure that all
1040 * the basic page table transformation validations just hold
1041 * true irrespective of the starting protection value for a
1042 * given page table entry.
1043 */
1044 for (idx = 0; idx < ARRAY_SIZE(protection_map); idx++) {
1045 pte_basic_tests(pte_aligned, idx);
1046 pmd_basic_tests(pmd_aligned, idx);
1047 pud_basic_tests(mm, pud_aligned, idx);
1048 }
1049
1050 /*
1051 * Both P4D and PGD level tests are very basic which do not
1052 * involve creating page table entries from the protection
1053 * value and the given pfn. Hence just keep them out from
1054 * the above iteration for now to save some test execution
1055 * time.
1056 */
1057 p4d_basic_tests(p4d_aligned, prot);
1058 pgd_basic_tests(pgd_aligned, prot);
1059
1060 pmd_leaf_tests(pmd_aligned, prot);
1061 pud_leaf_tests(pud_aligned, prot);
1062
1063 pte_savedwrite_tests(pte_aligned, protnone);
1064 pmd_savedwrite_tests(pmd_aligned, protnone);
1065
1066 pte_special_tests(pte_aligned, prot);
1067 pte_protnone_tests(pte_aligned, protnone);
1068 pmd_protnone_tests(pmd_aligned, protnone);
1069
1070 pte_devmap_tests(pte_aligned, prot);
1071 pmd_devmap_tests(pmd_aligned, prot);
1072 pud_devmap_tests(pud_aligned, prot);
1073
1074 pte_soft_dirty_tests(pte_aligned, prot);
1075 pmd_soft_dirty_tests(pmd_aligned, prot);
1076 pte_swap_soft_dirty_tests(pte_aligned, prot);
1077 pmd_swap_soft_dirty_tests(pmd_aligned, prot);
1078
1079 pte_swap_tests(pte_aligned, prot);
1080 pmd_swap_tests(pmd_aligned, prot);
1081
1082 swap_migration_tests();
1083
1084 pmd_thp_tests(pmd_aligned, prot);
1085 pud_thp_tests(pud_aligned, prot);
1086
1087 hugetlb_basic_tests(pte_aligned, prot);
1088
1089 /*
1090 * Page table modifying tests. They need to hold
1091 * proper page table lock.
1092 */
1093
1094 ptep = pte_offset_map_lock(mm, pmdp, vaddr, &ptl);
1095 pte_clear_tests(mm, ptep, pte_aligned, vaddr, prot);
1096 pte_advanced_tests(mm, vma, ptep, pte_aligned, vaddr, prot);
1097 pte_unmap_unlock(ptep, ptl);
1098
1099 ptl = pmd_lock(mm, pmdp);
1100 pmd_clear_tests(mm, pmdp);
1101 pmd_advanced_tests(mm, vma, pmdp, pmd_aligned, vaddr, prot, saved_ptep);
1102 pmd_huge_tests(pmdp, pmd_aligned, prot);
1103 pmd_populate_tests(mm, pmdp, saved_ptep);
1104 spin_unlock(ptl);
1105
1106 ptl = pud_lock(mm, pudp);
1107 pud_clear_tests(mm, pudp);
1108 pud_advanced_tests(mm, vma, pudp, pud_aligned, vaddr, prot);
1109 pud_huge_tests(pudp, pud_aligned, prot);
1110 pud_populate_tests(mm, pudp, saved_pmdp);
1111 spin_unlock(ptl);
1112
1113 spin_lock(&mm->page_table_lock);
1114 p4d_clear_tests(mm, p4dp);
1115 pgd_clear_tests(mm, pgdp);
1116 p4d_populate_tests(mm, p4dp, saved_pudp);
1117 pgd_populate_tests(mm, pgdp, saved_p4dp);
1118 spin_unlock(&mm->page_table_lock);
1119
1120 p4d_free(mm, saved_p4dp);
1121 pud_free(mm, saved_pudp);
1122 pmd_free(mm, saved_pmdp);
1123 pte_free(mm, saved_ptep);
1124
1125 vm_area_free(vma);
1126 mm_dec_nr_puds(mm);
1127 mm_dec_nr_pmds(mm);
1128 mm_dec_nr_ptes(mm);
1129 mmdrop(mm);
1130 return 0;
1131}
1132late_initcall(debug_vm_pgtable);
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * This kernel test validates architecture page table helpers and
4 * accessors and helps in verifying their continued compliance with
5 * expected generic MM semantics.
6 *
7 * Copyright (C) 2019 ARM Ltd.
8 *
9 * Author: Anshuman Khandual <anshuman.khandual@arm.com>
10 */
11#define pr_fmt(fmt) "debug_vm_pgtable: [%-25s]: " fmt, __func__
12
13#include <linux/gfp.h>
14#include <linux/highmem.h>
15#include <linux/hugetlb.h>
16#include <linux/kernel.h>
17#include <linux/kconfig.h>
18#include <linux/mm.h>
19#include <linux/mman.h>
20#include <linux/mm_types.h>
21#include <linux/module.h>
22#include <linux/pfn_t.h>
23#include <linux/printk.h>
24#include <linux/pgtable.h>
25#include <linux/random.h>
26#include <linux/spinlock.h>
27#include <linux/swap.h>
28#include <linux/swapops.h>
29#include <linux/start_kernel.h>
30#include <linux/sched/mm.h>
31#include <asm/pgalloc.h>
32#include <asm/tlbflush.h>
33
34/*
35 * Please refer Documentation/vm/arch_pgtable_helpers.rst for the semantics
36 * expectations that are being validated here. All future changes in here
37 * or the documentation need to be in sync.
38 */
39
40#define VMFLAGS (VM_READ|VM_WRITE|VM_EXEC)
41
42/*
43 * On s390 platform, the lower 4 bits are used to identify given page table
44 * entry type. But these bits might affect the ability to clear entries with
45 * pxx_clear() because of how dynamic page table folding works on s390. So
46 * while loading up the entries do not change the lower 4 bits. It does not
47 * have affect any other platform.
48 */
49#define S390_MASK_BITS 4
50#define RANDOM_ORVALUE GENMASK(BITS_PER_LONG - 1, S390_MASK_BITS)
51#define RANDOM_NZVALUE GENMASK(7, 0)
52
53static void __init pte_basic_tests(unsigned long pfn, pgprot_t prot)
54{
55 pte_t pte = pfn_pte(pfn, prot);
56
57 pr_debug("Validating PTE basic\n");
58 WARN_ON(!pte_same(pte, pte));
59 WARN_ON(!pte_young(pte_mkyoung(pte_mkold(pte))));
60 WARN_ON(!pte_dirty(pte_mkdirty(pte_mkclean(pte))));
61 WARN_ON(!pte_write(pte_mkwrite(pte_wrprotect(pte))));
62 WARN_ON(pte_young(pte_mkold(pte_mkyoung(pte))));
63 WARN_ON(pte_dirty(pte_mkclean(pte_mkdirty(pte))));
64 WARN_ON(pte_write(pte_wrprotect(pte_mkwrite(pte))));
65}
66
67static void __init pte_advanced_tests(struct mm_struct *mm,
68 struct vm_area_struct *vma, pte_t *ptep,
69 unsigned long pfn, unsigned long vaddr,
70 pgprot_t prot)
71{
72 pte_t pte = pfn_pte(pfn, prot);
73
74 pr_debug("Validating PTE advanced\n");
75 pte = pfn_pte(pfn, prot);
76 set_pte_at(mm, vaddr, ptep, pte);
77 ptep_set_wrprotect(mm, vaddr, ptep);
78 pte = ptep_get(ptep);
79 WARN_ON(pte_write(pte));
80
81 pte = pfn_pte(pfn, prot);
82 set_pte_at(mm, vaddr, ptep, pte);
83 ptep_get_and_clear(mm, vaddr, ptep);
84 pte = ptep_get(ptep);
85 WARN_ON(!pte_none(pte));
86
87 pte = pfn_pte(pfn, prot);
88 pte = pte_wrprotect(pte);
89 pte = pte_mkclean(pte);
90 set_pte_at(mm, vaddr, ptep, pte);
91 pte = pte_mkwrite(pte);
92 pte = pte_mkdirty(pte);
93 ptep_set_access_flags(vma, vaddr, ptep, pte, 1);
94 pte = ptep_get(ptep);
95 WARN_ON(!(pte_write(pte) && pte_dirty(pte)));
96
97 pte = pfn_pte(pfn, prot);
98 set_pte_at(mm, vaddr, ptep, pte);
99 ptep_get_and_clear_full(mm, vaddr, ptep, 1);
100 pte = ptep_get(ptep);
101 WARN_ON(!pte_none(pte));
102
103 pte = pte_mkyoung(pte);
104 set_pte_at(mm, vaddr, ptep, pte);
105 ptep_test_and_clear_young(vma, vaddr, ptep);
106 pte = ptep_get(ptep);
107 WARN_ON(pte_young(pte));
108}
109
110static void __init pte_savedwrite_tests(unsigned long pfn, pgprot_t prot)
111{
112 pte_t pte = pfn_pte(pfn, prot);
113
114 pr_debug("Validating PTE saved write\n");
115 WARN_ON(!pte_savedwrite(pte_mk_savedwrite(pte_clear_savedwrite(pte))));
116 WARN_ON(pte_savedwrite(pte_clear_savedwrite(pte_mk_savedwrite(pte))));
117}
118#ifdef CONFIG_TRANSPARENT_HUGEPAGE
119static void __init pmd_basic_tests(unsigned long pfn, pgprot_t prot)
120{
121 pmd_t pmd = pfn_pmd(pfn, prot);
122
123 if (!has_transparent_hugepage())
124 return;
125
126 pr_debug("Validating PMD basic\n");
127 WARN_ON(!pmd_same(pmd, pmd));
128 WARN_ON(!pmd_young(pmd_mkyoung(pmd_mkold(pmd))));
129 WARN_ON(!pmd_dirty(pmd_mkdirty(pmd_mkclean(pmd))));
130 WARN_ON(!pmd_write(pmd_mkwrite(pmd_wrprotect(pmd))));
131 WARN_ON(pmd_young(pmd_mkold(pmd_mkyoung(pmd))));
132 WARN_ON(pmd_dirty(pmd_mkclean(pmd_mkdirty(pmd))));
133 WARN_ON(pmd_write(pmd_wrprotect(pmd_mkwrite(pmd))));
134 /*
135 * A huge page does not point to next level page table
136 * entry. Hence this must qualify as pmd_bad().
137 */
138 WARN_ON(!pmd_bad(pmd_mkhuge(pmd)));
139}
140
141static void __init pmd_advanced_tests(struct mm_struct *mm,
142 struct vm_area_struct *vma, pmd_t *pmdp,
143 unsigned long pfn, unsigned long vaddr,
144 pgprot_t prot)
145{
146 pmd_t pmd = pfn_pmd(pfn, prot);
147
148 if (!has_transparent_hugepage())
149 return;
150
151 pr_debug("Validating PMD advanced\n");
152 /* Align the address wrt HPAGE_PMD_SIZE */
153 vaddr = (vaddr & HPAGE_PMD_MASK) + HPAGE_PMD_SIZE;
154
155 pmd = pfn_pmd(pfn, prot);
156 set_pmd_at(mm, vaddr, pmdp, pmd);
157 pmdp_set_wrprotect(mm, vaddr, pmdp);
158 pmd = READ_ONCE(*pmdp);
159 WARN_ON(pmd_write(pmd));
160
161 pmd = pfn_pmd(pfn, prot);
162 set_pmd_at(mm, vaddr, pmdp, pmd);
163 pmdp_huge_get_and_clear(mm, vaddr, pmdp);
164 pmd = READ_ONCE(*pmdp);
165 WARN_ON(!pmd_none(pmd));
166
167 pmd = pfn_pmd(pfn, prot);
168 pmd = pmd_wrprotect(pmd);
169 pmd = pmd_mkclean(pmd);
170 set_pmd_at(mm, vaddr, pmdp, pmd);
171 pmd = pmd_mkwrite(pmd);
172 pmd = pmd_mkdirty(pmd);
173 pmdp_set_access_flags(vma, vaddr, pmdp, pmd, 1);
174 pmd = READ_ONCE(*pmdp);
175 WARN_ON(!(pmd_write(pmd) && pmd_dirty(pmd)));
176
177 pmd = pmd_mkhuge(pfn_pmd(pfn, prot));
178 set_pmd_at(mm, vaddr, pmdp, pmd);
179 pmdp_huge_get_and_clear_full(vma, vaddr, pmdp, 1);
180 pmd = READ_ONCE(*pmdp);
181 WARN_ON(!pmd_none(pmd));
182
183 pmd = pmd_mkyoung(pmd);
184 set_pmd_at(mm, vaddr, pmdp, pmd);
185 pmdp_test_and_clear_young(vma, vaddr, pmdp);
186 pmd = READ_ONCE(*pmdp);
187 WARN_ON(pmd_young(pmd));
188}
189
190static void __init pmd_leaf_tests(unsigned long pfn, pgprot_t prot)
191{
192 pmd_t pmd = pfn_pmd(pfn, prot);
193
194 pr_debug("Validating PMD leaf\n");
195 /*
196 * PMD based THP is a leaf entry.
197 */
198 pmd = pmd_mkhuge(pmd);
199 WARN_ON(!pmd_leaf(pmd));
200}
201
202static void __init pmd_huge_tests(pmd_t *pmdp, unsigned long pfn, pgprot_t prot)
203{
204 pmd_t pmd;
205
206 if (!IS_ENABLED(CONFIG_HAVE_ARCH_HUGE_VMAP))
207 return;
208
209 pr_debug("Validating PMD huge\n");
210 /*
211 * X86 defined pmd_set_huge() verifies that the given
212 * PMD is not a populated non-leaf entry.
213 */
214 WRITE_ONCE(*pmdp, __pmd(0));
215 WARN_ON(!pmd_set_huge(pmdp, __pfn_to_phys(pfn), prot));
216 WARN_ON(!pmd_clear_huge(pmdp));
217 pmd = READ_ONCE(*pmdp);
218 WARN_ON(!pmd_none(pmd));
219}
220
221static void __init pmd_savedwrite_tests(unsigned long pfn, pgprot_t prot)
222{
223 pmd_t pmd = pfn_pmd(pfn, prot);
224
225 pr_debug("Validating PMD saved write\n");
226 WARN_ON(!pmd_savedwrite(pmd_mk_savedwrite(pmd_clear_savedwrite(pmd))));
227 WARN_ON(pmd_savedwrite(pmd_clear_savedwrite(pmd_mk_savedwrite(pmd))));
228}
229
230#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
231static void __init pud_basic_tests(unsigned long pfn, pgprot_t prot)
232{
233 pud_t pud = pfn_pud(pfn, prot);
234
235 if (!has_transparent_hugepage())
236 return;
237
238 pr_debug("Validating PUD basic\n");
239 WARN_ON(!pud_same(pud, pud));
240 WARN_ON(!pud_young(pud_mkyoung(pud_mkold(pud))));
241 WARN_ON(!pud_write(pud_mkwrite(pud_wrprotect(pud))));
242 WARN_ON(pud_write(pud_wrprotect(pud_mkwrite(pud))));
243 WARN_ON(pud_young(pud_mkold(pud_mkyoung(pud))));
244
245 if (mm_pmd_folded(mm))
246 return;
247
248 /*
249 * A huge page does not point to next level page table
250 * entry. Hence this must qualify as pud_bad().
251 */
252 WARN_ON(!pud_bad(pud_mkhuge(pud)));
253}
254
255static void __init pud_advanced_tests(struct mm_struct *mm,
256 struct vm_area_struct *vma, pud_t *pudp,
257 unsigned long pfn, unsigned long vaddr,
258 pgprot_t prot)
259{
260 pud_t pud = pfn_pud(pfn, prot);
261
262 if (!has_transparent_hugepage())
263 return;
264
265 pr_debug("Validating PUD advanced\n");
266 /* Align the address wrt HPAGE_PUD_SIZE */
267 vaddr = (vaddr & HPAGE_PUD_MASK) + HPAGE_PUD_SIZE;
268
269 set_pud_at(mm, vaddr, pudp, pud);
270 pudp_set_wrprotect(mm, vaddr, pudp);
271 pud = READ_ONCE(*pudp);
272 WARN_ON(pud_write(pud));
273
274#ifndef __PAGETABLE_PMD_FOLDED
275 pud = pfn_pud(pfn, prot);
276 set_pud_at(mm, vaddr, pudp, pud);
277 pudp_huge_get_and_clear(mm, vaddr, pudp);
278 pud = READ_ONCE(*pudp);
279 WARN_ON(!pud_none(pud));
280
281 pud = pfn_pud(pfn, prot);
282 set_pud_at(mm, vaddr, pudp, pud);
283 pudp_huge_get_and_clear_full(mm, vaddr, pudp, 1);
284 pud = READ_ONCE(*pudp);
285 WARN_ON(!pud_none(pud));
286#endif /* __PAGETABLE_PMD_FOLDED */
287 pud = pfn_pud(pfn, prot);
288 pud = pud_wrprotect(pud);
289 pud = pud_mkclean(pud);
290 set_pud_at(mm, vaddr, pudp, pud);
291 pud = pud_mkwrite(pud);
292 pud = pud_mkdirty(pud);
293 pudp_set_access_flags(vma, vaddr, pudp, pud, 1);
294 pud = READ_ONCE(*pudp);
295 WARN_ON(!(pud_write(pud) && pud_dirty(pud)));
296
297 pud = pud_mkyoung(pud);
298 set_pud_at(mm, vaddr, pudp, pud);
299 pudp_test_and_clear_young(vma, vaddr, pudp);
300 pud = READ_ONCE(*pudp);
301 WARN_ON(pud_young(pud));
302}
303
304static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot)
305{
306 pud_t pud = pfn_pud(pfn, prot);
307
308 pr_debug("Validating PUD leaf\n");
309 /*
310 * PUD based THP is a leaf entry.
311 */
312 pud = pud_mkhuge(pud);
313 WARN_ON(!pud_leaf(pud));
314}
315
316static void __init pud_huge_tests(pud_t *pudp, unsigned long pfn, pgprot_t prot)
317{
318 pud_t pud;
319
320 if (!IS_ENABLED(CONFIG_HAVE_ARCH_HUGE_VMAP))
321 return;
322
323 pr_debug("Validating PUD huge\n");
324 /*
325 * X86 defined pud_set_huge() verifies that the given
326 * PUD is not a populated non-leaf entry.
327 */
328 WRITE_ONCE(*pudp, __pud(0));
329 WARN_ON(!pud_set_huge(pudp, __pfn_to_phys(pfn), prot));
330 WARN_ON(!pud_clear_huge(pudp));
331 pud = READ_ONCE(*pudp);
332 WARN_ON(!pud_none(pud));
333}
334#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
335static void __init pud_basic_tests(unsigned long pfn, pgprot_t prot) { }
336static void __init pud_advanced_tests(struct mm_struct *mm,
337 struct vm_area_struct *vma, pud_t *pudp,
338 unsigned long pfn, unsigned long vaddr,
339 pgprot_t prot)
340{
341}
342static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot) { }
343static void __init pud_huge_tests(pud_t *pudp, unsigned long pfn, pgprot_t prot)
344{
345}
346#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
347#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
348static void __init pmd_basic_tests(unsigned long pfn, pgprot_t prot) { }
349static void __init pud_basic_tests(unsigned long pfn, pgprot_t prot) { }
350static void __init pmd_advanced_tests(struct mm_struct *mm,
351 struct vm_area_struct *vma, pmd_t *pmdp,
352 unsigned long pfn, unsigned long vaddr,
353 pgprot_t prot)
354{
355}
356static void __init pud_advanced_tests(struct mm_struct *mm,
357 struct vm_area_struct *vma, pud_t *pudp,
358 unsigned long pfn, unsigned long vaddr,
359 pgprot_t prot)
360{
361}
362static void __init pmd_leaf_tests(unsigned long pfn, pgprot_t prot) { }
363static void __init pud_leaf_tests(unsigned long pfn, pgprot_t prot) { }
364static void __init pmd_huge_tests(pmd_t *pmdp, unsigned long pfn, pgprot_t prot)
365{
366}
367static void __init pud_huge_tests(pud_t *pudp, unsigned long pfn, pgprot_t prot)
368{
369}
370static void __init pmd_savedwrite_tests(unsigned long pfn, pgprot_t prot) { }
371#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
372
373static void __init p4d_basic_tests(unsigned long pfn, pgprot_t prot)
374{
375 p4d_t p4d;
376
377 pr_debug("Validating P4D basic\n");
378 memset(&p4d, RANDOM_NZVALUE, sizeof(p4d_t));
379 WARN_ON(!p4d_same(p4d, p4d));
380}
381
382static void __init pgd_basic_tests(unsigned long pfn, pgprot_t prot)
383{
384 pgd_t pgd;
385
386 pr_debug("Validating PGD basic\n");
387 memset(&pgd, RANDOM_NZVALUE, sizeof(pgd_t));
388 WARN_ON(!pgd_same(pgd, pgd));
389}
390
391#ifndef __PAGETABLE_PUD_FOLDED
392static void __init pud_clear_tests(struct mm_struct *mm, pud_t *pudp)
393{
394 pud_t pud = READ_ONCE(*pudp);
395
396 if (mm_pmd_folded(mm))
397 return;
398
399 pr_debug("Validating PUD clear\n");
400 pud = __pud(pud_val(pud) | RANDOM_ORVALUE);
401 WRITE_ONCE(*pudp, pud);
402 pud_clear(pudp);
403 pud = READ_ONCE(*pudp);
404 WARN_ON(!pud_none(pud));
405}
406
407static void __init pud_populate_tests(struct mm_struct *mm, pud_t *pudp,
408 pmd_t *pmdp)
409{
410 pud_t pud;
411
412 if (mm_pmd_folded(mm))
413 return;
414
415 pr_debug("Validating PUD populate\n");
416 /*
417 * This entry points to next level page table page.
418 * Hence this must not qualify as pud_bad().
419 */
420 pmd_clear(pmdp);
421 pud_clear(pudp);
422 pud_populate(mm, pudp, pmdp);
423 pud = READ_ONCE(*pudp);
424 WARN_ON(pud_bad(pud));
425}
426#else /* !__PAGETABLE_PUD_FOLDED */
427static void __init pud_clear_tests(struct mm_struct *mm, pud_t *pudp) { }
428static void __init pud_populate_tests(struct mm_struct *mm, pud_t *pudp,
429 pmd_t *pmdp)
430{
431}
432#endif /* PAGETABLE_PUD_FOLDED */
433
434#ifndef __PAGETABLE_P4D_FOLDED
435static void __init p4d_clear_tests(struct mm_struct *mm, p4d_t *p4dp)
436{
437 p4d_t p4d = READ_ONCE(*p4dp);
438
439 if (mm_pud_folded(mm))
440 return;
441
442 pr_debug("Validating P4D clear\n");
443 p4d = __p4d(p4d_val(p4d) | RANDOM_ORVALUE);
444 WRITE_ONCE(*p4dp, p4d);
445 p4d_clear(p4dp);
446 p4d = READ_ONCE(*p4dp);
447 WARN_ON(!p4d_none(p4d));
448}
449
450static void __init p4d_populate_tests(struct mm_struct *mm, p4d_t *p4dp,
451 pud_t *pudp)
452{
453 p4d_t p4d;
454
455 if (mm_pud_folded(mm))
456 return;
457
458 pr_debug("Validating P4D populate\n");
459 /*
460 * This entry points to next level page table page.
461 * Hence this must not qualify as p4d_bad().
462 */
463 pud_clear(pudp);
464 p4d_clear(p4dp);
465 p4d_populate(mm, p4dp, pudp);
466 p4d = READ_ONCE(*p4dp);
467 WARN_ON(p4d_bad(p4d));
468}
469
470static void __init pgd_clear_tests(struct mm_struct *mm, pgd_t *pgdp)
471{
472 pgd_t pgd = READ_ONCE(*pgdp);
473
474 if (mm_p4d_folded(mm))
475 return;
476
477 pr_debug("Validating PGD clear\n");
478 pgd = __pgd(pgd_val(pgd) | RANDOM_ORVALUE);
479 WRITE_ONCE(*pgdp, pgd);
480 pgd_clear(pgdp);
481 pgd = READ_ONCE(*pgdp);
482 WARN_ON(!pgd_none(pgd));
483}
484
485static void __init pgd_populate_tests(struct mm_struct *mm, pgd_t *pgdp,
486 p4d_t *p4dp)
487{
488 pgd_t pgd;
489
490 if (mm_p4d_folded(mm))
491 return;
492
493 pr_debug("Validating PGD populate\n");
494 /*
495 * This entry points to next level page table page.
496 * Hence this must not qualify as pgd_bad().
497 */
498 p4d_clear(p4dp);
499 pgd_clear(pgdp);
500 pgd_populate(mm, pgdp, p4dp);
501 pgd = READ_ONCE(*pgdp);
502 WARN_ON(pgd_bad(pgd));
503}
504#else /* !__PAGETABLE_P4D_FOLDED */
505static void __init p4d_clear_tests(struct mm_struct *mm, p4d_t *p4dp) { }
506static void __init pgd_clear_tests(struct mm_struct *mm, pgd_t *pgdp) { }
507static void __init p4d_populate_tests(struct mm_struct *mm, p4d_t *p4dp,
508 pud_t *pudp)
509{
510}
511static void __init pgd_populate_tests(struct mm_struct *mm, pgd_t *pgdp,
512 p4d_t *p4dp)
513{
514}
515#endif /* PAGETABLE_P4D_FOLDED */
516
517static void __init pte_clear_tests(struct mm_struct *mm, pte_t *ptep,
518 unsigned long vaddr)
519{
520 pte_t pte = ptep_get(ptep);
521
522 pr_debug("Validating PTE clear\n");
523 pte = __pte(pte_val(pte) | RANDOM_ORVALUE);
524 set_pte_at(mm, vaddr, ptep, pte);
525 barrier();
526 pte_clear(mm, vaddr, ptep);
527 pte = ptep_get(ptep);
528 WARN_ON(!pte_none(pte));
529}
530
531static void __init pmd_clear_tests(struct mm_struct *mm, pmd_t *pmdp)
532{
533 pmd_t pmd = READ_ONCE(*pmdp);
534
535 pr_debug("Validating PMD clear\n");
536 pmd = __pmd(pmd_val(pmd) | RANDOM_ORVALUE);
537 WRITE_ONCE(*pmdp, pmd);
538 pmd_clear(pmdp);
539 pmd = READ_ONCE(*pmdp);
540 WARN_ON(!pmd_none(pmd));
541}
542
543static void __init pmd_populate_tests(struct mm_struct *mm, pmd_t *pmdp,
544 pgtable_t pgtable)
545{
546 pmd_t pmd;
547
548 pr_debug("Validating PMD populate\n");
549 /*
550 * This entry points to next level page table page.
551 * Hence this must not qualify as pmd_bad().
552 */
553 pmd_clear(pmdp);
554 pmd_populate(mm, pmdp, pgtable);
555 pmd = READ_ONCE(*pmdp);
556 WARN_ON(pmd_bad(pmd));
557}
558
559static void __init pte_special_tests(unsigned long pfn, pgprot_t prot)
560{
561 pte_t pte = pfn_pte(pfn, prot);
562
563 if (!IS_ENABLED(CONFIG_ARCH_HAS_PTE_SPECIAL))
564 return;
565
566 pr_debug("Validating PTE special\n");
567 WARN_ON(!pte_special(pte_mkspecial(pte)));
568}
569
570static void __init pte_protnone_tests(unsigned long pfn, pgprot_t prot)
571{
572 pte_t pte = pfn_pte(pfn, prot);
573
574 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
575 return;
576
577 pr_debug("Validating PTE protnone\n");
578 WARN_ON(!pte_protnone(pte));
579 WARN_ON(!pte_present(pte));
580}
581
582#ifdef CONFIG_TRANSPARENT_HUGEPAGE
583static void __init pmd_protnone_tests(unsigned long pfn, pgprot_t prot)
584{
585 pmd_t pmd = pmd_mkhuge(pfn_pmd(pfn, prot));
586
587 if (!IS_ENABLED(CONFIG_NUMA_BALANCING))
588 return;
589
590 pr_debug("Validating PMD protnone\n");
591 WARN_ON(!pmd_protnone(pmd));
592 WARN_ON(!pmd_present(pmd));
593}
594#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
595static void __init pmd_protnone_tests(unsigned long pfn, pgprot_t prot) { }
596#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
597
598#ifdef CONFIG_ARCH_HAS_PTE_DEVMAP
599static void __init pte_devmap_tests(unsigned long pfn, pgprot_t prot)
600{
601 pte_t pte = pfn_pte(pfn, prot);
602
603 pr_debug("Validating PTE devmap\n");
604 WARN_ON(!pte_devmap(pte_mkdevmap(pte)));
605}
606
607#ifdef CONFIG_TRANSPARENT_HUGEPAGE
608static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot)
609{
610 pmd_t pmd = pfn_pmd(pfn, prot);
611
612 pr_debug("Validating PMD devmap\n");
613 WARN_ON(!pmd_devmap(pmd_mkdevmap(pmd)));
614}
615
616#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
617static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot)
618{
619 pud_t pud = pfn_pud(pfn, prot);
620
621 pr_debug("Validating PUD devmap\n");
622 WARN_ON(!pud_devmap(pud_mkdevmap(pud)));
623}
624#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
625static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
626#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
627#else /* CONFIG_TRANSPARENT_HUGEPAGE */
628static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot) { }
629static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
630#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
631#else
632static void __init pte_devmap_tests(unsigned long pfn, pgprot_t prot) { }
633static void __init pmd_devmap_tests(unsigned long pfn, pgprot_t prot) { }
634static void __init pud_devmap_tests(unsigned long pfn, pgprot_t prot) { }
635#endif /* CONFIG_ARCH_HAS_PTE_DEVMAP */
636
637static void __init pte_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
638{
639 pte_t pte = pfn_pte(pfn, prot);
640
641 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
642 return;
643
644 pr_debug("Validating PTE soft dirty\n");
645 WARN_ON(!pte_soft_dirty(pte_mksoft_dirty(pte)));
646 WARN_ON(pte_soft_dirty(pte_clear_soft_dirty(pte)));
647}
648
649static void __init pte_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
650{
651 pte_t pte = pfn_pte(pfn, prot);
652
653 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
654 return;
655
656 pr_debug("Validating PTE swap soft dirty\n");
657 WARN_ON(!pte_swp_soft_dirty(pte_swp_mksoft_dirty(pte)));
658 WARN_ON(pte_swp_soft_dirty(pte_swp_clear_soft_dirty(pte)));
659}
660
661#ifdef CONFIG_TRANSPARENT_HUGEPAGE
662static void __init pmd_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
663{
664 pmd_t pmd = pfn_pmd(pfn, prot);
665
666 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY))
667 return;
668
669 pr_debug("Validating PMD soft dirty\n");
670 WARN_ON(!pmd_soft_dirty(pmd_mksoft_dirty(pmd)));
671 WARN_ON(pmd_soft_dirty(pmd_clear_soft_dirty(pmd)));
672}
673
674static void __init pmd_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
675{
676 pmd_t pmd = pfn_pmd(pfn, prot);
677
678 if (!IS_ENABLED(CONFIG_MEM_SOFT_DIRTY) ||
679 !IS_ENABLED(CONFIG_ARCH_ENABLE_THP_MIGRATION))
680 return;
681
682 pr_debug("Validating PMD swap soft dirty\n");
683 WARN_ON(!pmd_swp_soft_dirty(pmd_swp_mksoft_dirty(pmd)));
684 WARN_ON(pmd_swp_soft_dirty(pmd_swp_clear_soft_dirty(pmd)));
685}
686#else /* !CONFIG_ARCH_HAS_PTE_DEVMAP */
687static void __init pmd_soft_dirty_tests(unsigned long pfn, pgprot_t prot) { }
688static void __init pmd_swap_soft_dirty_tests(unsigned long pfn, pgprot_t prot)
689{
690}
691#endif /* CONFIG_ARCH_HAS_PTE_DEVMAP */
692
693static void __init pte_swap_tests(unsigned long pfn, pgprot_t prot)
694{
695 swp_entry_t swp;
696 pte_t pte;
697
698 pr_debug("Validating PTE swap\n");
699 pte = pfn_pte(pfn, prot);
700 swp = __pte_to_swp_entry(pte);
701 pte = __swp_entry_to_pte(swp);
702 WARN_ON(pfn != pte_pfn(pte));
703}
704
705#ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
706static void __init pmd_swap_tests(unsigned long pfn, pgprot_t prot)
707{
708 swp_entry_t swp;
709 pmd_t pmd;
710
711 pr_debug("Validating PMD swap\n");
712 pmd = pfn_pmd(pfn, prot);
713 swp = __pmd_to_swp_entry(pmd);
714 pmd = __swp_entry_to_pmd(swp);
715 WARN_ON(pfn != pmd_pfn(pmd));
716}
717#else /* !CONFIG_ARCH_ENABLE_THP_MIGRATION */
718static void __init pmd_swap_tests(unsigned long pfn, pgprot_t prot) { }
719#endif /* CONFIG_ARCH_ENABLE_THP_MIGRATION */
720
721static void __init swap_migration_tests(void)
722{
723 struct page *page;
724 swp_entry_t swp;
725
726 if (!IS_ENABLED(CONFIG_MIGRATION))
727 return;
728
729 pr_debug("Validating swap migration\n");
730 /*
731 * swap_migration_tests() requires a dedicated page as it needs to
732 * be locked before creating a migration entry from it. Locking the
733 * page that actually maps kernel text ('start_kernel') can be real
734 * problematic. Lets allocate a dedicated page explicitly for this
735 * purpose that will be freed subsequently.
736 */
737 page = alloc_page(GFP_KERNEL);
738 if (!page) {
739 pr_err("page allocation failed\n");
740 return;
741 }
742
743 /*
744 * make_migration_entry() expects given page to be
745 * locked, otherwise it stumbles upon a BUG_ON().
746 */
747 __SetPageLocked(page);
748 swp = make_migration_entry(page, 1);
749 WARN_ON(!is_migration_entry(swp));
750 WARN_ON(!is_write_migration_entry(swp));
751
752 make_migration_entry_read(&swp);
753 WARN_ON(!is_migration_entry(swp));
754 WARN_ON(is_write_migration_entry(swp));
755
756 swp = make_migration_entry(page, 0);
757 WARN_ON(!is_migration_entry(swp));
758 WARN_ON(is_write_migration_entry(swp));
759 __ClearPageLocked(page);
760 __free_page(page);
761}
762
763#ifdef CONFIG_HUGETLB_PAGE
764static void __init hugetlb_basic_tests(unsigned long pfn, pgprot_t prot)
765{
766 struct page *page;
767 pte_t pte;
768
769 pr_debug("Validating HugeTLB basic\n");
770 /*
771 * Accessing the page associated with the pfn is safe here,
772 * as it was previously derived from a real kernel symbol.
773 */
774 page = pfn_to_page(pfn);
775 pte = mk_huge_pte(page, prot);
776
777 WARN_ON(!huge_pte_dirty(huge_pte_mkdirty(pte)));
778 WARN_ON(!huge_pte_write(huge_pte_mkwrite(huge_pte_wrprotect(pte))));
779 WARN_ON(huge_pte_write(huge_pte_wrprotect(huge_pte_mkwrite(pte))));
780
781#ifdef CONFIG_ARCH_WANT_GENERAL_HUGETLB
782 pte = pfn_pte(pfn, prot);
783
784 WARN_ON(!pte_huge(pte_mkhuge(pte)));
785#endif /* CONFIG_ARCH_WANT_GENERAL_HUGETLB */
786}
787
788static void __init hugetlb_advanced_tests(struct mm_struct *mm,
789 struct vm_area_struct *vma,
790 pte_t *ptep, unsigned long pfn,
791 unsigned long vaddr, pgprot_t prot)
792{
793 struct page *page = pfn_to_page(pfn);
794 pte_t pte = ptep_get(ptep);
795 unsigned long paddr = __pfn_to_phys(pfn) & PMD_MASK;
796
797 pr_debug("Validating HugeTLB advanced\n");
798 pte = pte_mkhuge(mk_pte(pfn_to_page(PHYS_PFN(paddr)), prot));
799 set_huge_pte_at(mm, vaddr, ptep, pte);
800 barrier();
801 WARN_ON(!pte_same(pte, huge_ptep_get(ptep)));
802 huge_pte_clear(mm, vaddr, ptep, PMD_SIZE);
803 pte = huge_ptep_get(ptep);
804 WARN_ON(!huge_pte_none(pte));
805
806 pte = mk_huge_pte(page, prot);
807 set_huge_pte_at(mm, vaddr, ptep, pte);
808 barrier();
809 huge_ptep_set_wrprotect(mm, vaddr, ptep);
810 pte = huge_ptep_get(ptep);
811 WARN_ON(huge_pte_write(pte));
812
813 pte = mk_huge_pte(page, prot);
814 set_huge_pte_at(mm, vaddr, ptep, pte);
815 barrier();
816 huge_ptep_get_and_clear(mm, vaddr, ptep);
817 pte = huge_ptep_get(ptep);
818 WARN_ON(!huge_pte_none(pte));
819
820 pte = mk_huge_pte(page, prot);
821 pte = huge_pte_wrprotect(pte);
822 set_huge_pte_at(mm, vaddr, ptep, pte);
823 barrier();
824 pte = huge_pte_mkwrite(pte);
825 pte = huge_pte_mkdirty(pte);
826 huge_ptep_set_access_flags(vma, vaddr, ptep, pte, 1);
827 pte = huge_ptep_get(ptep);
828 WARN_ON(!(huge_pte_write(pte) && huge_pte_dirty(pte)));
829}
830#else /* !CONFIG_HUGETLB_PAGE */
831static void __init hugetlb_basic_tests(unsigned long pfn, pgprot_t prot) { }
832static void __init hugetlb_advanced_tests(struct mm_struct *mm,
833 struct vm_area_struct *vma,
834 pte_t *ptep, unsigned long pfn,
835 unsigned long vaddr, pgprot_t prot)
836{
837}
838#endif /* CONFIG_HUGETLB_PAGE */
839
840#ifdef CONFIG_TRANSPARENT_HUGEPAGE
841static void __init pmd_thp_tests(unsigned long pfn, pgprot_t prot)
842{
843 pmd_t pmd;
844
845 if (!has_transparent_hugepage())
846 return;
847
848 pr_debug("Validating PMD based THP\n");
849 /*
850 * pmd_trans_huge() and pmd_present() must return positive after
851 * MMU invalidation with pmd_mkinvalid(). This behavior is an
852 * optimization for transparent huge page. pmd_trans_huge() must
853 * be true if pmd_page() returns a valid THP to avoid taking the
854 * pmd_lock when others walk over non transhuge pmds (i.e. there
855 * are no THP allocated). Especially when splitting a THP and
856 * removing the present bit from the pmd, pmd_trans_huge() still
857 * needs to return true. pmd_present() should be true whenever
858 * pmd_trans_huge() returns true.
859 */
860 pmd = pfn_pmd(pfn, prot);
861 WARN_ON(!pmd_trans_huge(pmd_mkhuge(pmd)));
862
863#ifndef __HAVE_ARCH_PMDP_INVALIDATE
864 WARN_ON(!pmd_trans_huge(pmd_mkinvalid(pmd_mkhuge(pmd))));
865 WARN_ON(!pmd_present(pmd_mkinvalid(pmd_mkhuge(pmd))));
866#endif /* __HAVE_ARCH_PMDP_INVALIDATE */
867}
868
869#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
870static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot)
871{
872 pud_t pud;
873
874 if (!has_transparent_hugepage())
875 return;
876
877 pr_debug("Validating PUD based THP\n");
878 pud = pfn_pud(pfn, prot);
879 WARN_ON(!pud_trans_huge(pud_mkhuge(pud)));
880
881 /*
882 * pud_mkinvalid() has been dropped for now. Enable back
883 * these tests when it comes back with a modified pud_present().
884 *
885 * WARN_ON(!pud_trans_huge(pud_mkinvalid(pud_mkhuge(pud))));
886 * WARN_ON(!pud_present(pud_mkinvalid(pud_mkhuge(pud))));
887 */
888}
889#else /* !CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
890static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot) { }
891#endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
892#else /* !CONFIG_TRANSPARENT_HUGEPAGE */
893static void __init pmd_thp_tests(unsigned long pfn, pgprot_t prot) { }
894static void __init pud_thp_tests(unsigned long pfn, pgprot_t prot) { }
895#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
896
897static unsigned long __init get_random_vaddr(void)
898{
899 unsigned long random_vaddr, random_pages, total_user_pages;
900
901 total_user_pages = (TASK_SIZE - FIRST_USER_ADDRESS) / PAGE_SIZE;
902
903 random_pages = get_random_long() % total_user_pages;
904 random_vaddr = FIRST_USER_ADDRESS + random_pages * PAGE_SIZE;
905
906 return random_vaddr;
907}
908
909static int __init debug_vm_pgtable(void)
910{
911 struct vm_area_struct *vma;
912 struct mm_struct *mm;
913 pgd_t *pgdp;
914 p4d_t *p4dp, *saved_p4dp;
915 pud_t *pudp, *saved_pudp;
916 pmd_t *pmdp, *saved_pmdp, pmd;
917 pte_t *ptep;
918 pgtable_t saved_ptep;
919 pgprot_t prot, protnone;
920 phys_addr_t paddr;
921 unsigned long vaddr, pte_aligned, pmd_aligned;
922 unsigned long pud_aligned, p4d_aligned, pgd_aligned;
923 spinlock_t *ptl = NULL;
924
925 pr_info("Validating architecture page table helpers\n");
926 prot = vm_get_page_prot(VMFLAGS);
927 vaddr = get_random_vaddr();
928 mm = mm_alloc();
929 if (!mm) {
930 pr_err("mm_struct allocation failed\n");
931 return 1;
932 }
933
934 /*
935 * __P000 (or even __S000) will help create page table entries with
936 * PROT_NONE permission as required for pxx_protnone_tests().
937 */
938 protnone = __P000;
939
940 vma = vm_area_alloc(mm);
941 if (!vma) {
942 pr_err("vma allocation failed\n");
943 return 1;
944 }
945
946 /*
947 * PFN for mapping at PTE level is determined from a standard kernel
948 * text symbol. But pfns for higher page table levels are derived by
949 * masking lower bits of this real pfn. These derived pfns might not
950 * exist on the platform but that does not really matter as pfn_pxx()
951 * helpers will still create appropriate entries for the test. This
952 * helps avoid large memory block allocations to be used for mapping
953 * at higher page table levels.
954 */
955 paddr = __pa_symbol(&start_kernel);
956
957 pte_aligned = (paddr & PAGE_MASK) >> PAGE_SHIFT;
958 pmd_aligned = (paddr & PMD_MASK) >> PAGE_SHIFT;
959 pud_aligned = (paddr & PUD_MASK) >> PAGE_SHIFT;
960 p4d_aligned = (paddr & P4D_MASK) >> PAGE_SHIFT;
961 pgd_aligned = (paddr & PGDIR_MASK) >> PAGE_SHIFT;
962 WARN_ON(!pfn_valid(pte_aligned));
963
964 pgdp = pgd_offset(mm, vaddr);
965 p4dp = p4d_alloc(mm, pgdp, vaddr);
966 pudp = pud_alloc(mm, p4dp, vaddr);
967 pmdp = pmd_alloc(mm, pudp, vaddr);
968 ptep = pte_alloc_map_lock(mm, pmdp, vaddr, &ptl);
969
970 /*
971 * Save all the page table page addresses as the page table
972 * entries will be used for testing with random or garbage
973 * values. These saved addresses will be used for freeing
974 * page table pages.
975 */
976 pmd = READ_ONCE(*pmdp);
977 saved_p4dp = p4d_offset(pgdp, 0UL);
978 saved_pudp = pud_offset(p4dp, 0UL);
979 saved_pmdp = pmd_offset(pudp, 0UL);
980 saved_ptep = pmd_pgtable(pmd);
981
982 pte_basic_tests(pte_aligned, prot);
983 pmd_basic_tests(pmd_aligned, prot);
984 pud_basic_tests(pud_aligned, prot);
985 p4d_basic_tests(p4d_aligned, prot);
986 pgd_basic_tests(pgd_aligned, prot);
987
988 pte_clear_tests(mm, ptep, vaddr);
989 pmd_clear_tests(mm, pmdp);
990 pud_clear_tests(mm, pudp);
991 p4d_clear_tests(mm, p4dp);
992 pgd_clear_tests(mm, pgdp);
993
994 pte_advanced_tests(mm, vma, ptep, pte_aligned, vaddr, prot);
995 pmd_advanced_tests(mm, vma, pmdp, pmd_aligned, vaddr, prot);
996 pud_advanced_tests(mm, vma, pudp, pud_aligned, vaddr, prot);
997 hugetlb_advanced_tests(mm, vma, ptep, pte_aligned, vaddr, prot);
998
999 pmd_leaf_tests(pmd_aligned, prot);
1000 pud_leaf_tests(pud_aligned, prot);
1001
1002 pmd_huge_tests(pmdp, pmd_aligned, prot);
1003 pud_huge_tests(pudp, pud_aligned, prot);
1004
1005 pte_savedwrite_tests(pte_aligned, prot);
1006 pmd_savedwrite_tests(pmd_aligned, prot);
1007
1008 pte_unmap_unlock(ptep, ptl);
1009
1010 pmd_populate_tests(mm, pmdp, saved_ptep);
1011 pud_populate_tests(mm, pudp, saved_pmdp);
1012 p4d_populate_tests(mm, p4dp, saved_pudp);
1013 pgd_populate_tests(mm, pgdp, saved_p4dp);
1014
1015 pte_special_tests(pte_aligned, prot);
1016 pte_protnone_tests(pte_aligned, protnone);
1017 pmd_protnone_tests(pmd_aligned, protnone);
1018
1019 pte_devmap_tests(pte_aligned, prot);
1020 pmd_devmap_tests(pmd_aligned, prot);
1021 pud_devmap_tests(pud_aligned, prot);
1022
1023 pte_soft_dirty_tests(pte_aligned, prot);
1024 pmd_soft_dirty_tests(pmd_aligned, prot);
1025 pte_swap_soft_dirty_tests(pte_aligned, prot);
1026 pmd_swap_soft_dirty_tests(pmd_aligned, prot);
1027
1028 pte_swap_tests(pte_aligned, prot);
1029 pmd_swap_tests(pmd_aligned, prot);
1030
1031 swap_migration_tests();
1032 hugetlb_basic_tests(pte_aligned, prot);
1033
1034 pmd_thp_tests(pmd_aligned, prot);
1035 pud_thp_tests(pud_aligned, prot);
1036
1037 p4d_free(mm, saved_p4dp);
1038 pud_free(mm, saved_pudp);
1039 pmd_free(mm, saved_pmdp);
1040 pte_free(mm, saved_ptep);
1041
1042 vm_area_free(vma);
1043 mm_dec_nr_puds(mm);
1044 mm_dec_nr_pmds(mm);
1045 mm_dec_nr_ptes(mm);
1046 mmdrop(mm);
1047 return 0;
1048}
1049late_initcall(debug_vm_pgtable);