xref: /freebsd/sys/powerpc/include/pmap.h (revision 83129c0b650734f4ca6c6f9c214aa3110d2f129d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause AND BSD-4-Clause
3  *
4  * Copyright (C) 2006 Semihalf, Marian Balakowicz <m8@semihalf.com>
5  * All rights reserved.
6  *
7  * Adapted for Freescale's e500 core CPUs.
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. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
23  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 /*-
34  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
35  * Copyright (C) 1995, 1996 TooLs GmbH.
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  * 1. Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  * 2. Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in the
45  *    documentation and/or other materials provided with the distribution.
46  * 3. All advertising materials mentioning features or use of this software
47  *    must display the following acknowledgement:
48  *	This product includes software developed by TooLs GmbH.
49  * 4. The name of TooLs GmbH may not be used to endorse or promote products
50  *    derived from this software without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
57  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
58  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
59  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
60  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
61  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  *
63  *	from: $NetBSD: pmap.h,v 1.17 2000/03/30 16:18:24 jdolecek Exp $
64  */
65 
66 #ifndef	_MACHINE_PMAP_H_
67 #define	_MACHINE_PMAP_H_
68 
69 #include <sys/queue.h>
70 #include <sys/tree.h>
71 #include <sys/_cpuset.h>
72 #include <sys/_lock.h>
73 #include <sys/_mutex.h>
74 #include <machine/sr.h>
75 #include <machine/pte.h>
76 #include <machine/slb.h>
77 #include <machine/tlb.h>
78 
79 struct pmap;
80 typedef struct pmap *pmap_t;
81 
82 #if !defined(NPMAPS)
83 #define	NPMAPS		32768
84 #endif /* !defined(NPMAPS) */
85 
86 struct	slbtnode;
87 
88 struct pvo_entry {
89 	LIST_ENTRY(pvo_entry) pvo_vlink;	/* Link to common virt page */
90 #ifndef __powerpc64__
91 	LIST_ENTRY(pvo_entry) pvo_olink;	/* Link to overflow entry */
92 #endif
93 	union {
94 		RB_ENTRY(pvo_entry) pvo_plink;	/* Link to pmap entries */
95 		SLIST_ENTRY(pvo_entry) pvo_dlink; /* Link to delete enty */
96 	};
97 	struct {
98 #ifndef __powerpc64__
99 		/* 32-bit fields */
100 		pte_t	    pte;
101 #endif
102 		/* 64-bit fields */
103 		uintptr_t   slot;
104 		vm_paddr_t  pa;
105 		vm_prot_t   prot;
106 	} pvo_pte;
107 	pmap_t		pvo_pmap;		/* Owning pmap */
108 	vm_offset_t	pvo_vaddr;		/* VA of entry */
109 	uint64_t	pvo_vpn;		/* Virtual page number */
110 };
111 LIST_HEAD(pvo_head, pvo_entry);
112 SLIST_HEAD(pvo_dlist, pvo_entry);
113 RB_HEAD(pvo_tree, pvo_entry);
114 int pvo_vaddr_compare(struct pvo_entry *, struct pvo_entry *);
115 RB_PROTOTYPE(pvo_tree, pvo_entry, pvo_plink, pvo_vaddr_compare);
116 
117 /* Used by 32-bit PMAP */
118 #define	PVO_PTEGIDX_MASK	0x007UL		/* which PTEG slot */
119 #define	PVO_PTEGIDX_VALID	0x008UL		/* slot is valid */
120 /* Used by 64-bit PMAP */
121 #define	PVO_HID			0x008UL		/* PVO entry in alternate hash*/
122 /* Used by both */
123 #define	PVO_WIRED		0x010UL		/* PVO entry is wired */
124 #define	PVO_MANAGED		0x020UL		/* PVO entry is managed */
125 #define	PVO_BOOTSTRAP		0x080UL		/* PVO entry allocated during
126 						   bootstrap */
127 #define PVO_DEAD		0x100UL		/* waiting to be deleted */
128 #define PVO_LARGE		0x200UL		/* large page */
129 #define	PVO_VADDR(pvo)		((pvo)->pvo_vaddr & ~ADDR_POFF)
130 #define	PVO_PTEGIDX_GET(pvo)	((pvo)->pvo_vaddr & PVO_PTEGIDX_MASK)
131 #define	PVO_PTEGIDX_ISSET(pvo)	((pvo)->pvo_vaddr & PVO_PTEGIDX_VALID)
132 #define	PVO_PTEGIDX_CLR(pvo)	\
133 	((void)((pvo)->pvo_vaddr &= ~(PVO_PTEGIDX_VALID|PVO_PTEGIDX_MASK)))
134 #define	PVO_PTEGIDX_SET(pvo, i)	\
135 	((void)((pvo)->pvo_vaddr |= (i)|PVO_PTEGIDX_VALID))
136 #define	PVO_VSID(pvo)		((pvo)->pvo_vpn >> 16)
137 
138 struct	pmap {
139 	struct		pmap_statistics	pm_stats;
140 	struct	mtx	pm_mtx;
141 	cpuset_t	pm_active;
142 	union {
143 		struct {
144 
145 		    #ifdef __powerpc64__
146 			struct slbtnode	*pm_slb_tree_root;
147 			struct slb	**pm_slb;
148 			int		pm_slb_len;
149 		    #else
150 			register_t	pm_sr[16];
151 		    #endif
152 
153 			struct pmap	*pmap_phys;
154 			struct pvo_tree pmap_pvo;
155 		};
156 		struct {
157 			/* TID to identify this pmap entries in TLB */
158 			tlbtid_t	pm_tid[MAXCPU];
159 
160 #ifdef __powerpc64__
161 			/*
162 			 * Page table directory,
163 			 * array of pointers to page directories.
164 			 */
165 			pte_t ***pm_pp2d;
166 #else
167 			/*
168 			 * Page table directory,
169 			 * array of pointers to page tables.
170 			 */
171 			pte_t		**pm_pdir;
172 
173 			/* List of allocated ptbl bufs (ptbl kva regions). */
174 			TAILQ_HEAD(, ptbl_buf)	pm_ptbl_list;
175 #endif
176 		};
177 	};
178 };
179 
180 struct pv_entry {
181 	pmap_t pv_pmap;
182 	vm_offset_t pv_va;
183 	TAILQ_ENTRY(pv_entry) pv_link;
184 };
185 typedef struct pv_entry *pv_entry_t;
186 
187 struct	md_page {
188 	union {
189 		struct {
190 			volatile int32_t mdpg_attrs;
191 			vm_memattr_t	 mdpg_cache_attrs;
192 			struct	pvo_head mdpg_pvoh;
193 		};
194 		struct {
195 			TAILQ_HEAD(, pv_entry)	pv_list;
196 			int			pv_tracked;
197 		};
198 	};
199 };
200 
201 #ifdef AIM
202 #define	pmap_page_get_memattr(m)	((m)->md.mdpg_cache_attrs)
203 #define	pmap_page_is_mapped(m)	(!LIST_EMPTY(&(m)->md.mdpg_pvoh))
204 #else
205 #define	pmap_page_get_memattr(m)	VM_MEMATTR_DEFAULT
206 #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
207 #endif
208 
209 /*
210  * Return the VSID corresponding to a given virtual address.
211  * If no VSID is currently defined, it will allocate one, and add
212  * it to a free slot if available.
213  *
214  * NB: The PMAP MUST be locked already.
215  */
216 uint64_t va_to_vsid(pmap_t pm, vm_offset_t va);
217 
218 /* Lock-free, non-allocating lookup routines */
219 uint64_t kernel_va_to_slbv(vm_offset_t va);
220 struct slb *user_va_to_slb_entry(pmap_t pm, vm_offset_t va);
221 
222 uint64_t allocate_user_vsid(pmap_t pm, uint64_t esid, int large);
223 void	free_vsid(pmap_t pm, uint64_t esid, int large);
224 void	slb_insert_user(pmap_t pm, struct slb *slb);
225 void	slb_insert_kernel(uint64_t slbe, uint64_t slbv);
226 
227 struct slbtnode *slb_alloc_tree(void);
228 void     slb_free_tree(pmap_t pm);
229 struct slb **slb_alloc_user_cache(void);
230 void	slb_free_user_cache(struct slb **);
231 
232 extern	struct pmap kernel_pmap_store;
233 #define	kernel_pmap	(&kernel_pmap_store)
234 
235 #ifdef _KERNEL
236 
237 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
238 #define	PMAP_LOCK_ASSERT(pmap, type) \
239 				mtx_assert(&(pmap)->pm_mtx, (type))
240 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
241 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, \
242 				    (pmap == kernel_pmap) ? "kernelpmap" : \
243 				    "pmap", NULL, MTX_DEF)
244 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
245 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
246 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
247 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
248 
249 #define	pmap_page_is_write_mapped(m)	(((m)->aflags & PGA_WRITEABLE) != 0)
250 
251 void		pmap_bootstrap(vm_offset_t, vm_offset_t);
252 void		pmap_kenter(vm_offset_t va, vm_paddr_t pa);
253 void		pmap_kenter_attr(vm_offset_t va, vm_paddr_t pa, vm_memattr_t);
254 void		pmap_kremove(vm_offset_t);
255 void		*pmap_mapdev(vm_paddr_t, vm_size_t);
256 void		*pmap_mapdev_attr(vm_paddr_t, vm_size_t, vm_memattr_t);
257 void		pmap_unmapdev(vm_offset_t, vm_size_t);
258 void		pmap_page_set_memattr(vm_page_t, vm_memattr_t);
259 int		pmap_change_attr(vm_offset_t, vm_size_t, vm_memattr_t);
260 int		pmap_map_user_ptr(pmap_t pm, volatile const void *uaddr,
261 		    void **kaddr, size_t ulen, size_t *klen);
262 int		pmap_decode_kernel_ptr(vm_offset_t addr, int *is_user,
263 		    vm_offset_t *decoded_addr);
264 void		pmap_deactivate(struct thread *);
265 vm_paddr_t	pmap_kextract(vm_offset_t);
266 int		pmap_dev_direct_mapped(vm_paddr_t, vm_size_t);
267 boolean_t	pmap_mmu_install(char *name, int prio);
268 
269 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
270 
271 #define PHYS_AVAIL_SZ	256	/* Allows up to 16GB Ram on pSeries with
272 				 * logical memory block size of 64MB.
273 				 * For more Ram increase the lmb or this value.
274 				 */
275 
276 extern	vm_paddr_t phys_avail[PHYS_AVAIL_SZ];
277 extern	vm_offset_t virtual_avail;
278 extern	vm_offset_t virtual_end;
279 
280 extern	vm_offset_t msgbuf_phys;
281 
282 extern	int pmap_bootstrapped;
283 
284 vm_offset_t pmap_early_io_map(vm_paddr_t pa, vm_size_t size);
285 void pmap_early_io_unmap(vm_offset_t va, vm_size_t size);
286 void pmap_track_page(pmap_t pmap, vm_offset_t va);
287 
288 static inline int
289 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
290 {
291 
292 	return (0);
293 }
294 
295 #endif
296 
297 #endif /* !_MACHINE_PMAP_H_ */
298