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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95
33 *
34 *
35 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36 * All rights reserved.
37 *
38 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
39 *
40 * Permission to use, copy, modify and distribute this software and
41 * its documentation is hereby granted, provided that both the copyright
42 * notice and this permission notice appear in all copies of the
43 * software, derivative works or modified versions, and any portions
44 * thereof, and that both notices appear in supporting documentation.
45 *
46 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
49 *
50 * Carnegie Mellon requests users of this software to return to
51 *
52 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
53 * School of Computer Science
54 * Carnegie Mellon University
55 * Pittsburgh PA 15213-3890
56 *
57 * any improvements or extensions that they make and grant Carnegie the
58 * rights to redistribute these changes.
59 *
60 * $FreeBSD: head/sys/vm/vm_map.h 153068 2005-12-03 22:41:15Z alc $
61 */
62
63/*
64 * Virtual memory map module definitions.
65 */
66#ifndef _VM_MAP_
67#define _VM_MAP_
68
69#include <sys/lock.h>
70#include <sys/sx.h>
71#include <sys/_mutex.h>
72
73/*
74 * Types defined:
75 *
76 * vm_map_t the high-level address map data structure.
77 * vm_map_entry_t an entry in an address map.
78 */
79
80typedef u_char vm_flags_t;
81typedef u_int vm_eflags_t;
82
83/*
84 * Objects which live in maps may be either VM objects, or
85 * another map (called a "sharing map") which denotes read-write
86 * sharing with other maps.
87 */
88union vm_map_object {
89 struct vm_object *vm_object; /* object object */
90 struct vm_map *sub_map; /* belongs to another map */
91};
92
93/*
94 * Address map entries consist of start and end addresses,
95 * a VM object (or sharing map) and offset into that object,
96 * and user-exported inheritance and protection information.
97 * Also included is control information for virtual copy operations.
98 */
99struct vm_map_entry {
100 struct vm_map_entry *prev; /* previous entry */
101 struct vm_map_entry *next; /* next entry */
102 struct vm_map_entry *left; /* left child in binary search tree */
103 struct vm_map_entry *right; /* right child in binary search tree */
104 vm_offset_t start; /* start address */
105 vm_offset_t end; /* end address */
106 vm_offset_t avail_ssize; /* amt can grow if this is a stack */
107 vm_size_t adj_free; /* amount of adjacent free space */
108 vm_size_t max_free; /* max free space in subtree */
109 union vm_map_object object; /* object I point to */
110 vm_ooffset_t offset; /* offset into object */
111 vm_eflags_t eflags; /* map entry flags */
112 /* Only in task maps: */
113 vm_prot_t protection; /* protection code */
114 vm_prot_t max_protection; /* maximum protection */
115 vm_inherit_t inheritance; /* inheritance */
116 int wired_count; /* can be paged if = 0 */
117 vm_pindex_t lastr; /* last read */
118};
119
120#define MAP_ENTRY_NOSYNC 0x0001
121#define MAP_ENTRY_IS_SUB_MAP 0x0002
122#define MAP_ENTRY_COW 0x0004
123#define MAP_ENTRY_NEEDS_COPY 0x0008
124#define MAP_ENTRY_NOFAULT 0x0010
125#define MAP_ENTRY_USER_WIRED 0x0020
126
127#define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */
128#define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */
129#define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */
130#define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */
131
132#define MAP_ENTRY_BEHAV_MASK 0x00C0
133
134#define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */
135#define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiters in transition */
136#define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */
137
138#define MAP_ENTRY_GROWS_DOWN 0x1000 /* Top-down stacks */
139#define MAP_ENTRY_GROWS_UP 0x2000 /* Bottom-up stacks */
140
141#ifdef _KERNEL
142static __inline u_char
143vm_map_entry_behavior(vm_map_entry_t entry)
144{
145 return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
146}
147
148static __inline int
149vm_map_entry_user_wired_count(vm_map_entry_t entry)
150{
151 if (entry->eflags & MAP_ENTRY_USER_WIRED)
152 return (1);
153 return (0);
154}
155
156static __inline int
157vm_map_entry_system_wired_count(vm_map_entry_t entry)
158{
159 return (entry->wired_count - vm_map_entry_user_wired_count(entry));
160}
161#endif /* _KERNEL */
162
163/*
164 * A map is a set of map entries. These map entries are
165 * organized both as a binary search tree and as a doubly-linked
166 * list. Both structures are ordered based upon the start and
167 * end addresses contained within each map entry. Sleator and
168 * Tarjan's top-down splay algorithm is employed to control
169 * height imbalance in the binary search tree.
170 *
171 * Note: the lock structure cannot be the first element of vm_map
172 * because this can result in a running lockup between two or more
173 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
174 * and free tsleep/waking up 'map' and the underlying lockmgr also
175 * sleeping and waking up on 'map'. The lockup occurs when the map fills
176 * up. The 'exec' map, for example.
177 *
178 * List of locks
179 * (c) const until freed
180 */
181struct vm_map {
182 struct vm_map_entry header; /* List of entries */
183 struct sx lock; /* Lock for map data */
184 struct mtx system_mtx;
185 int nentries; /* Number of entries */
186 vm_size_t size; /* virtual size */
187 u_int timestamp; /* Version number */
188 u_char needs_wakeup;
189 u_char system_map; /* Am I a system map? */
190 vm_flags_t flags; /* flags for this vm_map */
191 vm_map_entry_t root; /* Root of a binary search tree */
192 pmap_t pmap; /* (c) Physical map */
193#define min_offset header.start /* (c) */
194#define max_offset header.end /* (c) */
195};
196
197/*
198 * vm_flags_t values
199 */
200#define MAP_WIREFUTURE 0x01 /* wire all future pages */
201
202#ifdef _KERNEL
203static __inline vm_offset_t
204vm_map_max(vm_map_t map)
205{
206 return (map->max_offset);
207}
208
209static __inline vm_offset_t
210vm_map_min(vm_map_t map)
211{
212 return (map->min_offset);
213}
214
215static __inline pmap_t
216vm_map_pmap(vm_map_t map)
217{
218 return (map->pmap);
219}
220
221static __inline void
222vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
223{
224 map->flags = (map->flags | set) & ~clear;
225}
226#endif /* _KERNEL */
227
228/*
229 * Shareable process virtual address space.
230 *
231 * List of locks
232 * (c) const until freed
233 */
234struct vmspace {
235 struct vm_map vm_map; /* VM address map */
236 struct pmap vm_pmap; /* private physical map */
237 struct shmmap_state *vm_shm; /* SYS5 shared memory private data XXX */
238 segsz_t vm_swrss; /* resident set size before last swap */
239 segsz_t vm_tsize; /* text size (pages) XXX */
240 segsz_t vm_dsize; /* data size (pages) XXX */
241 segsz_t vm_ssize; /* stack size (pages) */
242 caddr_t vm_taddr; /* (c) user virtual address of text */
243 caddr_t vm_daddr; /* (c) user virtual address of data */
244 caddr_t vm_maxsaddr; /* user VA at max stack growth */
245 int vm_exitingcnt; /* several processes zombied in exit1 */
246 int vm_refcnt; /* number of references */
247};
248
249#ifdef _KERNEL
250static __inline pmap_t
251vmspace_pmap(struct vmspace *vmspace)
252{
253 return &vmspace->vm_pmap;
254}
255#endif /* _KERNEL */
256
257#ifdef _KERNEL
258/*
259 * Macros: vm_map_lock, etc.
260 * Function:
261 * Perform locking on the data portion of a map. Note that
262 * these macros mimic procedure calls returning void. The
263 * semicolon is supplied by the user of these macros, not
264 * by the macros themselves. The macros can safely be used
265 * as unbraced elements in a higher level statement.
266 */
267
268void _vm_map_lock(vm_map_t map, const char *file, int line);
269void _vm_map_unlock(vm_map_t map, const char *file, int line);
270void _vm_map_lock_read(vm_map_t map, const char *file, int line);
271void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
272int _vm_map_trylock(vm_map_t map, const char *file, int line);
273int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
274int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
275void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
276int vm_map_unlock_and_wait(vm_map_t map, boolean_t user_wait);
277void vm_map_wakeup(vm_map_t map);
278
279#define vm_map_lock(map) _vm_map_lock(map, LOCK_FILE, LOCK_LINE)
280#define vm_map_unlock(map) _vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
281#define vm_map_lock_read(map) _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
282#define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
283#define vm_map_trylock(map) _vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
284#define vm_map_trylock_read(map) \
285 _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
286#define vm_map_lock_upgrade(map) \
287 _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
288#define vm_map_lock_downgrade(map) \
289 _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
290
291long vmspace_resident_count(struct vmspace *vmspace);
292long vmspace_wired_count(struct vmspace *vmspace);
293#endif /* _KERNEL */
294
295
296/* XXX: number of kernel maps and entries to statically allocate */
297#define MAX_KMAP 10
298#define MAX_KMAPENT 128
299
300/*
301 * Copy-on-write flags for vm_map operations
302 */
303#define MAP_UNUSED_01 0x0001
304#define MAP_COPY_ON_WRITE 0x0002
305#define MAP_NOFAULT 0x0004
306#define MAP_PREFAULT 0x0008
307#define MAP_PREFAULT_PARTIAL 0x0010
308#define MAP_DISABLE_SYNCER 0x0020
309#define MAP_DISABLE_COREDUMP 0x0100
310#define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */
311#define MAP_STACK_GROWS_DOWN 0x1000
312#define MAP_STACK_GROWS_UP 0x2000
313
314/*
315 * vm_fault option flags
316 */
317#define VM_FAULT_NORMAL 0 /* Nothing special */
318#define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */
319#define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */
320#define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
321#define VM_FAULT_DIRTY 8 /* Dirty the page */
322
323/*
324 * vm_map_wire and vm_map_unwire option flags
325 */
326#define VM_MAP_WIRE_SYSTEM 0 /* wiring in a kernel map */
327#define VM_MAP_WIRE_USER 1 /* wiring in a user map */
328
329#define VM_MAP_WIRE_NOHOLES 0 /* region must not have holes */
330#define VM_MAP_WIRE_HOLESOK 2 /* region may have holes */
331
332#ifdef _KERNEL
333boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
334vm_map_t vm_map_create(pmap_t, vm_offset_t, vm_offset_t);
335int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t);
336int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int);
337int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *);
338int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
339void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t);
340int vm_map_insert (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int);
341int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
342 vm_pindex_t *, vm_prot_t *, boolean_t *);
343int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
344 vm_pindex_t *, vm_prot_t *, boolean_t *);
345void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
346boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
347void vm_map_pmap_enter(vm_map_t map, vm_offset_t addr, vm_prot_t prot,
348 vm_object_t object, vm_pindex_t pindex, vm_size_t size, int flags);
349int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
350int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
351void vm_map_startup (void);
352int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
353int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
354int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
355void vm_map_simplify_entry (vm_map_t, vm_map_entry_t);
356void vm_init2 (void);
357int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
358int vm_map_growstack (struct proc *p, vm_offset_t addr);
359int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
360 int flags);
361int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end,
362 int flags);
363int vmspace_swap_count (struct vmspace *vmspace);
364#endif /* _KERNEL */
365#endif /* _VM_MAP_ */