2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * The Mach Operating System project at Carnegie-Mellon University.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
36 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95
39 * Copyright (c) 1987, 1990 Carnegie-Mellon University.
40 * All rights reserved.
42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young
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.
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.
54 * Carnegie Mellon requests users of this software to return to
56 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
57 * School of Computer Science
58 * Carnegie Mellon University
59 * Pittsburgh PA 15213-3890
61 * any improvements or extensions that they make and grant Carnegie the
62 * rights to redistribute these changes.
64 * $FreeBSD: src/sys/vm/vm_map.h,v 1.54.2.5 2003/01/13 22:51:17 dillon Exp $
65 * $DragonFly: src/sys/vm/vm_map.h,v 1.24 2006/09/12 18:41:32 dillon Exp $
69 * Virtual memory map module definitions.
76 #include <sys/types.h>
87 #ifndef _MACHINE_PMAP_H_
88 #include <machine/pmap.h>
91 struct vm_map_rb_tree;
92 RB_PROTOTYPE(vm_map_rb_tree, vm_map_entry, rb_entry, rb_vm_map_compare);
97 * vm_map_t the high-level address map data structure.
98 * vm_map_entry_t an entry in an address map.
101 typedef u_int vm_eflags_t;
104 * Objects which live in maps may be either VM objects, or
105 * another map (called a "sharing map") which denotes read-write
106 * sharing with other maps.
109 union vm_map_object {
110 struct vm_object *vm_object; /* object object */
111 struct vm_map *sub_map; /* belongs to another map */
115 * Address map entries consist of start and end addresses,
116 * a VM object (or sharing map) and offset into that object,
117 * and user-exported inheritance and protection information.
118 * Also included is control information for virtual copy operations.
120 * When used with MAP_STACK, avail_ssize is used to determine the
121 * limits of stack growth.
123 * When used with VM_MAPTYPE_VPAGETABLE, avail_ssize stores the
124 * page directory index.
126 struct vm_map_entry {
127 struct vm_map_entry *prev; /* previous entry */
128 struct vm_map_entry *next; /* next entry */
129 RB_ENTRY(vm_map_entry) rb_entry;
130 vm_offset_t start; /* start address */
131 vm_offset_t end; /* end address */
132 vm_offset_t avail_ssize; /* amt can grow if this is a stack */
133 union vm_map_object object; /* object I point to */
134 vm_ooffset_t offset; /* offset into object */
135 vm_eflags_t eflags; /* map entry flags */
136 vm_maptype_t maptype; /* type of VM mapping */
137 vm_prot_t protection; /* protection code */
138 vm_prot_t max_protection; /* maximum protection */
139 vm_inherit_t inheritance; /* inheritance */
140 int wired_count; /* can be paged if = 0 */
141 vm_pindex_t lastr; /* last read */
144 #define MAP_ENTRY_NOSYNC 0x0001
145 #define MAP_ENTRY_UNUSED0002 0x0002
146 #define MAP_ENTRY_COW 0x0004
147 #define MAP_ENTRY_NEEDS_COPY 0x0008
148 #define MAP_ENTRY_NOFAULT 0x0010
149 #define MAP_ENTRY_USER_WIRED 0x0020
151 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */
152 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */
153 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */
154 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */
156 #define MAP_ENTRY_BEHAV_MASK 0x00C0
158 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */
159 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiter's in transition */
160 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */
163 * flags for vm_map_[un]clip_range()
165 #define MAP_CLIP_NO_HOLES 0x0001
168 * This reserve count for vm_map_entry_reserve() should cover all nominal
169 * single-insertion operations, including any necessary clipping.
171 #define MAP_RESERVE_COUNT 4
172 #define MAP_RESERVE_SLOP 32
174 static __inline u_char
175 vm_map_entry_behavior(struct vm_map_entry *entry)
177 return entry->eflags & MAP_ENTRY_BEHAV_MASK;
181 vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior)
183 entry->eflags = (entry->eflags & ~MAP_ENTRY_BEHAV_MASK) |
184 (behavior & MAP_ENTRY_BEHAV_MASK);
188 * Maps are doubly-linked lists of map entries, kept sorted
189 * by address. A single hint is provided to start
190 * searches again from the last successful search,
191 * insertion, or removal.
193 * Note: the lock structure cannot be the first element of vm_map
194 * because this can result in a running lockup between two or more
195 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
196 * and free tsleep/waking up 'map' and the underlying lockmgr also
197 * sleeping and waking up on 'map'. The lockup occurs when the map fills
198 * up. The 'exec' map, for example.
201 struct vm_map_entry header; /* List of entries */
202 RB_HEAD(vm_map_rb_tree, vm_map_entry) rb_root;
203 struct lock lock; /* Lock for map data */
204 int nentries; /* Number of entries */
205 vm_size_t size; /* virtual size */
206 u_char system_map; /* Am I a system map? */
207 u_char infork; /* Am I in fork processing? */
208 vm_map_entry_t hint; /* hint for quick lookups */
209 unsigned int timestamp; /* Version number */
210 vm_map_entry_t first_free; /* First free space hint */
211 struct pmap *pmap; /* Physical map */
212 #define min_offset header.start
213 #define max_offset header.end
222 struct vmupcall *vu_next;
223 void *vu_func; /* user upcall function */
224 void *vu_data; /* user data */
225 void *vu_ctx; /* user context function */
226 struct lwp *vu_lwp; /* process that registered upcall */
227 int vu_id; /* upcall identifier */
228 int vu_pending; /* upcall request pending */
232 * Shareable process virtual address space.
233 * May eventually be merged with vm_map.
234 * Several fields are temporary (text, data stuff).
237 struct vm_map vm_map; /* VM address map */
238 struct pmap vm_pmap; /* private physical map */
239 int vm_refcnt; /* number of references */
240 caddr_t vm_shm; /* SYS5 shared memory private data XXX */
241 /* we copy from vm_startcopy to the end of the structure on fork */
242 #define vm_startcopy vm_rssize
243 segsz_t vm_rssize; /* current resident set size in pages */
244 segsz_t vm_swrss; /* resident set size before last swap */
245 segsz_t vm_tsize; /* text size (pages) XXX */
246 segsz_t vm_dsize; /* data size (pages) XXX */
247 segsz_t vm_ssize; /* stack size (pages) */
248 caddr_t vm_taddr; /* user virtual address of text XXX */
249 caddr_t vm_daddr; /* user virtual address of data XXX */
250 caddr_t vm_maxsaddr; /* user VA at max stack growth */
251 caddr_t vm_minsaddr; /* user VA at max stack growth */
252 #define vm_endcopy vm_exitingcnt
253 int vm_exitingcnt; /* several procsses zombied in exit1 */
254 int vm_upccount; /* number of registered upcalls */
256 struct vmupcall *vm_upcalls; /* registered upcalls */
260 * Resident executable holding structure. A user program can take a snapshot
261 * of just its VM address space (typically done just after dynamic link
262 * libraries have completed loading) and register it as a resident
263 * executable associated with the program binary's vnode, which is also
264 * locked into memory. Future execs of the vnode will start with a copy
265 * of the resident vmspace instead of running the binary from scratch,
266 * avoiding both the kernel ELF loader *AND* all shared library mapping and
267 * relocation code, and will call a different entry point (the stack pointer
268 * is reset to the top of the stack) supplied when the vmspace was registered.
271 struct vnode *vr_vnode; /* associated vnode */
272 TAILQ_ENTRY(vmresident) vr_link; /* linked list of res sts */
273 struct vmspace *vr_vmspace; /* vmspace to fork */
274 intptr_t vr_entry_addr; /* registered entry point */
275 struct sysentvec *vr_sysent; /* system call vects */
276 int vr_id; /* registration id */
281 * Macros: vm_map_lock, etc.
283 * Perform locking on the data portion of a map. Note that
284 * these macros mimic procedure calls returning void. The
285 * semicolon is supplied by the user of these macros, not
286 * by the macros themselves. The macros can safely be used
287 * as unbraced elements in a higher level statement.
291 /* #define MAP_LOCK_DIAGNOSTIC 1 */
292 #ifdef MAP_LOCK_DIAGNOSTIC
293 #define vm_map_lock(map) \
295 printf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \
296 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \
297 panic("vm_map_lock: failed to get lock"); \
299 (map)->timestamp++; \
302 #define vm_map_lock(map) \
304 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \
305 panic("vm_map_lock: failed to get lock"); \
307 (map)->timestamp++; \
311 #define vm_map_lock(map) \
313 lockmgr(&(map)->lock, LK_EXCLUSIVE); \
314 (map)->timestamp++; \
316 #endif /* DIAGNOSTIC */
318 #if defined(MAP_LOCK_DIAGNOSTIC)
319 #define vm_map_unlock(map) \
321 printf ("locking map LK_RELEASE: 0x%x\n", map); \
322 lockmgr(&(map)->lock, LK_RELEASE); \
324 #define vm_map_lock_read(map) \
326 printf ("locking map LK_SHARED: 0x%x\n", map); \
327 lockmgr(&(map)->lock, LK_SHARED); \
329 #define vm_map_unlock_read(map) \
331 printf ("locking map LK_RELEASE: 0x%x\n", map); \
332 lockmgr(&(map)->lock, LK_RELEASE); \
335 #define vm_map_unlock(map) \
336 lockmgr(&(map)->lock, LK_RELEASE)
337 #define vm_map_lock_read(map) \
338 lockmgr(&(map)->lock, LK_SHARED)
339 #define vm_map_unlock_read(map) \
340 lockmgr(&(map)->lock, LK_RELEASE)
343 static __inline__ int
344 vm_map_lock_upgrade(vm_map_t map) {
346 #if defined(MAP_LOCK_DIAGNOSTIC)
347 printf("locking map LK_EXCLUPGRADE: 0x%x\n", map);
349 error = lockmgr(&map->lock, LK_EXCLUPGRADE);
355 #if defined(MAP_LOCK_DIAGNOSTIC)
356 #define vm_map_lock_downgrade(map) \
358 printf ("locking map LK_DOWNGRADE: 0x%x\n", map); \
359 lockmgr(&(map)->lock, LK_DOWNGRADE); \
362 #define vm_map_lock_downgrade(map) \
363 lockmgr(&(map)->lock, LK_DOWNGRADE)
369 * Functions implemented as macros
371 #define vm_map_min(map) ((map)->min_offset)
372 #define vm_map_max(map) ((map)->max_offset)
373 #define vm_map_pmap(map) ((map)->pmap)
375 static __inline struct pmap *
376 vmspace_pmap(struct vmspace *vmspace)
378 return &vmspace->vm_pmap;
382 vmspace_resident_count(struct vmspace *vmspace)
384 return pmap_resident_count(vmspace_pmap(vmspace));
388 * Number of kernel maps and entries to statically allocate, required
389 * during boot to bootstrap the VM system.
392 #define MAX_MAPENT 256
395 * Copy-on-write flags for vm_map operations
397 #define MAP_UNUSED_01 0x0001
398 #define MAP_COPY_ON_WRITE 0x0002
399 #define MAP_NOFAULT 0x0004
400 #define MAP_PREFAULT 0x0008
401 #define MAP_PREFAULT_PARTIAL 0x0010
402 #define MAP_DISABLE_SYNCER 0x0020
403 #define MAP_DISABLE_COREDUMP 0x0100
404 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */
407 * vm_fault option flags
409 #define VM_FAULT_NORMAL 0 /* Nothing special */
410 #define VM_FAULT_CHANGE_WIRING 1 /* Change the wiring as appropriate */
411 #define VM_FAULT_USER_WIRE 2 /* Likewise, but for user purposes */
412 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
413 #define VM_FAULT_HOLD 4 /* Hold the page */
414 #define VM_FAULT_DIRTY 8 /* Dirty the page */
417 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
420 void vm_map_entry_reserve_cpu_init(struct globaldata *gd);
421 int vm_map_entry_reserve(int);
422 int vm_map_entry_kreserve(int);
423 void vm_map_entry_release(int);
424 void vm_map_entry_krelease(int);
425 vm_map_t vm_map_create (struct pmap *, vm_offset_t, vm_offset_t);
426 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t, int *);
427 int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t,
428 vm_offset_t *, vm_size_t,
431 vm_prot_t, vm_prot_t,
433 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t, vm_offset_t *);
434 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
435 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t);
436 int vm_map_insert (vm_map_t, int *, vm_object_t, vm_ooffset_t,
437 vm_offset_t, vm_offset_t,
439 vm_prot_t, vm_prot_t,
441 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
442 vm_pindex_t *, vm_prot_t *, boolean_t *);
443 void vm_map_lookup_done (vm_map_t, vm_map_entry_t, int);
444 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
445 int vm_map_wire (vm_map_t, vm_offset_t, vm_offset_t, int);
446 int vm_map_unwire (vm_map_t, vm_offset_t, vm_offset_t, boolean_t);
447 int vm_map_clean (vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
448 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
449 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
450 void vm_map_startup (void);
451 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
452 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
453 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t, int *);
454 void vm_init2 (void);
455 int vm_uiomove (vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *);
456 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
457 int vm_map_growstack (struct proc *p, vm_offset_t addr);
458 int vmspace_swap_count (struct vmspace *vmspace);
459 void vm_map_set_wired_quick(vm_map_t map, vm_offset_t addr, vm_size_t size, int *);
462 #endif /* _VM_VM_MAP_H_ */