xref: /dragonfly/sys/vm/pmap.h (revision 7d3e9a5b)
1 /*
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * The Mach Operating System project at Carnegie-Mellon University.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	from: @(#)pmap.h	8.1 (Berkeley) 6/11/93
33  *
34  *
35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36  * All rights reserved.
37  *
38  * Author: Avadis Tevanian, Jr.
39  *
40  * Permission to use, copy, modify and distribute this software and
41  * its documentation is hereby granted, provided that both the copyright
42  * notice and this permission notice appear in all copies of the
43  * software, derivative works or modified versions, and any portions
44  * thereof, and that both notices appear in supporting documentation.
45  *
46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
49  *
50  * Carnegie Mellon requests users of this software to return to
51  *
52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
53  *  School of Computer Science
54  *  Carnegie Mellon University
55  *  Pittsburgh PA 15213-3890
56  *
57  * any improvements or extensions that they make and grant Carnegie the
58  * rights to redistribute these changes.
59  *
60  * $FreeBSD: src/sys/vm/pmap.h,v 1.33.2.4 2002/03/06 22:44:24 silby Exp $
61  */
62 
63 /*
64  *	Machine address mapping definitions -- machine-independent
65  *	section.  [For machine-dependent section, see "machine/pmap.h".]
66  */
67 
68 #ifndef	_VM_PMAP_H_
69 #define	_VM_PMAP_H_
70 
71 #ifndef _SYS_TYPES_H_
72 #include <sys/types.h>
73 #endif
74 
75 #ifndef _SYS_SPINLOCK_H_
76 #include <sys/spinlock.h>
77 #endif
78 
79 #ifndef _MACHINE_PMAP_H_
80 #include <machine/pmap.h>
81 #endif
82 
83 #ifdef _KERNEL
84 
85 #ifndef _VM_VM_H_
86 #include <vm/vm.h>
87 #endif
88 
89 struct lwp;
90 struct proc;
91 struct thread;
92 struct vm_page;
93 struct vmspace;
94 struct vmspace_entry;
95 struct vm_map_entry;
96 
97 struct pmap_pgscan_info {
98 	struct pmap	*pmap;
99 	vm_offset_t	beg_addr;
100 	vm_offset_t	end_addr;
101 	vm_offset_t	offset;
102 	vm_pindex_t	limit;
103 	vm_pindex_t	busycount;
104 	vm_pindex_t	cleancount;
105 	vm_pindex_t	actioncount;
106 	int		(*callback)(struct pmap_pgscan_info *,
107 				    vm_offset_t va,
108 				    struct vm_page *);
109 };
110 
111 typedef struct vm_phystable {
112 	vm_paddr_t	phys_beg;
113 	vm_paddr_t	phys_end;
114 	uint32_t	flags;
115 	uint32_t	affinity;
116 } vm_phystable_t;
117 
118 /*
119  * Most of these variables represent parameters set up by low level MD kernel
120  * boot code to be used by higher level MI initialization code to identify
121  * the portions of kernel and physical memory which are free for allocation.
122  *
123  * KvaStart/KvaEnd/	- Reserved Kernel Virtual Memory address space.
124  * KvaSize		  This range represents the entire KVA space but
125  *			  might omit certain special mapping areas.  It is
126  *			  used to determine what kernel memory userland has
127  *			  access to.
128  *
129  * DMapMaxAddress	- Maximum virtual address for DMap (not physical addr).
130  *			  We do not allocate the entire space from
131  *			  DMAP_MIN_ADDRESS to DMAP_MAX_ADDRESS.
132  *
133  * virtual_{start,end}	- KVA space available for allocation, not including
134  *			  KVA space reserved during MD startup.  Used by
135  *			  the KMEM subsystem, used to initialize kernel_map.
136  *
137  * phys_avail[]		- Array of {start,end} physical addresses, not
138  *			  including physical memory allocated by MD startup
139  *			  code.  Used to initialize the VM subsystem.
140  */
141 extern vm_offset_t KvaStart;
142 extern vm_offset_t KvaEnd;
143 extern vm_offset_t KvaSize;
144 extern vm_offset_t DMapMaxAddress;
145 extern vm_offset_t virtual_start;
146 extern vm_offset_t virtual_end;
147 extern vm_offset_t virtual2_start;
148 extern vm_offset_t virtual2_end;
149 extern vm_phystable_t phys_avail[];
150 extern vm_phystable_t dump_avail[];
151 
152 /*
153  * High-level pmap scan
154  */
155 void pmap_pgscan(struct pmap_pgscan_info *info);
156 
157 /*
158  * Return true if the passed address is in the kernel address space.
159  * This is mainly a check that the address is NOT in the user address space.
160  *
161  * For a vkernels all addresses are in the kernel address space.
162  */
163 static inline int
164 kva_p(const void *addr)
165 {
166 #ifdef _KERNEL_VIRTUAL
167 	return (addr != NULL);
168 #else
169 	return ((unsigned long)KvaStart <= (unsigned long)addr) &&
170 		((unsigned long)addr < (unsigned long)KvaEnd);
171 #endif
172 }
173 
174 vm_page_t	 pmap_unwire (pmap_t, vm_offset_t);
175 void		 pmap_clear_modify (struct vm_page *m);
176 void		 pmap_clear_reference (struct vm_page *m);
177 void		 pmap_collect (void);
178 void		 pmap_copy (pmap_t, pmap_t, vm_offset_t, vm_size_t,
179 			vm_offset_t);
180 void		 pmap_copy_page (vm_paddr_t, vm_paddr_t);
181 void		 pmap_copy_page_frag (vm_paddr_t, vm_paddr_t, size_t bytes);
182 void		 pmap_enter (pmap_t, vm_offset_t, struct vm_page *,
183 			vm_prot_t, boolean_t, struct vm_map_entry *);
184 void		 pmap_maybethreaded(pmap_t);
185 int		 pmap_mapped_sync(vm_page_t m);
186 vm_page_t	 pmap_fault_page_quick(pmap_t, vm_offset_t, vm_prot_t, int *);
187 vm_paddr_t	 pmap_extract (pmap_t pmap, vm_offset_t va, void **handlep);
188 void		 pmap_extract_done (void *handle);
189 void		 pmap_growkernel (vm_offset_t, vm_offset_t);
190 void		 pmap_init (void);
191 boolean_t	 pmap_is_modified (struct vm_page *m);
192 int		 pmap_ts_referenced (struct vm_page *m);
193 vm_offset_t	 pmap_map (vm_offset_t *, vm_paddr_t, vm_paddr_t, int);
194 void		 pmap_object_init_pt (pmap_t pmap, struct vm_map_entry *entry,
195 			vm_offset_t addr, vm_offset_t size, int pagelimit);
196 void		 pmap_page_protect (struct vm_page *m, vm_prot_t prot);
197 void		 pmap_page_init (struct vm_page *m);
198 vm_paddr_t	 uservtophys(vm_offset_t va);
199 vm_paddr_t	 pmap_phys_address (vm_pindex_t);
200 void		 pmap_pinit (pmap_t);
201 void		 pmap_puninit (pmap_t);
202 void		 pmap_pinit0 (pmap_t);
203 void		 pmap_pinit2 (pmap_t);
204 void		 pmap_ept_transform (pmap_t, int);
205 void		 pmap_npt_transform (pmap_t, int);
206 void		 pmap_protect (pmap_t, vm_offset_t, vm_offset_t, vm_prot_t);
207 void		 pmap_remove_specific (pmap_t, vm_page_t);
208 void		 pmap_qenter (vm_offset_t, struct vm_page **, int);
209 void		 pmap_qenter_noinval (vm_offset_t, struct vm_page **, int);
210 void		 pmap_qremove (vm_offset_t, int);
211 void		 pmap_qremove_quick (vm_offset_t, int);
212 void		 pmap_qremove_noinval (vm_offset_t, int);
213 void		 pmap_kenter (vm_offset_t, vm_paddr_t);
214 int		 pmap_kenter_quick (vm_offset_t, vm_paddr_t);
215 int		 pmap_kenter_noinval (vm_offset_t, vm_paddr_t);
216 void		 pmap_kmodify_rw(vm_offset_t va);
217 void		 pmap_kmodify_nc(vm_offset_t va);
218 void		 pmap_kremove (vm_offset_t);
219 void		 pmap_kremove_quick (vm_offset_t);
220 void		 pmap_kremove_noinval (vm_offset_t);
221 void		 pmap_reference (pmap_t);
222 void		 pmap_remove (pmap_t, vm_offset_t, vm_offset_t);
223 void		 pmap_remove_pages (pmap_t, vm_offset_t, vm_offset_t);
224 void		 pmap_zero_page (vm_paddr_t);
225 void		 pmap_zero_page_area (vm_paddr_t, int off, int size);
226 int		 pmap_prefault_ok (pmap_t, vm_offset_t);
227 void		 pmap_change_attr(vm_offset_t va, vm_size_t count, int mode);
228 int		 pmap_mincore (pmap_t pmap, vm_offset_t addr);
229 void		 pmap_init_proc (struct proc *);
230 void		 pmap_init_thread (struct thread *td);
231 void		 pmap_replacevm (struct proc *, struct vmspace *, int);
232 void		 pmap_setlwpvm (struct lwp *, struct vmspace *);
233 vm_paddr_t	 pmap_kextract(vm_offset_t);
234 void		 pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
235 
236 void		 pmap_add_cpu(struct vmspace *vm, int cpuid);
237 void		 pmap_del_cpu(struct vmspace *vm, int cpuid);
238 void		 pmap_del_all_cpus(struct vmspace *vm);
239 
240 vm_offset_t	 pmap_addr_hint (vm_object_t obj, vm_offset_t addr, vm_size_t size);
241 void		*pmap_kenter_temporary (vm_paddr_t pa, long i);
242 void		 pmap_init2 (void);
243 struct vm_page	*pmap_kvtom(vm_offset_t va);
244 void		 pmap_object_init(vm_object_t object);
245 void		 pmap_object_free(vm_object_t object);
246 void		 smap_smep_disable(void);
247 void		 smap_smep_enable(void);
248 
249 #define	vtophys(va)	pmap_kextract(((vm_offset_t)(va)))
250 #define	vtophys_pte(va)	((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
251 
252 #endif /* _KERNEL */
253 
254 #endif /* _VM_PMAP_H_ */
255