1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2014 ARM Ltd.
4  */
5 #ifndef __ASM_PTDUMP_H
6 #define __ASM_PTDUMP_H
7 
8 #include <linux/ptdump.h>
9 
10 #ifdef CONFIG_PTDUMP
11 
12 #include <linux/mm_types.h>
13 #include <linux/seq_file.h>
14 
15 struct addr_marker {
16 	unsigned long start_address;
17 	char *name;
18 };
19 
20 struct ptdump_info {
21 	struct mm_struct		*mm;
22 	const struct addr_marker	*markers;
23 	unsigned long			base_addr;
24 };
25 
26 struct ptdump_prot_bits {
27 	ptdesc_t	mask;
28 	ptdesc_t	val;
29 	const char	*set;
30 	const char	*clear;
31 };
32 
33 struct ptdump_pg_level {
34 	const struct ptdump_prot_bits *bits;
35 	char name[4];
36 	int num;
37 	ptdesc_t mask;
38 };
39 
40 /*
41  * The page dumper groups page table entries of the same type into a single
42  * description. It uses pg_state to track the range information while
43  * iterating over the pte entries. When the continuity is broken it then
44  * dumps out a description of the range.
45  */
46 struct ptdump_pg_state {
47 	struct ptdump_state ptdump;
48 	struct ptdump_pg_level *pg_level;
49 	struct seq_file *seq;
50 	const struct addr_marker *marker;
51 	const struct mm_struct *mm;
52 	unsigned long start_address;
53 	int level;
54 	ptdesc_t current_prot;
55 	bool check_wx;
56 	unsigned long wx_pages;
57 	unsigned long uxn_pages;
58 };
59 
60 void ptdump_walk(struct seq_file *s, struct ptdump_info *info);
61 void note_page(struct ptdump_state *pt_st, unsigned long addr, int level,
62 	       pteval_t val);
63 void note_page_pte(struct ptdump_state *st, unsigned long addr, pte_t pte);
64 void note_page_pmd(struct ptdump_state *st, unsigned long addr, pmd_t pmd);
65 void note_page_pud(struct ptdump_state *st, unsigned long addr, pud_t pud);
66 void note_page_p4d(struct ptdump_state *st, unsigned long addr, p4d_t p4d);
67 void note_page_pgd(struct ptdump_state *st, unsigned long addr, pgd_t pgd);
68 void note_page_flush(struct ptdump_state *st);
69 #ifdef CONFIG_PTDUMP_DEBUGFS
70 #define EFI_RUNTIME_MAP_END	DEFAULT_MAP_WINDOW_64
71 void __init ptdump_debugfs_register(struct ptdump_info *info, const char *name);
72 #else
73 static inline void ptdump_debugfs_register(struct ptdump_info *info,
74 					   const char *name) { }
75 #endif /* CONFIG_PTDUMP_DEBUGFS */
76 #else
77 static inline void note_page(struct ptdump_state *pt_st, unsigned long addr,
78 			     int level, pteval_t val) { }
79 static inline void note_page_pte(struct ptdump_state *st, unsigned long addr, pte_t pte) { }
80 static inline void note_page_pmd(struct ptdump_state *st, unsigned long addr, pmd_t pmd) { }
81 static inline void note_page_pud(struct ptdump_state *st, unsigned long addr, pud_t pud) { }
82 static inline void note_page_p4d(struct ptdump_state *st, unsigned long addr, p4d_t p4d) { }
83 static inline void note_page_pgd(struct ptdump_state *st, unsigned long addr, pgd_t pgd) { }
84 static inline void note_page_flush(struct ptdump_state *st) { }
85 #endif /* CONFIG_PTDUMP */
86 
87 #endif /* __ASM_PTDUMP_H */
88