xref: /freebsd-13-stable/sys/arm64/include/pmap.h (revision f8b05837c606a0d4244245bb17a86323cb4c8122)
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 #ifndef _MACHINE_PMAP_H_
35 #define	_MACHINE_PMAP_H_
36 
37 #include <machine/pte.h>
38 
39 #ifndef LOCORE
40 
41 #include <sys/queue.h>
42 #include <sys/_lock.h>
43 #include <sys/_mutex.h>
44 
45 #include <vm/_vm_radix.h>
46 
47 #ifdef _KERNEL
48 
49 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
50 
51 #endif
52 
53 #define	pmap_page_get_memattr(m)	((m)->md.pv_memattr)
54 #define	pmap_page_is_write_mapped(m)	(((m)->a.flags & PGA_WRITEABLE) != 0)
55 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
56 
57 /*
58  * Pmap stuff
59  */
60 
61 struct md_page {
62 	TAILQ_HEAD(,pv_entry)	pv_list;
63 	int			pv_gen;
64 	vm_memattr_t		pv_memattr;
65 };
66 
67 enum pmap_stage {
68 	PM_INVALID,
69 	PM_STAGE1,
70 	PM_STAGE2,
71 };
72 
73 struct pmap {
74 	struct mtx		pm_mtx;
75 	struct pmap_statistics	pm_stats;	/* pmap statistics */
76 	uint64_t		pm_ttbr;
77 	vm_paddr_t		pm_l0_paddr;
78 	pd_entry_t		*pm_l0;
79 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
80 	struct vm_radix		pm_root;	/* spare page table pages */
81 	long			pm_cookie;	/* encodes the pmap's ASID */
82 	struct asid_set		*pm_asid_set;	/* The ASID/VMID set to use */
83 	enum pmap_stage		pm_stage;
84 	int			pm_levels;
85 };
86 typedef struct pmap *pmap_t;
87 
88 typedef struct pv_entry {
89 	vm_offset_t		pv_va;	/* virtual address for mapping */
90 	TAILQ_ENTRY(pv_entry)	pv_next;
91 } *pv_entry_t;
92 
93 /*
94  * pv_entries are allocated in chunks per-process.  This avoids the
95  * need to track per-pmap assignments.
96  */
97 #define	_NPCM	3
98 #define	_NPCPV	168
99 #define	PV_CHUNK_HEADER							\
100 	pmap_t			pc_pmap;				\
101 	TAILQ_ENTRY(pv_chunk)	pc_list;				\
102 	uint64_t		pc_map[_NPCM];	/* bitmap; 1 = free */	\
103 	TAILQ_ENTRY(pv_chunk)	pc_lru;
104 
105 struct pv_chunk_header {
106 	PV_CHUNK_HEADER
107 };
108 
109 struct pv_chunk {
110 	PV_CHUNK_HEADER
111 	struct pv_entry		pc_pventry[_NPCPV];
112 };
113 
114 struct thread;
115 
116 #ifdef _KERNEL
117 extern struct pmap	kernel_pmap_store;
118 #define	kernel_pmap	(&kernel_pmap_store)
119 #define	pmap_kernel()	kernel_pmap
120 
121 #define	PMAP_ASSERT_LOCKED(pmap) \
122 				mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
123 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
124 #define	PMAP_LOCK_ASSERT(pmap, type) \
125 				mtx_assert(&(pmap)->pm_mtx, (type))
126 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
127 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
128 				    NULL, MTX_DEF | MTX_DUPOK)
129 #define	PMAP_OWNED(pmap)	mtx_owned(&(pmap)->pm_mtx)
130 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
131 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
132 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
133 
134 #define	ASID_RESERVED_FOR_PID_0	0
135 #define	ASID_RESERVED_FOR_EFI	1
136 #define	ASID_FIRST_AVAILABLE	(ASID_RESERVED_FOR_EFI + 1)
137 #define	ASID_TO_OPERAND(asid)	({					\
138 	KASSERT((asid) != -1, ("invalid ASID"));			\
139 	(uint64_t)(asid) << TTBR_ASID_SHIFT;			\
140 })
141 
142 #define	PMAP_WANT_ACTIVE_CPUS_NAIVE
143 
144 extern vm_offset_t virtual_avail;
145 extern vm_offset_t virtual_end;
146 
147 /*
148  * Macros to test if a mapping is mappable with an L1 Section mapping
149  * or an L2 Large Page mapping.
150  */
151 #define	L1_MAPPABLE_P(va, pa, size)					\
152 	((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
153 
154 #define	pmap_vm_page_alloc_check(m)
155 
156 void	pmap_activate_vm(pmap_t);
157 void	pmap_bootstrap(vm_offset_t, vm_offset_t, vm_paddr_t, vm_size_t);
158 int	pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
159 int	pmap_change_prot(vm_offset_t va, vm_size_t size, vm_prot_t prot);
160 void	pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
161 void	pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
162 bool	pmap_klookup(vm_offset_t va, vm_paddr_t *pa);
163 vm_paddr_t pmap_kextract(vm_offset_t va);
164 void	pmap_kremove(vm_offset_t);
165 void	pmap_kremove_device(vm_offset_t, vm_size_t);
166 void	*pmap_mapdev_attr(vm_offset_t pa, vm_size_t size, vm_memattr_t ma);
167 bool	pmap_page_is_mapped(vm_page_t m);
168 int	pmap_pinit_stage(pmap_t, enum pmap_stage, int);
169 bool	pmap_ps_enabled(pmap_t pmap);
170 uint64_t pmap_to_ttbr0(pmap_t pmap);
171 void	pmap_disable_promotion(vm_offset_t sva, vm_size_t size);
172 void	pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t);
173 
174 void	*pmap_mapdev(vm_offset_t, vm_size_t);
175 void	*pmap_mapbios(vm_paddr_t, vm_size_t);
176 void	pmap_unmapdev(vm_offset_t, vm_size_t);
177 void	pmap_unmapbios(vm_offset_t, vm_size_t);
178 
179 boolean_t pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
180 void	pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
181 
182 bool	pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
183     pd_entry_t **, pt_entry_t **);
184 
185 int	pmap_fault(pmap_t, uint64_t, uint64_t);
186 
187 /* System MMU (SMMU). */
188 int pmap_senter(pmap_t pmap, vm_offset_t va, vm_paddr_t pa, vm_prot_t prot,
189     u_int flags);
190 int pmap_sremove(pmap_t pmap, vm_offset_t va);
191 void pmap_sremove_pages(pmap_t pmap);
192 
193 struct pcb *pmap_switch(struct thread *, struct thread *);
194 
195 extern void (*pmap_clean_stage2_tlbi)(void);
196 extern void (*pmap_invalidate_vpipt_icache)(void);
197 
198 static inline int
pmap_vmspace_copy(pmap_t dst_pmap __unused,pmap_t src_pmap __unused)199 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
200 {
201 
202 	return (0);
203 }
204 
205 #endif	/* _KERNEL */
206 
207 #endif	/* !LOCORE */
208 
209 #endif	/* !_MACHINE_PMAP_H_ */
210