xref: /386bsd/usr/src/kernel/include/pmap.h (revision a2142627)
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 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. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	$Id: pmap.h,v 1.2 93/02/04 20:15:10 bill Exp Locker: bill $
37  *
38  *
39  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40  * All rights reserved.
41  *
42  * Author: Avadis Tevanian, Jr.
43  *
44  * Permission to use, copy, modify and distribute this software and
45  * its documentation is hereby granted, provided that both the copyright
46  * notice and this permission notice appear in all copies of the
47  * software, derivative works or modified versions, and any portions
48  * thereof, and that both notices appear in supporting documentation.
49  *
50  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
51  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
52  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
53  *
54  * Carnegie Mellon requests users of this software to return to
55  *
56  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
57  *  School of Computer Science
58  *  Carnegie Mellon University
59  *  Pittsburgh PA 15213-3890
60  *
61  * any improvements or extensions that they make and grant Carnegie the
62  * rights to redistribute these changes.
63  *
64  *	Machine address mapping definitions -- machine-independent
65  *	section.  [For machine-dependent section, see "machine/pmap.h".]
66  */
67 
68 #ifndef	_PMAP_VM_
69 #define	_PMAP_VM_
70 
71 /*
72  * Kinds of address mappings -- corresponds to application use.
73  */
74 #define	AM_NONE		0x0	/* no special meaning */
75 #define	AM_TEXT		0x1	/* sharable object mapping */
76 #define	AM_DATA		0x2	/* unshared mapping */
77 #define	AM_STACK	0x3	/* unshared stack mapping */
78 
79 #include <machine/pmap.h>
80 
81 #ifdef KERNEL
82 void	pmap_bootstrap(vm_offset_t firstaddr, vm_offset_t loadaddr);
83 void	pmap_init(void /*vm_offset_t phys_start, vm_offset_t phys_end*/);
84 struct pmap
85 	*pmap_create(vm_size_t size);
86 void	pmap_destroy(pmap_t pmap);
87 void	pmap_pinit(struct pmap *pmap);
88 void	pmap_release(struct pmap *pmap);
89 vm_offset_t
90 	pmap_map(vm_offset_t virt, vm_offset_t start, vm_offset_t end,
91 		vm_prot_t prot);
92 void	pmap_reference(struct pmap *pmap);
93 void	pmap_remove(struct pmap *pmap, vm_offset_t sva, vm_offset_t eva);
94 void	pmap_protect(struct pmap *pmap, vm_offset_t sva, vm_offset_t eva,
95 		vm_prot_t prot);
96 void	pmap_enter(struct pmap *pmap, vm_offset_t va, vm_offset_t pa,
97 		vm_prot_t prot, boolean_t wired, int am);
98 void	pmap_page_protect(vm_offset_t phys, vm_prot_t prot);
99 vm_offset_t
100 	pmap_extract(struct pmap *pmap, vm_offset_t va);
101 void	pmap_update();
102 void	pmap_collect(struct pmap *pmap);
103 /* needs forward declaration of struct pcb:
104 void	pmap_activate(struct pmap *pmap, struct pcb *pcbp); */
105 void	pmap_copy(struct pmap *dst_pmap, struct pmap *src_pmap,
106 		vm_offset_t dst_addr, vm_size_t len, vm_offset_t src_addr);
107 #ifndef pmap_kernel
108 pmap_t	pmap_kernel();
109 #endif
110 void	pmap_pageable(struct pmap *pmap, vm_offset_t sva, vm_offset_t eva,
111 		boolean_t pageable);
112 void	pmap_change_wiring(struct pmap *pmap, vm_offset_t va, boolean_t wired);
113 void	pmap_zero_page(vm_offset_t phys);
114 void	pmap_copy_page(vm_offset_t src, vm_offset_t dst);
115 void	pmap_clear_modify(vm_offset_t pa);
116 void	pmap_clear_reference(vm_offset_t pa);
117 boolean_t
118 	pmap_is_referenced(vm_offset_t pa);
119 boolean_t
120 	pmap_is_modified(vm_offset_t pa);
121 vm_offset_t
122 	pmap_phys_address(int ppn);
123 void	pmap_changebit(vm_offset_t pa, int bit, boolean_t setem);
124 
125 /* current functions not global could be static: */
126 boolean_t
127 	pmap_testbit(vm_offset_t pa, int bit);
128 void	pmap_remove_all(vm_offset_t pa);
129 void	pmap_copy_on_write(vm_offset_t pa);
130 
131 /* current functions global should be static: */
132 /* db_something() calls pmap_pte()! */
133 /* static */ struct pte *pmap_pte(struct pmap *pmap, vm_offset_t va);
134 
135 /* not implemented:
136 void	pmap_redzone();
137 boolean_t
138 	pmap_access();
139 void	pmap_statistics();
140 void	pmap_deactivate();
141 */
142 
143 extern pmap_t	kernel_pmap;
144 #endif
145 
146 #endif	_PMAP_VM_
147