xref: /freebsd/sys/vm/pmap.h (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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. 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  *	from: @(#)pmap.h	8.1 (Berkeley) 6/11/93
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  * $Id: pmap.h,v 1.5 1994/11/14 08:19:07 bde Exp $
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 /*
76  * Each machine dependent implementation is expected to
77  * keep certain statistics.  They may do this anyway they
78  * so choose, but are expected to return the statistics
79  * in the following structure.
80  */
81 struct pmap_statistics {
82 	long resident_count;	/* # of pages mapped (total) */
83 	long wired_count;	/* # of pages wired */
84 };
85 typedef struct pmap_statistics *pmap_statistics_t;
86 
87 #include <machine/pmap.h>
88 
89 #ifdef KERNEL
90 __BEGIN_DECLS
91 void *pmap_bootstrap_alloc __P((int));
92 
93 #if 0				/* XXX */
94 void pmap_bootstrap __P(( /* machine dependent */ ));
95 
96 #endif
97 void pmap_change_wiring __P((pmap_t, vm_offset_t, boolean_t));
98 void pmap_clear_modify __P((vm_offset_t pa));
99 void pmap_clear_reference __P((vm_offset_t pa));
100 void pmap_collect __P((pmap_t));
101 void pmap_copy __P((pmap_t, pmap_t, vm_offset_t, vm_size_t, vm_offset_t));
102 void pmap_copy_page __P((vm_offset_t, vm_offset_t));
103 pmap_t pmap_create __P((vm_size_t));
104 void pmap_destroy __P((pmap_t));
105 void pmap_enter __P((pmap_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t));
106 vm_offset_t pmap_extract __P((pmap_t, vm_offset_t));
107 void pmap_init __P((vm_offset_t, vm_offset_t));
108 boolean_t pmap_is_modified __P((vm_offset_t pa));
109 boolean_t pmap_is_referenced __P((vm_offset_t pa));
110 void pmap_kenter __P((vm_offset_t, vm_offset_t));
111 void pmap_kremove __P((vm_offset_t));
112 vm_offset_t pmap_map __P((vm_offset_t, vm_offset_t, vm_offset_t, int));
113 void pmap_page_protect __P((vm_offset_t, vm_prot_t));
114 void pmap_pageable __P((pmap_t, vm_offset_t, vm_offset_t, boolean_t));
115 vm_offset_t pmap_phys_address __P((int));
116 void pmap_pinit __P((pmap_t));
117 void pmap_protect __P((pmap_t, vm_offset_t, vm_offset_t, vm_prot_t));
118 void pmap_qenter __P((vm_offset_t, vm_page_t *, int));
119 void pmap_qremove __P((vm_offset_t, int));
120 void pmap_reference __P((pmap_t));
121 void pmap_release __P((pmap_t));
122 void pmap_remove __P((pmap_t, vm_offset_t, vm_offset_t));
123 void pmap_zero_page __P((vm_offset_t));
124 
125 __END_DECLS
126 #endif
127 
128 #endif				/* _PMAP_VM_ */
129