xref: /freebsd/sys/arm64/include/pmap.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * Copyright (c) 1991 Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * the Systems Programming Group of the University of Utah Computer
7  * Science Department and William Jolitz of UUNET Technologies Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 #ifdef __arm__
35 #include <arm/pmap.h>
36 #else /* !__arm__ */
37 
38 #ifndef _MACHINE_PMAP_H_
39 #define	_MACHINE_PMAP_H_
40 
41 #include <machine/pte.h>
42 
43 #ifndef LOCORE
44 
45 #include <sys/queue.h>
46 #include <sys/_lock.h>
47 #include <sys/_mutex.h>
48 #include <sys/_pv_entry.h>
49 
50 #include <vm/_vm_radix.h>
51 
52 #ifdef _KERNEL
53 
54 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
55 
56 #endif
57 
58 #define	pmap_page_get_memattr(m)	((m)->md.pv_memattr)
59 #define	pmap_page_is_write_mapped(m)	(((m)->a.flags & PGA_WRITEABLE) != 0)
60 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
61 
62 /*
63  * Pmap stuff
64  */
65 
66 struct rangeset;
67 
68 struct md_page {
69 	TAILQ_HEAD(,pv_entry)	pv_list;
70 	int			pv_gen;
71 	vm_memattr_t		pv_memattr;
72 };
73 
74 /*
75  * This structure is used to hold a virtual<->physical address
76  * association and is used mostly by bootstrap code
77  */
78 struct pv_addr {
79 	SLIST_ENTRY(pv_addr) pv_list;
80 	vm_offset_t	pv_va;
81 	vm_paddr_t	pv_pa;
82 };
83 
84 enum pmap_stage {
85 	PM_INVALID,
86 	PM_STAGE1,
87 	PM_STAGE2,
88 };
89 
90 struct pmap {
91 	struct mtx		pm_mtx;
92 	struct pmap_statistics	pm_stats;	/* pmap statistics */
93 	uint64_t		pm_ttbr;
94 	vm_paddr_t		pm_l0_paddr;
95 	pd_entry_t		*pm_l0;
96 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
97 	struct vm_radix		pm_root;	/* spare page table pages */
98 	long			pm_cookie;	/* encodes the pmap's ASID */
99 	struct asid_set		*pm_asid_set;	/* The ASID/VMID set to use */
100 	enum pmap_stage		pm_stage;
101 	int			pm_levels;
102 	struct rangeset		*pm_bti;
103 	uint64_t		pm_reserved[3];
104 };
105 typedef struct pmap *pmap_t;
106 
107 struct thread;
108 
109 #ifdef _KERNEL
110 extern struct pmap	kernel_pmap_store;
111 #define	kernel_pmap	(&kernel_pmap_store)
112 #define	pmap_kernel()	kernel_pmap
113 
114 #define	PMAP_ASSERT_LOCKED(pmap) \
115 				mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
116 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
117 #define	PMAP_LOCK_ASSERT(pmap, type) \
118 				mtx_assert(&(pmap)->pm_mtx, (type))
119 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
120 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
121 				    NULL, MTX_DEF | MTX_DUPOK)
122 #define	PMAP_OWNED(pmap)	mtx_owned(&(pmap)->pm_mtx)
123 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
124 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
125 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
126 
127 #define	ASID_RESERVED_FOR_PID_0	0
128 #define	ASID_RESERVED_FOR_EFI	1
129 #define	ASID_FIRST_AVAILABLE	(ASID_RESERVED_FOR_EFI + 1)
130 #define	ASID_TO_OPERAND(asid)	({					\
131 	KASSERT((asid) != -1, ("invalid ASID"));			\
132 	(uint64_t)(asid) << TTBR_ASID_SHIFT;			\
133 })
134 
135 #define	PMAP_WANT_ACTIVE_CPUS_NAIVE
136 
137 extern vm_offset_t virtual_avail;
138 extern vm_offset_t virtual_end;
139 
140 /*
141  * Macros to test if a mapping is mappable with an L1 Section mapping
142  * or an L2 Large Page mapping.
143  */
144 #define	L1_MAPPABLE_P(va, pa, size)					\
145 	((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
146 
147 #define	pmap_vm_page_alloc_check(m)
148 
149 void	pmap_activate_vm(pmap_t);
150 void	pmap_bootstrap(vm_size_t);
151 int	pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
152 int	pmap_change_prot(vm_offset_t va, vm_size_t size, vm_prot_t prot);
153 void	pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
154 void	pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
155 bool	pmap_klookup(vm_offset_t va, vm_paddr_t *pa);
156 vm_paddr_t pmap_kextract(vm_offset_t va);
157 void	pmap_kremove(vm_offset_t);
158 void	pmap_kremove_device(vm_offset_t, vm_size_t);
159 void	*pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma);
160 bool	pmap_page_is_mapped(vm_page_t m);
161 int	pmap_pinit_stage(pmap_t, enum pmap_stage, int);
162 bool	pmap_ps_enabled(pmap_t pmap);
163 uint64_t pmap_to_ttbr0(pmap_t pmap);
164 void	pmap_disable_promotion(vm_offset_t sva, vm_size_t size);
165 void	pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t);
166 
167 void	*pmap_mapdev(vm_paddr_t, vm_size_t);
168 void	*pmap_mapbios(vm_paddr_t, vm_size_t);
169 void	pmap_unmapdev(void *, vm_size_t);
170 void	pmap_unmapbios(void *, vm_size_t);
171 
172 bool	pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, bool);
173 void	pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, bool);
174 
175 bool	pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
176     pd_entry_t **, pt_entry_t **);
177 
178 int	pmap_fault(pmap_t, uint64_t, uint64_t);
179 
180 struct pcb *pmap_switch(struct thread *);
181 
182 extern void (*pmap_clean_stage2_tlbi)(void);
183 extern void (*pmap_invalidate_vpipt_icache)(void);
184 extern void (*pmap_stage2_invalidate_range)(uint64_t, vm_offset_t, vm_offset_t,
185     bool);
186 extern void (*pmap_stage2_invalidate_all)(uint64_t);
187 
188 int pmap_vmspace_copy(pmap_t, pmap_t);
189 
190 int pmap_bti_set(pmap_t, vm_offset_t, vm_offset_t);
191 int pmap_bti_clear(pmap_t, vm_offset_t, vm_offset_t);
192 
193 #if defined(KASAN) || defined(KMSAN)
194 struct arm64_bootparams;
195 
196 void	pmap_bootstrap_san(void);
197 void	pmap_san_enter(vm_offset_t);
198 #endif
199 
200 #endif	/* _KERNEL */
201 
202 #endif	/* !LOCORE */
203 
204 #endif	/* !_MACHINE_PMAP_H_ */
205 
206 #endif /* !__arm__ */
207