uvm_map.h revision 1.10 1 /* $NetBSD: uvm_map.h,v 1.10 1998/10/11 23:14:48 chuck Exp $ */
2
3 /*
4 * XXXCDC: "ROUGH DRAFT" QUALITY UVM PRE-RELEASE FILE!
5 * >>>USE AT YOUR OWN RISK, WORK IS NOT FINISHED<<<
6 */
7 /*
8 * Copyright (c) 1997 Charles D. Cranor and Washington University.
9 * Copyright (c) 1991, 1993, The Regents of the University of California.
10 *
11 * All rights reserved.
12 *
13 * This code is derived from software contributed to Berkeley by
14 * The Mach Operating System project at Carnegie-Mellon University.
15 *
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
18 * are met:
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 * 3. All advertising materials mentioning features or use of this software
25 * must display the following acknowledgement:
26 * This product includes software developed by Charles D. Cranor,
27 * Washington University, the University of California, Berkeley and
28 * its contributors.
29 * 4. Neither the name of the University nor the names of its contributors
30 * may be used to endorse or promote products derived from this software
31 * without specific prior written permission.
32 *
33 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
34 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
35 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
37 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
41 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
42 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * SUCH DAMAGE.
44 *
45 * @(#)vm_map.h 8.3 (Berkeley) 3/15/94
46 * from: Id: uvm_map.h,v 1.1.2.3 1998/02/07 01:16:55 chs Exp
47 *
48 *
49 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
50 * All rights reserved.
51 *
52 * Permission to use, copy, modify and distribute this software and
53 * its documentation is hereby granted, provided that both the copyright
54 * notice and this permission notice appear in all copies of the
55 * software, derivative works or modified versions, and any portions
56 * thereof, and that both notices appear in supporting documentation.
57 *
58 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
59 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
60 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
61 *
62 * Carnegie Mellon requests users of this software to return to
63 *
64 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU
65 * School of Computer Science
66 * Carnegie Mellon University
67 * Pittsburgh PA 15213-3890
68 *
69 * any improvements or extensions that they make and grant Carnegie the
70 * rights to redistribute these changes.
71 */
72
73 #ifndef _UVM_UVM_MAP_H_
74 #define _UVM_UVM_MAP_H_
75
76 /*
77 * uvm_map.h
78 */
79
80 /*
81 * macros
82 */
83
84 /*
85 * UVM_MAP_CLIP_START: ensure that the entry begins at or after
86 * the starting address, if it doesn't we split the entry.
87 *
88 * => map must be locked by caller
89 */
90
91 #define UVM_MAP_CLIP_START(MAP,ENTRY,VA) { \
92 if ((VA) > (ENTRY)->start) uvm_map_clip_start(MAP,ENTRY,VA); }
93
94 /*
95 * UVM_MAP_CLIP_END: ensure that the entry ends at or before
96 * the ending address, if it does't we split the entry.
97 *
98 * => map must be locked by caller
99 */
100
101 #define UVM_MAP_CLIP_END(MAP,ENTRY,VA) { \
102 if ((VA) < (ENTRY)->end) uvm_map_clip_end(MAP,ENTRY,VA); }
103
104 /*
105 * extract flags
106 */
107 #define UVM_EXTRACT_REMOVE 0x1 /* remove mapping from old map */
108 #define UVM_EXTRACT_CONTIG 0x2 /* try to keep it contig */
109 #define UVM_EXTRACT_QREF 0x4 /* use quick refs */
110 #define UVM_EXTRACT_FIXPROT 0x8 /* set prot to maxprot as we go */
111
112
113 /*
114 * handle inline options
115 */
116
117 #ifdef UVM_MAP_INLINE
118 #define MAP_INLINE static __inline
119 #else
120 #define MAP_INLINE /* nothing */
121 #endif /* UVM_MAP_INLINE */
122
123 /*
124 * protos: the following prototypes define the interface to vm_map
125 */
126
127 MAP_INLINE
128 void uvm_map_deallocate __P((vm_map_t));
129
130 int uvm_map_clean __P((vm_map_t, vaddr_t, vaddr_t, int));
131 void uvm_map_clip_start __P((vm_map_t,
132 vm_map_entry_t, vaddr_t));
133 void uvm_map_clip_end __P((vm_map_t, vm_map_entry_t,
134 vaddr_t));
135 MAP_INLINE
136 vm_map_t uvm_map_create __P((pmap_t, vaddr_t,
137 vaddr_t, boolean_t));
138 int uvm_map_extract __P((vm_map_t, vaddr_t, vsize_t,
139 vm_map_t, vaddr_t *, int));
140 vm_map_entry_t uvm_map_findspace __P((vm_map_t, vaddr_t, vsize_t,
141 vaddr_t *, struct uvm_object *, vaddr_t,
142 boolean_t));
143 int uvm_map_inherit __P((vm_map_t, vaddr_t, vaddr_t,
144 vm_inherit_t));
145 void uvm_map_init __P((void));
146 boolean_t uvm_map_lookup_entry __P((vm_map_t, vaddr_t,
147 vm_map_entry_t *));
148 MAP_INLINE
149 void uvm_map_reference __P((vm_map_t));
150 int uvm_map_replace __P((vm_map_t, vaddr_t, vaddr_t,
151 vm_map_entry_t, int));
152 int uvm_map_reserve __P((vm_map_t, vsize_t, vaddr_t,
153 vaddr_t *));
154 void uvm_map_setup __P((vm_map_t, vaddr_t,
155 vaddr_t, boolean_t));
156 int uvm_map_submap __P((vm_map_t, vaddr_t,
157 vaddr_t, vm_map_t));
158 MAP_INLINE
159 int uvm_unmap __P((vm_map_t, vaddr_t, vaddr_t));
160 void uvm_unmap_detach __P((vm_map_entry_t,int));
161 int uvm_unmap_remove __P((vm_map_t, vaddr_t, vaddr_t,
162 vm_map_entry_t *));
163
164 struct vmspace *uvmspace_fork __P((struct vmspace *));
165
166 #endif /* _UVM_UVM_MAP_H_ */
167