xref: /freebsd/sys/arm64/include/pmap.h (revision d37eb51047221dc3322b34db1038ff3aa533883f)
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 enum pmap_stage {
75 	PM_INVALID,
76 	PM_STAGE1,
77 	PM_STAGE2,
78 };
79 
80 struct pmap {
81 	struct mtx		pm_mtx;
82 	struct pmap_statistics	pm_stats;	/* pmap statistics */
83 	uint64_t		pm_ttbr;
84 	vm_paddr_t		pm_l0_paddr;
85 	pd_entry_t		*pm_l0;
86 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
87 	struct vm_radix		pm_root;	/* spare page table pages */
88 	long			pm_cookie;	/* encodes the pmap's ASID */
89 	struct asid_set		*pm_asid_set;	/* The ASID/VMID set to use */
90 	enum pmap_stage		pm_stage;
91 	int			pm_levels;
92 	struct rangeset		*pm_bti;
93 	uint64_t		pm_reserved[3];
94 };
95 typedef struct pmap *pmap_t;
96 
97 struct thread;
98 
99 #ifdef _KERNEL
100 extern struct pmap	kernel_pmap_store;
101 #define	kernel_pmap	(&kernel_pmap_store)
102 #define	pmap_kernel()	kernel_pmap
103 
104 #define	PMAP_ASSERT_LOCKED(pmap) \
105 				mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
106 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
107 #define	PMAP_LOCK_ASSERT(pmap, type) \
108 				mtx_assert(&(pmap)->pm_mtx, (type))
109 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
110 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
111 				    NULL, MTX_DEF | MTX_DUPOK)
112 #define	PMAP_OWNED(pmap)	mtx_owned(&(pmap)->pm_mtx)
113 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
114 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
115 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
116 
117 #define	ASID_RESERVED_FOR_PID_0	0
118 #define	ASID_RESERVED_FOR_EFI	1
119 #define	ASID_FIRST_AVAILABLE	(ASID_RESERVED_FOR_EFI + 1)
120 #define	ASID_TO_OPERAND(asid)	({					\
121 	KASSERT((asid) != -1, ("invalid ASID"));			\
122 	(uint64_t)(asid) << TTBR_ASID_SHIFT;			\
123 })
124 
125 #define	PMAP_WANT_ACTIVE_CPUS_NAIVE
126 
127 extern vm_offset_t virtual_avail;
128 extern vm_offset_t virtual_end;
129 
130 /*
131  * Macros to test if a mapping is mappable with an L1 Section mapping
132  * or an L2 Large Page mapping.
133  */
134 #define	L1_MAPPABLE_P(va, pa, size)					\
135 	((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
136 
137 #define	pmap_vm_page_alloc_check(m)
138 
139 void	pmap_activate_vm(pmap_t);
140 void	pmap_bootstrap(vm_size_t);
141 int	pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
142 int	pmap_change_prot(vm_offset_t va, vm_size_t size, vm_prot_t prot);
143 void	pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
144 void	pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
145 bool	pmap_klookup(vm_offset_t va, vm_paddr_t *pa);
146 vm_paddr_t pmap_kextract(vm_offset_t va);
147 void	pmap_kremove(vm_offset_t);
148 void	pmap_kremove_device(vm_offset_t, vm_size_t);
149 void	*pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma);
150 bool	pmap_page_is_mapped(vm_page_t m);
151 int	pmap_pinit_stage(pmap_t, enum pmap_stage, int);
152 bool	pmap_ps_enabled(pmap_t pmap);
153 uint64_t pmap_to_ttbr0(pmap_t pmap);
154 void	pmap_disable_promotion(vm_offset_t sva, vm_size_t size);
155 void	pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t);
156 
157 void	*pmap_mapdev(vm_paddr_t, vm_size_t);
158 void	*pmap_mapbios(vm_paddr_t, vm_size_t);
159 void	pmap_unmapdev(void *, vm_size_t);
160 void	pmap_unmapbios(void *, vm_size_t);
161 
162 bool	pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, bool);
163 void	pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, bool);
164 
165 bool	pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
166     pd_entry_t **, pt_entry_t **);
167 
168 int	pmap_fault(pmap_t, uint64_t, uint64_t);
169 
170 struct pcb *pmap_switch(struct thread *);
171 
172 extern void (*pmap_clean_stage2_tlbi)(void);
173 extern void (*pmap_invalidate_vpipt_icache)(void);
174 extern void (*pmap_stage2_invalidate_range)(uint64_t, vm_offset_t, vm_offset_t,
175     bool);
176 extern void (*pmap_stage2_invalidate_all)(uint64_t);
177 
178 int pmap_vmspace_copy(pmap_t, pmap_t);
179 
180 int pmap_bti_set(pmap_t, vm_offset_t, vm_offset_t);
181 int pmap_bti_clear(pmap_t, vm_offset_t, vm_offset_t);
182 
183 #if defined(KASAN) || defined(KMSAN)
184 struct arm64_bootparams;
185 
186 void	pmap_bootstrap_san(void);
187 void	pmap_san_enter(vm_offset_t);
188 #endif
189 
190 #endif	/* _KERNEL */
191 
192 #endif	/* !LOCORE */
193 
194 #endif	/* !_MACHINE_PMAP_H_ */
195 
196 #endif /* !__arm__ */
197