xref: /freebsd/sys/riscv/include/pmap.h (revision 657729a89dd578d8cfc70d6616f5c65a48a8b33a)
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  * $FreeBSD$
34  */
35 
36 #ifndef _MACHINE_PMAP_H_
37 #define	_MACHINE_PMAP_H_
38 
39 #include <machine/pte.h>
40 
41 #ifndef LOCORE
42 
43 #include <sys/queue.h>
44 #include <sys/_cpuset.h>
45 #include <sys/_lock.h>
46 #include <sys/_mutex.h>
47 #include <sys/_pv_entry.h>
48 
49 #include <vm/_vm_radix.h>
50 
51 #ifdef _KERNEL
52 
53 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
54 
55 #endif
56 
57 #define	pmap_page_get_memattr(m)	((m)->md.pv_memattr)
58 #define	pmap_page_is_write_mapped(m)	(((m)->a.flags & PGA_WRITEABLE) != 0)
59 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
60 
61 /*
62  * Pmap stuff
63  */
64 
65 struct md_page {
66 	TAILQ_HEAD(,pv_entry)	pv_list;
67 	int			pv_gen;
68 	vm_memattr_t		pv_memattr;
69 };
70 
71 /*
72  * This structure is used to hold a virtual<->physical address
73  * association and is used mostly by bootstrap code
74  */
75 struct pv_addr {
76 	SLIST_ENTRY(pv_addr) pv_list;
77 	vm_offset_t	pv_va;
78 	vm_paddr_t	pv_pa;
79 };
80 
81 struct pmap {
82 	struct mtx		pm_mtx;
83 	struct pmap_statistics	pm_stats;	/* pmap statictics */
84 	pd_entry_t		*pm_top;	/* top-level page table page */
85 	u_long			pm_satp;	/* value for SATP register */
86 	cpuset_t		pm_active;	/* active on cpus */
87 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
88 	LIST_ENTRY(pmap)	pm_list;	/* List of all pmaps */
89 	struct vm_radix		pm_root;
90 };
91 
92 typedef struct pmap *pmap_t;
93 
94 #ifdef _KERNEL
95 extern struct pmap	kernel_pmap_store;
96 #define	kernel_pmap	(&kernel_pmap_store)
97 #define	pmap_kernel()	kernel_pmap
98 
99 #define	PMAP_ASSERT_LOCKED(pmap) \
100 				mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
101 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
102 #define	PMAP_LOCK_ASSERT(pmap, type) \
103 				mtx_assert(&(pmap)->pm_mtx, (type))
104 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
105 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
106 				    NULL, MTX_DEF | MTX_DUPOK)
107 #define	PMAP_OWNED(pmap)	mtx_owned(&(pmap)->pm_mtx)
108 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
109 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
110 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
111 
112 extern vm_offset_t virtual_avail;
113 extern vm_offset_t virtual_end;
114 
115 /*
116  * Macros to test if a mapping is mappable with an L1 Section mapping
117  * or an L2 Large Page mapping.
118  */
119 #define	L1_MAPPABLE_P(va, pa, size)					\
120 	((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
121 
122 enum pmap_mode {
123 	PMAP_MODE_SV39,
124 	PMAP_MODE_SV48,
125 };
126 
127 extern enum pmap_mode pmap_mode;
128 
129 /* Check if an address resides in a mappable region. */
130 #define	VIRT_IS_VALID(va)						\
131 	((va) < (pmap_mode == PMAP_MODE_SV39 ? VM_MAX_USER_ADDRESS_SV39 : \
132 	    VM_MAX_USER_ADDRESS_SV48) || (va) >= VM_MIN_KERNEL_ADDRESS)
133 
134 struct thread;
135 
136 #define	pmap_vm_page_alloc_check(m)
137 
138 void	pmap_activate_boot(pmap_t);
139 void	pmap_activate_sw(struct thread *);
140 void	pmap_bootstrap(vm_offset_t, vm_paddr_t, vm_size_t);
141 int	pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
142 void	pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
143 void	pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
144 vm_paddr_t pmap_kextract(vm_offset_t va);
145 void	pmap_kremove(vm_offset_t);
146 void	pmap_kremove_device(vm_offset_t, vm_size_t);
147 void	*pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma);
148 bool	pmap_page_is_mapped(vm_page_t m);
149 bool	pmap_ps_enabled(pmap_t);
150 
151 void	*pmap_mapdev(vm_paddr_t, vm_size_t);
152 void	*pmap_mapbios(vm_paddr_t, vm_size_t);
153 void	pmap_unmapdev(void *, vm_size_t);
154 void	pmap_unmapbios(void *, vm_size_t);
155 
156 boolean_t pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
157 void	pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, boolean_t);
158 
159 bool	pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
160     pt_entry_t **);
161 
162 int	pmap_fault(pmap_t, vm_offset_t, vm_prot_t);
163 
164 static inline int
165 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
166 {
167 
168 	return (0);
169 }
170 
171 #endif	/* _KERNEL */
172 
173 #endif	/* !LOCORE */
174 
175 #endif	/* !_MACHINE_PMAP_H_ */
176