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 $
68 * Virtual memory map module definitions.
75 #include <sys/types.h>
78 #ifndef _SYS_KERNEL_H_
79 #include <sys/kernel.h> /* ticks */
85 #ifndef _SYS_SYSREF_H_
86 #include <sys/sysref.h>
91 #ifndef _SYS_VKERNEL_H_
92 #include <sys/vkernel.h>
97 #ifndef _MACHINE_PMAP_H_
98 #include <machine/pmap.h>
100 #ifndef _VM_VM_OBJECT_H_
101 #include <vm/vm_object.h>
104 #include <sys/_null.h>
107 struct vm_map_rb_tree
;
108 RB_PROTOTYPE(vm_map_rb_tree
, vm_map_entry
, rb_entry
, rb_vm_map_compare
);
113 * vm_map_t the high-level address map data structure.
114 * vm_map_entry_t an entry in an address map.
117 typedef u_int vm_flags_t
;
118 typedef u_int vm_eflags_t
;
121 * A vm_map_entry may reference an object, a submap, a uksmap, or a
122 * direct user-kernel shared map.
124 union vm_map_object
{
125 struct vm_object
*vm_object
; /* object object */
126 struct vm_map
*sub_map
; /* belongs to another map */
127 int (*uksmap
)(struct cdev
*dev
, vm_page_t fake
);
128 void *map_object
; /* generic */
132 vm_offset_t avail_ssize
; /* amt can grow if this is a stack */
133 vpte_t master_pde
; /* virtual page table root */
139 * Address map entries consist of start and end addresses,
140 * a VM object (or sharing map) and offset into that object,
141 * and user-exported inheritance and protection information.
142 * Also included is control information for virtual copy operations.
144 * When used with MAP_STACK, avail_ssize is used to determine the
145 * limits of stack growth.
147 * When used with VM_MAPTYPE_VPAGETABLE, avail_ssize stores the
148 * page directory index.
150 struct vm_map_entry
{
151 struct vm_map_entry
*prev
; /* previous entry */
152 struct vm_map_entry
*next
; /* next entry */
153 RB_ENTRY(vm_map_entry
) rb_entry
;
154 vm_offset_t start
; /* start address */
155 vm_offset_t end
; /* end address */
156 union vm_map_aux aux
; /* auxillary data */
157 union vm_map_object object
; /* object I point to */
158 vm_ooffset_t offset
; /* offset into object */
159 vm_eflags_t eflags
; /* map entry flags */
160 vm_maptype_t maptype
; /* type of VM mapping */
161 vm_prot_t protection
; /* protection code */
162 vm_prot_t max_protection
; /* maximum protection */
163 vm_inherit_t inheritance
; /* inheritance */
164 int wired_count
; /* can be paged if = 0 */
167 #define MAP_ENTRY_NOSYNC 0x0001
168 #define MAP_ENTRY_STACK 0x0002
169 #define MAP_ENTRY_COW 0x0004
170 #define MAP_ENTRY_NEEDS_COPY 0x0008
171 #define MAP_ENTRY_NOFAULT 0x0010
172 #define MAP_ENTRY_USER_WIRED 0x0020
174 #define MAP_ENTRY_BEHAV_NORMAL 0x0000 /* default behavior */
175 #define MAP_ENTRY_BEHAV_SEQUENTIAL 0x0040 /* expect sequential access */
176 #define MAP_ENTRY_BEHAV_RANDOM 0x0080 /* expect random access */
177 #define MAP_ENTRY_BEHAV_RESERVED 0x00C0 /* future use */
179 #define MAP_ENTRY_BEHAV_MASK 0x00C0
181 #define MAP_ENTRY_IN_TRANSITION 0x0100 /* entry being changed */
182 #define MAP_ENTRY_NEEDS_WAKEUP 0x0200 /* waiter's in transition */
183 #define MAP_ENTRY_NOCOREDUMP 0x0400 /* don't include in a core */
184 #define MAP_ENTRY_KSTACK 0x0800 /* guarded kernel stack */
187 * flags for vm_map_[un]clip_range()
189 #define MAP_CLIP_NO_HOLES 0x0001
192 * This reserve count for vm_map_entry_reserve() should cover all nominal
193 * single-insertion operations, including any necessary clipping.
195 #define MAP_RESERVE_COUNT 4
196 #define MAP_RESERVE_SLOP 32
198 static __inline u_char
199 vm_map_entry_behavior(struct vm_map_entry
*entry
)
201 return entry
->eflags
& MAP_ENTRY_BEHAV_MASK
;
205 vm_map_entry_set_behavior(struct vm_map_entry
*entry
, u_char behavior
)
207 entry
->eflags
= (entry
->eflags
& ~MAP_ENTRY_BEHAV_MASK
) |
208 (behavior
& MAP_ENTRY_BEHAV_MASK
);
212 * Maps are doubly-linked lists of map entries, kept sorted by address.
213 * A single hint is provided to start searches again from the last
214 * successful search, insertion, or removal.
216 * NOTE: The lock structure cannot be the first element of vm_map
217 * because this can result in a running lockup between two or more
218 * system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
219 * and free tsleep/waking up 'map' and the underlying lockmgr also
220 * sleeping and waking up on 'map'. The lockup occurs when the map fills
221 * up. The 'exec' map, for example.
223 * NOTE: The vm_map structure can be hard-locked with the lockmgr lock
224 * or soft-serialized with the token, or both.
227 struct vm_map_entry header
; /* List of entries */
228 RB_HEAD(vm_map_rb_tree
, vm_map_entry
) rb_root
;
229 struct lock lock
; /* Lock for map data */
230 int nentries
; /* Number of entries */
231 vm_size_t size
; /* virtual size */
232 u_char system_map
; /* Am I a system map? */
233 vm_map_entry_t hint
; /* hint for quick lookups */
234 unsigned int timestamp
; /* Version number */
235 vm_map_entry_t first_free
; /* First free space hint */
236 vm_flags_t flags
; /* flags for this vm_map */
237 struct pmap
*pmap
; /* Physical map */
238 u_int president_cache
; /* Remember president count */
239 u_int president_ticks
; /* Save ticks for cache */
240 struct lwkt_token token
; /* Soft serializer */
241 #define min_offset header.start
242 #define max_offset header.end
248 #define MAP_WIREFUTURE 0x0001 /* wire all future pages */
251 * Shareable process virtual address space.
253 * Refd pointers from vmresident, proc
256 struct vm_map vm_map
; /* VM address map */
257 struct pmap vm_pmap
; /* private physical map */
259 caddr_t vm_shm
; /* SYS5 shared memory private data XXX */
260 /* we copy from vm_startcopy to the end of the structure on fork */
261 #define vm_startcopy vm_rssize
262 segsz_t vm_rssize
; /* current resident set size in pages */
263 segsz_t vm_swrss
; /* resident set size before last swap */
264 segsz_t vm_tsize
; /* text size (pages) XXX */
265 segsz_t vm_dsize
; /* data size (pages) XXX */
266 segsz_t vm_ssize
; /* stack size (pages) */
267 caddr_t vm_taddr
; /* user virtual address of text XXX */
268 caddr_t vm_daddr
; /* user virtual address of data XXX */
269 caddr_t vm_maxsaddr
; /* user VA at max stack growth */
270 caddr_t vm_minsaddr
; /* user VA at max stack growth */
271 #define vm_endcopy vm_unused01
275 u_int vm_holdcnt
; /* temporary hold count and exit sequencing */
276 u_int vm_refcnt
; /* normal ref count */
279 #define VMSPACE_EXIT1 0x0001 /* partial exit */
280 #define VMSPACE_EXIT2 0x0002 /* full exit */
282 #define VMSPACE_HOLDEXIT 0x80000000
285 * Resident executable holding structure. A user program can take a snapshot
286 * of just its VM address space (typically done just after dynamic link
287 * libraries have completed loading) and register it as a resident
288 * executable associated with the program binary's vnode, which is also
289 * locked into memory. Future execs of the vnode will start with a copy
290 * of the resident vmspace instead of running the binary from scratch,
291 * avoiding both the kernel ELF loader *AND* all shared library mapping and
292 * relocation code, and will call a different entry point (the stack pointer
293 * is reset to the top of the stack) supplied when the vmspace was registered.
296 struct vnode
*vr_vnode
; /* associated vnode */
297 TAILQ_ENTRY(vmresident
) vr_link
; /* linked list of res sts */
298 struct vmspace
*vr_vmspace
; /* vmspace to fork */
299 intptr_t vr_entry_addr
; /* registered entry point */
300 struct sysentvec
*vr_sysent
; /* system call vects */
301 int vr_id
; /* registration id */
302 int vr_refs
; /* temporary refs */
307 * Macros: vm_map_lock, etc.
309 * Perform locking on the data portion of a map. Note that
310 * these macros mimic procedure calls returning void. The
311 * semicolon is supplied by the user of these macros, not
312 * by the macros themselves. The macros can safely be used
313 * as unbraced elements in a higher level statement.
316 #define ASSERT_VM_MAP_LOCKED(map) KKASSERT(lockowned(&(map)->lock))
319 /* #define MAP_LOCK_DIAGNOSTIC 1 */
320 #ifdef MAP_LOCK_DIAGNOSTIC
321 #define vm_map_lock(map) \
323 kprintf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \
324 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \
325 panic("vm_map_lock: failed to get lock"); \
327 (map)->timestamp++; \
330 #define vm_map_lock(map) \
332 if (lockmgr(&(map)->lock, LK_EXCLUSIVE) != 0) { \
333 panic("vm_map_lock: failed to get lock"); \
335 (map)->timestamp++; \
339 #define vm_map_lock(map) \
341 lockmgr(&(map)->lock, LK_EXCLUSIVE); \
342 (map)->timestamp++; \
344 #endif /* DIAGNOSTIC */
346 #if defined(MAP_LOCK_DIAGNOSTIC)
347 #define vm_map_unlock(map) \
349 kprintf ("locking map LK_RELEASE: 0x%x\n", map); \
350 lockmgr(&(map)->lock, LK_RELEASE); \
352 #define vm_map_lock_read(map) \
354 kprintf ("locking map LK_SHARED: 0x%x\n", map); \
355 lockmgr(&(map)->lock, LK_SHARED); \
357 #define vm_map_unlock_read(map) \
359 kprintf ("locking map LK_RELEASE: 0x%x\n", map); \
360 lockmgr(&(map)->lock, LK_RELEASE); \
363 #define vm_map_unlock(map) \
364 lockmgr(&(map)->lock, LK_RELEASE)
365 #define vm_map_lock_read(map) \
366 lockmgr(&(map)->lock, LK_SHARED)
367 #define vm_map_unlock_read(map) \
368 lockmgr(&(map)->lock, LK_RELEASE)
371 #define vm_map_lock_read_try(map) \
372 lockmgr(&(map)->lock, LK_SHARED | LK_NOWAIT)
374 static __inline__
int
375 vm_map_lock_read_to(vm_map_t map
)
379 #if defined(MAP_LOCK_DIAGNOSTIC)
380 kprintf ("locking map LK_SHARED: 0x%x\n", map
);
382 error
= lockmgr(&(map
)->lock
, LK_SHARED
| LK_TIMELOCK
);
386 static __inline__
int
387 vm_map_lock_upgrade(vm_map_t map
) {
389 #if defined(MAP_LOCK_DIAGNOSTIC)
390 kprintf("locking map LK_EXCLUPGRADE: 0x%x\n", map
);
392 error
= lockmgr(&map
->lock
, LK_EXCLUPGRADE
);
398 #if defined(MAP_LOCK_DIAGNOSTIC)
399 #define vm_map_lock_downgrade(map) \
401 kprintf ("locking map LK_DOWNGRADE: 0x%x\n", map); \
402 lockmgr(&(map)->lock, LK_DOWNGRADE); \
405 #define vm_map_lock_downgrade(map) \
406 lockmgr(&(map)->lock, LK_DOWNGRADE)
412 * Functions implemented as macros
414 #define vm_map_min(map) ((map)->min_offset)
415 #define vm_map_max(map) ((map)->max_offset)
416 #define vm_map_pmap(map) ((map)->pmap)
421 static __inline
struct pmap
*
422 vmspace_pmap(struct vmspace
*vmspace
)
424 return &vmspace
->vm_pmap
;
428 * Caller must hold the vmspace->vm_map.token
431 vmspace_resident_count(struct vmspace
*vmspace
)
433 return pmap_resident_count(vmspace_pmap(vmspace
));
437 * Calculates the proportional RSS and returning the
438 * accrued result. This is a loose value for statistics/display
439 * purposes only and will only be updated if we can acquire
440 * a non-blocking map lock.
442 * (used by userland or the kernel)
444 static __inline u_int
445 vmspace_president_count(struct vmspace
*vmspace
)
447 vm_map_t map
= &vmspace
->vm_map
;
454 if (map
->president_ticks
== ticks
/ hz
|| vm_map_lock_read_try(map
))
455 return(map
->president_cache
);
458 for (cur
= map
->header
.next
; cur
!= &map
->header
; cur
= cur
->next
) {
459 switch(cur
->maptype
) {
460 case VM_MAPTYPE_NORMAL
:
461 case VM_MAPTYPE_VPAGETABLE
:
462 if ((object
= cur
->object
.vm_object
) == NULL
)
464 if (object
->type
!= OBJT_DEFAULT
&&
465 object
->type
!= OBJT_SWAP
) {
469 * synchronize non-zero case, contents of field
470 * can change at any time due to pmap ops.
472 if ((n
= object
->agg_pv_list_count
) != 0) {
476 count
+= object
->resident_page_count
/ n
;
484 map
->president_cache
= count
;
485 map
->president_ticks
= ticks
/ hz
;
486 vm_map_unlock_read(map
);
493 * Number of kernel maps and entries to statically allocate, required
494 * during boot to bootstrap the VM system.
497 #define MAX_MAPENT (SMP_MAXCPU * 32 + 1024)
500 * Copy-on-write flags for vm_map operations
502 #define MAP_UNUSED_01 0x0001
503 #define MAP_COPY_ON_WRITE 0x0002
504 #define MAP_NOFAULT 0x0004
505 #define MAP_PREFAULT 0x0008
506 #define MAP_PREFAULT_PARTIAL 0x0010
507 #define MAP_DISABLE_SYNCER 0x0020
508 #define MAP_IS_STACK 0x0040
509 #define MAP_IS_KSTACK 0x0080
510 #define MAP_DISABLE_COREDUMP 0x0100
511 #define MAP_PREFAULT_MADVISE 0x0200 /* from (user) madvise request */
512 #define MAP_PREFAULT_RELOCK 0x0200
515 * vm_fault option flags
517 #define VM_FAULT_NORMAL 0x00 /* Nothing special */
518 #define VM_FAULT_CHANGE_WIRING 0x01 /* Change the wiring as appropriate */
519 #define VM_FAULT_USER_WIRE 0x02 /* Likewise, but for user purposes */
520 #define VM_FAULT_BURST 0x04 /* Burst fault can be done */
521 #define VM_FAULT_DIRTY 0x08 /* Dirty the page */
522 #define VM_FAULT_UNSWAP 0x10 /* Remove backing store from the page */
523 #define VM_FAULT_BURST_QUICK 0x20 /* Special case shared vm_object */
524 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
528 boolean_t
vm_map_check_protection (vm_map_t
, vm_offset_t
, vm_offset_t
,
529 vm_prot_t
, boolean_t
);
532 void vm_map_entry_allocate_object(vm_map_entry_t
);
533 void vm_map_entry_reserve_cpu_init(struct globaldata
*gd
);
534 int vm_map_entry_reserve(int);
535 int vm_map_entry_kreserve(int);
536 void vm_map_entry_release(int);
537 void vm_map_entry_krelease(int);
538 vm_map_t
vm_map_create (vm_map_t
, struct pmap
*, vm_offset_t
, vm_offset_t
);
539 int vm_map_delete (vm_map_t
, vm_offset_t
, vm_offset_t
, int *);
540 int vm_map_find (vm_map_t
, void *, void *,
541 vm_ooffset_t
, vm_offset_t
*, vm_size_t
,
543 boolean_t
, vm_maptype_t
,
544 vm_prot_t
, vm_prot_t
, int);
545 int vm_map_findspace (vm_map_t
, vm_offset_t
, vm_size_t
, vm_size_t
,
547 vm_offset_t
vm_map_hint(struct proc
*, vm_offset_t
, vm_prot_t
);
548 int vm_map_inherit (vm_map_t
, vm_offset_t
, vm_offset_t
, vm_inherit_t
);
549 void vm_map_init (struct vm_map
*, vm_offset_t
, vm_offset_t
, pmap_t
);
550 int vm_map_insert (vm_map_t
, int *, void *, void *,
551 vm_ooffset_t
, vm_offset_t
, vm_offset_t
,
553 vm_prot_t
, vm_prot_t
, int);
554 int vm_map_lookup (vm_map_t
*, vm_offset_t
, vm_prot_t
, vm_map_entry_t
*, vm_object_t
*,
555 vm_pindex_t
*, vm_prot_t
*, boolean_t
*);
556 void vm_map_lookup_done (vm_map_t
, vm_map_entry_t
, int);
557 boolean_t
vm_map_lookup_entry (vm_map_t
, vm_offset_t
, vm_map_entry_t
*);
558 int vm_map_wire (vm_map_t
, vm_offset_t
, vm_offset_t
, int);
559 int vm_map_unwire (vm_map_t
, vm_offset_t
, vm_offset_t
, boolean_t
);
560 int vm_map_clean (vm_map_t
, vm_offset_t
, vm_offset_t
, boolean_t
, boolean_t
);
561 int vm_map_protect (vm_map_t
, vm_offset_t
, vm_offset_t
, vm_prot_t
, boolean_t
);
562 int vm_map_remove (vm_map_t
, vm_offset_t
, vm_offset_t
);
563 void vm_map_startup (void);
564 int vm_map_submap (vm_map_t
, vm_offset_t
, vm_offset_t
, vm_map_t
);
565 int vm_map_madvise (vm_map_t
, vm_offset_t
, vm_offset_t
, int, off_t
);
566 void vm_map_simplify_entry (vm_map_t
, vm_map_entry_t
, int *);
567 void vm_init2 (void);
568 int vm_uiomove (vm_map_t
, vm_object_t
, off_t
, int, vm_offset_t
, int *);
569 int vm_map_stack (vm_map_t
, vm_offset_t
, vm_size_t
, int,
570 vm_prot_t
, vm_prot_t
, int);
571 int vm_map_growstack (struct proc
*p
, vm_offset_t addr
);
572 int vmspace_swap_count (struct vmspace
*vmspace
);
573 int vmspace_anonymous_count (struct vmspace
*vmspace
);
574 void vm_map_set_wired_quick(vm_map_t map
, vm_offset_t addr
, vm_size_t size
, int *);
575 void vm_map_transition_wait(vm_map_t map
);
577 #if defined(__x86_64__) && defined(_KERNEL_VIRTUAL)
578 int vkernel_module_memory_alloc(vm_offset_t
*, size_t);
579 void vkernel_module_memory_free(vm_offset_t
, size_t);
583 #endif /* _VM_VM_MAP_H_ */