xref: /netbsd/sys/uvm/uvm_pmap.h (revision bf9ec67e)
1 /*	$NetBSD: uvm_pmap.h,v 1.10 2002/04/10 00:40:45 thorpej Exp $	*/
2 
3 /*
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * The Mach Operating System project at Carnegie-Mellon University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)pmap.h	8.1 (Berkeley) 6/11/93
39  *
40  *
41  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
42  * All rights reserved.
43  *
44  * Author: Avadis Tevanian, Jr.
45  *
46  * Permission to use, copy, modify and distribute this software and
47  * its documentation is hereby granted, provided that both the copyright
48  * notice and this permission notice appear in all copies of the
49  * software, derivative works or modified versions, and any portions
50  * thereof, and that both notices appear in supporting documentation.
51  *
52  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
53  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
54  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
55  *
56  * Carnegie Mellon requests users of this software to return to
57  *
58  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
59  *  School of Computer Science
60  *  Carnegie Mellon University
61  *  Pittsburgh PA 15213-3890
62  *
63  * any improvements or extensions that they make and grant Carnegie the
64  * rights to redistribute these changes.
65  */
66 
67 /*
68  *	Machine address mapping definitions -- machine-independent
69  *	section.  [For machine-dependent section, see "machine/pmap.h".]
70  */
71 
72 #ifndef	_PMAP_VM_
73 #define	_PMAP_VM_
74 
75 struct proc;		/* for pmap_activate()/pmap_deactivate() proto */
76 
77 /*
78  * Each machine dependent implementation is expected to
79  * keep certain statistics.  They may do this anyway they
80  * so choose, but are expected to return the statistics
81  * in the following structure.
82  */
83 struct pmap_statistics {
84 	long		resident_count;	/* # of pages mapped (total)*/
85 	long		wired_count;	/* # of pages wired */
86 };
87 typedef struct pmap_statistics	*pmap_statistics_t;
88 
89 #ifdef _KERNEL
90 #include <machine/pmap.h>
91 #endif
92 
93 /*
94  * Flags passed to pmap_enter().  Note the bottom 3 bits are VM_PROT_*
95  * bits, used to indicate the access type that was made (to seed modified
96  * and referenced information).
97  */
98 #define	PMAP_WIRED	0x00000010	/* wired mapping */
99 #define	PMAP_CANFAIL	0x00000020	/* can fail if resource shortage */
100 
101 #ifndef PMAP_EXCLUDE_DECLS	/* Used in Sparc port to virtualize pmap mod */
102 #ifdef _KERNEL
103 __BEGIN_DECLS
104 #if !defined(pmap_kernel)
105 struct pmap	*pmap_kernel __P((void));
106 #endif
107 
108 void		 pmap_activate __P((struct proc *));
109 void		 pmap_deactivate __P((struct proc *));
110 void		 pmap_unwire __P((pmap_t, vaddr_t));
111 
112 #if !defined(pmap_clear_modify)
113 boolean_t	 pmap_clear_modify __P((struct vm_page *));
114 #endif
115 #if !defined(pmap_clear_reference)
116 boolean_t	 pmap_clear_reference __P((struct vm_page *));
117 #endif
118 
119 void		 pmap_collect __P((pmap_t));
120 void		 pmap_copy __P((pmap_t,
121 		    pmap_t, vaddr_t, vsize_t, vaddr_t));
122 #if !defined(pmap_copy_page)
123 void		 pmap_copy_page __P((paddr_t, paddr_t));
124 #endif
125 struct pmap 	 *pmap_create __P((void));
126 void		 pmap_destroy __P((pmap_t));
127 int		 pmap_enter __P((pmap_t,
128 		    vaddr_t, paddr_t, vm_prot_t, int));
129 boolean_t	 pmap_extract __P((pmap_t, vaddr_t, paddr_t *));
130 #if defined(PMAP_GROWKERNEL)
131 vaddr_t		 pmap_growkernel __P((vaddr_t));
132 #endif
133 
134 void		 pmap_init __P((void));
135 
136 void		 pmap_kenter_pa __P((vaddr_t, paddr_t, vm_prot_t));
137 void		 pmap_kremove __P((vaddr_t, vsize_t));
138 #if !defined(pmap_is_modified)
139 boolean_t	 pmap_is_modified __P((struct vm_page *));
140 #endif
141 #if !defined(pmap_is_referenced)
142 boolean_t	 pmap_is_referenced __P((struct vm_page *));
143 #endif
144 
145 void		 pmap_page_protect __P((struct vm_page *, vm_prot_t));
146 
147 #if !defined(pmap_phys_address)
148 paddr_t		pmap_phys_address __P((int));
149 #endif
150 void		 pmap_protect __P((pmap_t,
151 		    vaddr_t, vaddr_t, vm_prot_t));
152 void		 pmap_reference __P((pmap_t));
153 void		 pmap_remove __P((pmap_t, vaddr_t, vaddr_t));
154 void		 pmap_update __P((pmap_t));
155 #if !defined(pmap_resident_count)
156 long		 pmap_resident_count __P((pmap_t));
157 #endif
158 #if !defined(pmap_wired_count)
159 long		 pmap_wired_count __P((pmap_t));
160 #endif
161 #if !defined(pmap_zero_page)
162 void		 pmap_zero_page __P((paddr_t));
163 #endif
164 
165 void		 pmap_virtual_space __P((vaddr_t *, vaddr_t *));
166 #if defined(PMAP_STEAL_MEMORY)
167 vaddr_t		 pmap_steal_memory __P((vsize_t, vaddr_t *, vaddr_t *));
168 #endif
169 
170 #if defined(PMAP_FORK)
171 void		pmap_fork __P((pmap_t, pmap_t));
172 #endif
173 __END_DECLS
174 #endif	/* kernel*/
175 #endif  /* PMAP_EXCLUDE_DECLS */
176 
177 #endif /* _PMAP_VM_ */
178