vm_map.h revision 22975
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 * @(#)vm_map.h 8.9 (Berkeley) 5/17/95 37 * 38 * 39 * Copyright (c) 1987, 1990 Carnegie-Mellon University. 40 * All rights reserved. 41 * 42 * Authors: Avadis Tevanian, Jr., Michael Wayne Young 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$ 65 */ 66 67/* 68 * Virtual memory map module definitions. 69 */ 70 71#ifndef _VM_MAP_ 72#define _VM_MAP_ 73 74/* 75 * Types defined: 76 * 77 * vm_map_t the high-level address map data structure. 78 * vm_map_entry_t an entry in an address map. 79 * vm_map_version_t a timestamp of a map, for use with vm_map_lookup 80 */ 81 82/* 83 * Objects which live in maps may be either VM objects, or 84 * another map (called a "sharing map") which denotes read-write 85 * sharing with other maps. 86 */ 87 88union vm_map_object { 89 struct vm_object *vm_object; /* object object */ 90 struct vm_map *share_map; /* share map */ 91 struct vm_map *sub_map; /* belongs to another map */ 92}; 93 94/* 95 * Address map entries consist of start and end addresses, 96 * a VM object (or sharing map) and offset into that object, 97 * and user-exported inheritance and protection information. 98 * Also included is control information for virtual copy operations. 99 */ 100struct vm_map_entry { 101 struct vm_map_entry *prev; /* previous entry */ 102 struct vm_map_entry *next; /* next entry */ 103 vm_offset_t start; /* start address */ 104 vm_offset_t end; /* end address */ 105 union vm_map_object object; /* object I point to */ 106 vm_ooffset_t offset; /* offset into object */ 107 u_char eflags; /* map entry flags */ 108 /* Only in task maps: */ 109 vm_prot_t protection; /* protection code */ 110 vm_prot_t max_protection; /* maximum protection */ 111 vm_inherit_t inheritance; /* inheritance */ 112 int wired_count; /* can be paged if = 0 */ 113}; 114 115#define MAP_ENTRY_IS_A_MAP 0x1 116#define MAP_ENTRY_IS_SUB_MAP 0x2 117#define MAP_ENTRY_COW 0x4 118#define MAP_ENTRY_NEEDS_COPY 0x8 119#define MAP_ENTRY_NOFAULT 0x10 120#define MAP_ENTRY_USER_WIRED 0x20 121 122/* 123 * Maps are doubly-linked lists of map entries, kept sorted 124 * by address. A single hint is provided to start 125 * searches again from the last successful search, 126 * insertion, or removal. 127 */ 128struct vm_map { 129 struct pmap *pmap; /* Physical map */ 130 struct lock lock; /* Lock for map data */ 131 struct vm_map_entry header; /* List of entries */ 132 int nentries; /* Number of entries */ 133 vm_size_t size; /* virtual size */ 134 boolean_t is_main_map; /* Am I a main map? */ 135 int ref_count; /* Reference count */ 136 struct simplelock ref_lock; /* Lock for ref_count field */ 137 vm_map_entry_t hint; /* hint for quick lookups */ 138 vm_map_entry_t first_free; /* First free space hint */ 139 boolean_t entries_pageable; /* map entries pageable?? */ 140 unsigned int timestamp; /* Version number */ 141#define min_offset header.start 142#define max_offset header.end 143}; 144 145/* 146 * Shareable process virtual address space. 147 * May eventually be merged with vm_map. 148 * Several fields are temporary (text, data stuff). 149 */ 150struct vmspace { 151 struct vm_map vm_map; /* VM address map */ 152 struct pmap vm_pmap; /* private physical map */ 153 int vm_refcnt; /* number of references */ 154 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 155 vm_object_t vm_upages_obj; /* UPAGES object */ 156/* we copy from vm_startcopy to the end of the structure on fork */ 157#define vm_startcopy vm_rssize 158 segsz_t vm_rssize; /* current resident set size in pages */ 159 segsz_t vm_swrss; /* resident set size before last swap */ 160 segsz_t vm_tsize; /* text size (pages) XXX */ 161 segsz_t vm_dsize; /* data size (pages) XXX */ 162 segsz_t vm_ssize; /* stack size (pages) */ 163 caddr_t vm_taddr; /* user virtual address of text XXX */ 164 caddr_t vm_daddr; /* user virtual address of data XXX */ 165 caddr_t vm_maxsaddr; /* user VA at max stack growth */ 166 caddr_t vm_minsaddr; /* user VA at max stack growth */ 167}; 168 169 170/* 171 * Map versions are used to validate a previous lookup attempt. 172 * 173 * Since lookup operations may involve both a main map and 174 * a sharing map, it is necessary to have a timestamp from each. 175 * [If the main map timestamp has changed, the share_map and 176 * associated timestamp are no longer valid; the map version 177 * does not include a reference for the embedded share_map.] 178 */ 179typedef struct { 180 int main_timestamp; 181 vm_map_t share_map; 182 int share_timestamp; 183} vm_map_version_t; 184 185/* 186 * Macros: vm_map_lock, etc. 187 * Function: 188 * Perform locking on the data portion of a map. 189 */ 190 191#define vm_map_lock_drain_interlock(map) { \ 192 lockmgr(&(map)->lock, LK_DRAIN|LK_INTERLOCK, \ 193 &(map)->ref_lock, curproc); \ 194 (map)->timestamp++; \ 195} 196#ifdef DIAGNOSTIC 197#define vm_map_lock(map) { \ 198 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \ 199 panic("vm_map_lock: failed to get lock"); \ 200 } \ 201 (map)->timestamp++; \ 202} 203#else 204#define vm_map_lock(map) { \ 205 lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc); \ 206 (map)->timestamp++; \ 207} 208#endif /* DIAGNOSTIC */ 209#define vm_map_unlock(map) \ 210 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc) 211#define vm_map_lock_read(map) \ 212 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc) 213#define vm_map_unlock_read(map) \ 214 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc) 215#define vm_map_set_recursive(map) { \ 216 simple_lock(&(map)->lock.lk_interlock); \ 217 (map)->lock.lk_flags |= LK_CANRECURSE; \ 218 simple_unlock(&(map)->lock.lk_interlock); \ 219} 220#define vm_map_clear_recursive(map) { \ 221 simple_lock(&(map)->lock.lk_interlock); \ 222 (map)->lock.lk_flags &= ~LK_CANRECURSE; \ 223 simple_unlock(&(map)->lock.lk_interlock); \ 224} 225/* 226 * Functions implemented as macros 227 */ 228#define vm_map_min(map) ((map)->min_offset) 229#define vm_map_max(map) ((map)->max_offset) 230#define vm_map_pmap(map) ((map)->pmap) 231 232/* XXX: number of kernel maps and entries to statically allocate */ 233#define MAX_KMAP 10 234#define MAX_KMAPENT 128 235 236/* 237 * Copy-on-write flags for vm_map operations 238 */ 239#define MAP_COPY_NEEDED 0x1 240#define MAP_COPY_ON_WRITE 0x2 241#define MAP_NOFAULT 0x4 242 243/* 244 * vm_fault option flags 245 */ 246#define VM_FAULT_NORMAL 0 247#define VM_FAULT_CHANGE_WIRING 1 248#define VM_FAULT_USER_WIRE 2 249 250#ifdef KERNEL 251extern vm_offset_t kentry_data; 252extern vm_size_t kentry_data_size; 253 254boolean_t vm_map_check_protection __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t)); 255int vm_map_copy __P((vm_map_t, vm_map_t, vm_offset_t, vm_size_t, vm_offset_t, boolean_t, boolean_t)); 256struct pmap; 257vm_map_t vm_map_create __P((struct pmap *, vm_offset_t, vm_offset_t, boolean_t)); 258void vm_map_deallocate __P((vm_map_t)); 259int vm_map_delete __P((vm_map_t, vm_offset_t, vm_offset_t)); 260int vm_map_find __P((vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int)); 261int vm_map_findspace __P((vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *)); 262int vm_map_inherit __P((vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t)); 263void vm_map_init __P((struct vm_map *, vm_offset_t, vm_offset_t, boolean_t)); 264int vm_map_insert __P((vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int)); 265int vm_map_lookup __P((vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *, 266 vm_pindex_t *, vm_prot_t *, boolean_t *, boolean_t *)); 267void vm_map_lookup_done __P((vm_map_t, vm_map_entry_t)); 268boolean_t vm_map_lookup_entry __P((vm_map_t, vm_offset_t, vm_map_entry_t *)); 269int vm_map_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 270int vm_map_user_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t)); 271int vm_map_clean __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t)); 272int vm_map_protect __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t)); 273void vm_map_reference __P((vm_map_t)); 274int vm_map_remove __P((vm_map_t, vm_offset_t, vm_offset_t)); 275void vm_map_simplify __P((vm_map_t, vm_offset_t)); 276void vm_map_startup __P((void)); 277int vm_map_submap __P((vm_map_t, vm_offset_t, vm_offset_t, vm_map_t)); 278void vm_map_madvise __P((vm_map_t, pmap_t, vm_offset_t, vm_offset_t, int)); 279void vm_map_simplify_entry __P((vm_map_t, vm_map_entry_t)); 280 281#endif 282#endif /* _VM_MAP_ */ 283