xref: /freebsd/sys/vm/pmap.h (revision 09132ba6ac12c39efcdda0c33c59c9a7cb5a820b)
160727d8bSWarner Losh /*-
2df8bae1dSRodney W. Grimes  * Copyright (c) 1991, 1993
3df8bae1dSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
4df8bae1dSRodney W. Grimes  *
5df8bae1dSRodney W. Grimes  * This code is derived from software contributed to Berkeley by
6df8bae1dSRodney W. Grimes  * The Mach Operating System project at Carnegie-Mellon University.
7df8bae1dSRodney W. Grimes  *
8df8bae1dSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
9df8bae1dSRodney W. Grimes  * modification, are permitted provided that the following conditions
10df8bae1dSRodney W. Grimes  * are met:
11df8bae1dSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
12df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
13df8bae1dSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
14df8bae1dSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
15df8bae1dSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
16df8bae1dSRodney W. Grimes  * 4. Neither the name of the University nor the names of its contributors
17df8bae1dSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
18df8bae1dSRodney W. Grimes  *    without specific prior written permission.
19df8bae1dSRodney W. Grimes  *
20df8bae1dSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21df8bae1dSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22df8bae1dSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23df8bae1dSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24df8bae1dSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25df8bae1dSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26df8bae1dSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27df8bae1dSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28df8bae1dSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29df8bae1dSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30df8bae1dSRodney W. Grimes  * SUCH DAMAGE.
31df8bae1dSRodney W. Grimes  *
323c4dd356SDavid Greenman  *	from: @(#)pmap.h	8.1 (Berkeley) 6/11/93
33df8bae1dSRodney W. Grimes  *
34df8bae1dSRodney W. Grimes  *
35df8bae1dSRodney W. Grimes  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36df8bae1dSRodney W. Grimes  * All rights reserved.
37df8bae1dSRodney W. Grimes  *
38df8bae1dSRodney W. Grimes  * Author: Avadis Tevanian, Jr.
39df8bae1dSRodney W. Grimes  *
40df8bae1dSRodney W. Grimes  * Permission to use, copy, modify and distribute this software and
41df8bae1dSRodney W. Grimes  * its documentation is hereby granted, provided that both the copyright
42df8bae1dSRodney W. Grimes  * notice and this permission notice appear in all copies of the
43df8bae1dSRodney W. Grimes  * software, derivative works or modified versions, and any portions
44df8bae1dSRodney W. Grimes  * thereof, and that both notices appear in supporting documentation.
45df8bae1dSRodney W. Grimes  *
46df8bae1dSRodney W. Grimes  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47df8bae1dSRodney W. Grimes  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48df8bae1dSRodney W. Grimes  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
49df8bae1dSRodney W. Grimes  *
50df8bae1dSRodney W. Grimes  * Carnegie Mellon requests users of this software to return to
51df8bae1dSRodney W. Grimes  *
52df8bae1dSRodney W. Grimes  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
53df8bae1dSRodney W. Grimes  *  School of Computer Science
54df8bae1dSRodney W. Grimes  *  Carnegie Mellon University
55df8bae1dSRodney W. Grimes  *  Pittsburgh PA 15213-3890
56df8bae1dSRodney W. Grimes  *
57df8bae1dSRodney W. Grimes  * any improvements or extensions that they make and grant Carnegie the
58df8bae1dSRodney W. Grimes  * rights to redistribute these changes.
593c4dd356SDavid Greenman  *
60c3aac50fSPeter Wemm  * $FreeBSD$
61df8bae1dSRodney W. Grimes  */
62df8bae1dSRodney W. Grimes 
63df8bae1dSRodney W. Grimes /*
64df8bae1dSRodney W. Grimes  *	Machine address mapping definitions -- machine-independent
65df8bae1dSRodney W. Grimes  *	section.  [For machine-dependent section, see "machine/pmap.h".]
66df8bae1dSRodney W. Grimes  */
67df8bae1dSRodney W. Grimes 
68df8bae1dSRodney W. Grimes #ifndef	_PMAP_VM_
69df8bae1dSRodney W. Grimes #define	_PMAP_VM_
70df8bae1dSRodney W. Grimes /*
71df8bae1dSRodney W. Grimes  * Each machine dependent implementation is expected to
72df8bae1dSRodney W. Grimes  * keep certain statistics.  They may do this anyway they
73df8bae1dSRodney W. Grimes  * so choose, but are expected to return the statistics
74df8bae1dSRodney W. Grimes  * in the following structure.
75df8bae1dSRodney W. Grimes  */
76df8bae1dSRodney W. Grimes struct pmap_statistics {
77df8bae1dSRodney W. Grimes 	long resident_count;	/* # of pages mapped (total) */
78df8bae1dSRodney W. Grimes 	long wired_count;	/* # of pages wired */
79df8bae1dSRodney W. Grimes };
80df8bae1dSRodney W. Grimes typedef struct pmap_statistics *pmap_statistics_t;
81df8bae1dSRodney W. Grimes 
823153e878SAlan Cox /*
836031c68dSAlan Cox  * Each machine-dependent implementation is required to provide:
843153e878SAlan Cox  *
853153e878SAlan Cox  * vm_memattr_t	pmap_page_get_memattr(vm_page_t);
863153e878SAlan Cox  * boolean_t	pmap_page_is_mapped(vm_page_t);
876031c68dSAlan Cox  * boolean_t	pmap_page_is_write_mapped(vm_page_t);
883153e878SAlan Cox  * void		pmap_page_set_memattr(vm_page_t, vm_memattr_t);
893153e878SAlan Cox  */
90df8bae1dSRodney W. Grimes #include <machine/pmap.h>
91df8bae1dSRodney W. Grimes 
92c4473420SPeter Wemm #ifdef _KERNEL
93b40ce416SJulian Elischer struct thread;
948bcc577eSBruce Evans 
9553b19636SAlan Cox /*
9653b19636SAlan Cox  * Updates to kernel_vm_end are synchronized by the kernel_map's system mutex.
9753b19636SAlan Cox  */
9853b19636SAlan Cox extern vm_offset_t kernel_vm_end;
9953b19636SAlan Cox 
1009454f828SAlan Cox void		 pmap_activate(struct thread *td);
10151321f7cSAlan Cox void		 pmap_advise(pmap_t pmap, vm_offset_t sva, vm_offset_t eva,
10251321f7cSAlan Cox 		    int advice);
103d3249b14SAlan Cox void		 pmap_align_superpage(vm_object_t, vm_ooffset_t, vm_offset_t *,
104d3249b14SAlan Cox 		    vm_size_t);
10511caded3SAlfred Perlstein void		 pmap_change_wiring(pmap_t, vm_offset_t, boolean_t);
10611caded3SAlfred Perlstein void		 pmap_clear_modify(vm_page_t m);
10711caded3SAlfred Perlstein void		 pmap_copy(pmap_t, pmap_t, vm_offset_t, vm_size_t, vm_offset_t);
1081a87a0daSPeter Wemm void		 pmap_copy_page(vm_page_t, vm_page_t);
109e8a4a618SKonstantin Belousov void		 pmap_copy_pages(vm_page_t ma[], vm_offset_t a_offset,
110e8a4a618SKonstantin Belousov 		    vm_page_t mb[], vm_offset_t b_offset, int xfersize);
111eb2a0517SAlan Cox void		 pmap_enter(pmap_t, vm_offset_t, vm_prot_t, vm_page_t,
112eb2a0517SAlan Cox 		    vm_prot_t, boolean_t);
113ce142d9eSAlan Cox void		 pmap_enter_object(pmap_t pmap, vm_offset_t start,
114ce142d9eSAlan Cox 		    vm_offset_t end, vm_page_t m_start, vm_prot_t prot);
1159454f828SAlan Cox void		 pmap_enter_quick(pmap_t pmap, vm_offset_t va, vm_page_t m,
1169454f828SAlan Cox 		    vm_prot_t prot);
117227f9a1cSJake Burkholder vm_paddr_t	 pmap_extract(pmap_t pmap, vm_offset_t va);
118b9850eb2SAlan Cox vm_page_t	 pmap_extract_and_hold(pmap_t pmap, vm_offset_t va,
119b9850eb2SAlan Cox 		    vm_prot_t prot);
12011caded3SAlfred Perlstein void		 pmap_growkernel(vm_offset_t);
121bdb93eb2SAlan Cox void		 pmap_init(void);
12211caded3SAlfred Perlstein boolean_t	 pmap_is_modified(vm_page_t m);
123566526a9SAlan Cox boolean_t	 pmap_is_prefaultable(pmap_t pmap, vm_offset_t va);
1247b85f591SAlan Cox boolean_t	 pmap_is_referenced(vm_page_t m);
125227f9a1cSJake Burkholder vm_offset_t	 pmap_map(vm_offset_t *, vm_paddr_t, vm_paddr_t, int);
126567e51e1SAlan Cox int		 pmap_mincore(pmap_t pmap, vm_offset_t addr,
127567e51e1SAlan Cox 		    vm_paddr_t *locked_pa);
12811caded3SAlfred Perlstein void		 pmap_object_init_pt(pmap_t pmap, vm_offset_t addr,
1291f78f902SAlan Cox 		    vm_object_t object, vm_pindex_t pindex, vm_size_t size);
13011caded3SAlfred Perlstein boolean_t	 pmap_page_exists_quick(pmap_t pmap, vm_page_t m);
1311c245ae7SAlan Cox void		 pmap_page_init(vm_page_t m);
13259677d3cSAlan Cox int		 pmap_page_wired_mappings(vm_page_t m);
13389b57fcfSKonstantin Belousov int		 pmap_pinit(pmap_t);
13411caded3SAlfred Perlstein void		 pmap_pinit0(pmap_t);
13511caded3SAlfred Perlstein void		 pmap_protect(pmap_t, vm_offset_t, vm_offset_t, vm_prot_t);
13611caded3SAlfred Perlstein void		 pmap_qenter(vm_offset_t, vm_page_t *, int);
13711caded3SAlfred Perlstein void		 pmap_qremove(vm_offset_t, int);
13811caded3SAlfred Perlstein void		 pmap_release(pmap_t);
13911caded3SAlfred Perlstein void		 pmap_remove(pmap_t, vm_offset_t, vm_offset_t);
1406372d61eSAlan Cox void		 pmap_remove_all(vm_page_t m);
141b9eee07eSPeter Wemm void		 pmap_remove_pages(pmap_t);
14278985e42SAlan Cox void		 pmap_remove_write(vm_page_t m);
1431a4fcaebSMarcel Moolenaar void		 pmap_sync_icache(pmap_t, vm_offset_t, vm_size_t);
1449454f828SAlan Cox boolean_t	 pmap_ts_referenced(vm_page_t m);
145*09132ba6SAlan Cox void		 pmap_unwire(pmap_t pmap, vm_offset_t start, vm_offset_t end);
1461a87a0daSPeter Wemm void		 pmap_zero_page(vm_page_t);
1471a87a0daSPeter Wemm void		 pmap_zero_page_area(vm_page_t, int off, int size);
148a58b3a68SPeter Wemm void		 pmap_zero_page_idle(vm_page_t);
1492bc7dd56SBruce M Simpson 
1502bc7dd56SBruce M Simpson #define	pmap_resident_count(pm)	((pm)->pm_stats.resident_count)
1512bc7dd56SBruce M Simpson #define	pmap_wired_count(pm)	((pm)->pm_stats.wired_count)
1522bc7dd56SBruce M Simpson 
153c4473420SPeter Wemm #endif /* _KERNEL */
154df8bae1dSRodney W. Grimes #endif /* _PMAP_VM_ */
155