sys/vm/vm_map.h

   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  * $FreeBSD: src/sys/vm/vm_map.h,v 1.54.2.5 2003/01/13 22:51:17 dillon Exp $
  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  */
  80
  81 typedef 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  */
  88
  89 union vm_map_object {
  90         struct vm_object *vm_object;    /* object object */
  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  */
 100 struct 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         vm_offset_t avail_ssize;        /* amt can grow if this is a stack */
 106         union vm_map_object object;     /* object I point to */
 107         vm_ooffset_t offset;            /* offset into object */
 108         vm_eflags_t eflags;             /* map entry flags */
 109         /* Only in task maps: */
 110         vm_prot_t protection;           /* protection code */
 111         vm_prot_t max_protection;       /* maximum protection */
 112         vm_inherit_t inheritance;       /* inheritance */
 113         int wired_count;                /* can be paged if = 0 */
 114         vm_pindex_t lastr;              /* last read */
 115 };
 116
 117 #define MAP_ENTRY_NOSYNC                0x0001
 118 #define MAP_ENTRY_IS_SUB_MAP            0x0002
 119 #define MAP_ENTRY_COW                   0x0004
 120 #define MAP_ENTRY_NEEDS_COPY            0x0008
 121 #define MAP_ENTRY_NOFAULT               0x0010
 122 #define MAP_ENTRY_USER_WIRED            0x0020
 123
 124 #define MAP_ENTRY_BEHAV_NORMAL          0x0000  /* default behavior */
 125 #define MAP_ENTRY_BEHAV_SEQUENTIAL      0x0040  /* expect sequential access */
 126 #define MAP_ENTRY_BEHAV_RANDOM          0x0080  /* expect random access */
 127 #define MAP_ENTRY_BEHAV_RESERVED        0x00C0  /* future use */
 128
 129 #define MAP_ENTRY_BEHAV_MASK            0x00C0
 130
 131 #define MAP_ENTRY_IN_TRANSITION         0x0100  /* entry being changed */
 132 #define MAP_ENTRY_NEEDS_WAKEUP          0x0200  /* waiter's in transition */
 133 #define MAP_ENTRY_NOCOREDUMP            0x0400  /* don't include in a core */
 134
 135 /*
 136  * flags for vm_map_[un]clip_range()
 137  */
 138 #define MAP_CLIP_NO_HOLES               0x0001
 139
 140 static __inline u_char
 141 vm_map_entry_behavior(struct vm_map_entry *entry)
 142 {
 143         return entry->eflags & MAP_ENTRY_BEHAV_MASK;
 144 }
 145
 146 static __inline void
 147 vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior)
 148 {
 149         entry->eflags = (entry->eflags & ~MAP_ENTRY_BEHAV_MASK) |
 150                 (behavior & MAP_ENTRY_BEHAV_MASK);
 151 }
 152
 153 /*
 154  *      Maps are doubly-linked lists of map entries, kept sorted
 155  *      by address.  A single hint is provided to start
 156  *      searches again from the last successful search,
 157  *      insertion, or removal.
 158  *
 159  *      Note: the lock structure cannot be the first element of vm_map
 160  *      because this can result in a running lockup between two or more
 161  *      system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
 162  *      and free tsleep/waking up 'map' and the underlying lockmgr also
 163  *      sleeping and waking up on 'map'.  The lockup occurs when the map fills
 164  *      up.  The 'exec' map, for example.
 165  */
 166 struct vm_map {
 167         struct vm_map_entry header;     /* List of entries */
 168         struct lock lock;               /* Lock for map data */
 169         int nentries;                   /* Number of entries */
 170         vm_size_t size;                 /* virtual size */
 171         u_char system_map;              /* Am I a system map? */
 172         u_char infork;                  /* Am I in fork processing? */
 173         vm_map_entry_t hint;            /* hint for quick lookups */
 174         unsigned int timestamp;         /* Version number */
 175         vm_map_entry_t first_free;      /* First free space hint */
 176         struct pmap *pmap;              /* Physical map */
 177 #define min_offset              header.start
 178 #define max_offset              header.end
 179 };
 180
 181 /*
 182  * Shareable process virtual address space.
 183  * May eventually be merged with vm_map.
 184  * Several fields are temporary (text, data stuff).
 185  */
 186 struct vmspace {
 187         struct vm_map vm_map;   /* VM address map */
 188         struct pmap vm_pmap;    /* private physical map */
 189         int vm_refcnt;          /* number of references */
 190         caddr_t vm_shm;         /* SYS5 shared memory private data XXX */
 191 /* we copy from vm_startcopy to the end of the structure on fork */
 192 #define vm_startcopy vm_rssize
 193         segsz_t vm_rssize;      /* current resident set size in pages */
 194         segsz_t vm_swrss;       /* resident set size before last swap */
 195         segsz_t vm_tsize;       /* text size (pages) XXX */
 196         segsz_t vm_dsize;       /* data size (pages) XXX */
 197         segsz_t vm_ssize;       /* stack size (pages) */
 198         caddr_t vm_taddr;       /* user virtual address of text XXX */
 199         caddr_t vm_daddr;       /* user virtual address of data XXX */
 200         caddr_t vm_maxsaddr;    /* user VA at max stack growth */
 201         caddr_t vm_minsaddr;    /* user VA at max stack growth */
 202         int     vm_exitingcnt;  /* several procsses zombied in exit1 */
 203 };
 204
 205 /*
 206  *      Macros:         vm_map_lock, etc.
 207  *      Function:
 208  *              Perform locking on the data portion of a map.  Note that
 209  *              these macros mimic procedure calls returning void.  The
 210  *              semicolon is supplied by the user of these macros, not
 211  *              by the macros themselves.  The macros can safely be used
 212  *              as unbraced elements in a higher level statement.
 213  */
 214
 215 #define vm_map_lock_drain_interlock(map) \
 216         do { \
 217                 lockmgr(&(map)->lock, LK_DRAIN|LK_INTERLOCK, \
 218                         &(map)->ref_lock, curproc); \
 219                 (map)->timestamp++; \
 220         } while(0)
 221
 222 #ifdef DIAGNOSTIC
 223 /* #define MAP_LOCK_DIAGNOSTIC 1 */
 224 #ifdef MAP_LOCK_DIAGNOSTIC
 225 #define vm_map_lock(map) \
 226         do { \
 227                 printf ("locking map LK_EXCLUSIVE: 0x%x\n", map); \
 228                 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \
 229                         panic("vm_map_lock: failed to get lock"); \
 230                 } \
 231                 (map)->timestamp++; \
 232         } while(0)
 233 #else
 234 #define vm_map_lock(map) \
 235         do { \
 236                 if (lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc) != 0) { \
 237                         panic("vm_map_lock: failed to get lock"); \
 238                 } \
 239                 (map)->timestamp++; \
 240         } while(0)
 241 #endif
 242 #else
 243 #define vm_map_lock(map) \
 244         do { \
 245                 lockmgr(&(map)->lock, LK_EXCLUSIVE, (void *)0, curproc); \
 246                 (map)->timestamp++; \
 247         } while(0)
 248 #endif /* DIAGNOSTIC */
 249
 250 #if defined(MAP_LOCK_DIAGNOSTIC)
 251 #define vm_map_unlock(map) \
 252         do { \
 253                 printf ("locking map LK_RELEASE: 0x%x\n", map); \
 254                 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \
 255         } while (0)
 256 #define vm_map_lock_read(map) \
 257         do { \
 258                 printf ("locking map LK_SHARED: 0x%x\n", map); \
 259                 lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc); \
 260         } while (0)
 261 #define vm_map_unlock_read(map) \
 262         do { \
 263                 printf ("locking map LK_RELEASE: 0x%x\n", map); \
 264                 lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc); \
 265         } while (0)
 266 #else
 267 #define vm_map_unlock(map) \
 268         lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc)
 269 #define vm_map_lock_read(map) \
 270         lockmgr(&(map)->lock, LK_SHARED, (void *)0, curproc)
 271 #define vm_map_unlock_read(map) \
 272         lockmgr(&(map)->lock, LK_RELEASE, (void *)0, curproc)
 273 #endif
 274
 275 static __inline__ int
 276 _vm_map_lock_upgrade(vm_map_t map, struct proc *p) {
 277         int error;
 278 #if defined(MAP_LOCK_DIAGNOSTIC)
 279         printf("locking map LK_EXCLUPGRADE: 0x%x\n", map);
 280 #endif
 281         error = lockmgr(&map->lock, LK_EXCLUPGRADE, (void *)0, p);
 282         if (error == 0)
 283                 map->timestamp++;
 284         return error;
 285 }
 286
 287 #define vm_map_lock_upgrade(map) _vm_map_lock_upgrade(map, curproc)
 288
 289 #if defined(MAP_LOCK_DIAGNOSTIC)
 290 #define vm_map_lock_downgrade(map) \
 291         do { \
 292                 printf ("locking map LK_DOWNGRADE: 0x%x\n", map); \
 293                 lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc); \
 294         } while (0)
 295 #else
 296 #define vm_map_lock_downgrade(map) \
 297         lockmgr(&(map)->lock, LK_DOWNGRADE, (void *)0, curproc)
 298 #endif
 299
 300 #define vm_map_set_recursive(map) \
 301         do { \
 302                 simple_lock(&(map)->lock.lk_interlock); \
 303                 (map)->lock.lk_flags |= LK_CANRECURSE; \
 304                 simple_unlock(&(map)->lock.lk_interlock); \
 305         } while(0)
 306 #define vm_map_clear_recursive(map) \
 307         do { \
 308                 simple_lock(&(map)->lock.lk_interlock); \
 309                 (map)->lock.lk_flags &= ~LK_CANRECURSE; \
 310                 simple_unlock(&(map)->lock.lk_interlock); \
 311         } while(0)
 312
 313 /*
 314  *      Functions implemented as macros
 315  */
 316 #define         vm_map_min(map)         ((map)->min_offset)
 317 #define         vm_map_max(map)         ((map)->max_offset)
 318 #define         vm_map_pmap(map)        ((map)->pmap)
 319
 320 static __inline struct pmap *
 321 vmspace_pmap(struct vmspace *vmspace)
 322 {
 323         return &vmspace->vm_pmap;
 324 }
 325
 326 static __inline long
 327 vmspace_resident_count(struct vmspace *vmspace)
 328 {
 329         return pmap_resident_count(vmspace_pmap(vmspace));
 330 }
 331
 332 /* XXX: number of kernel maps and entries to statically allocate */
 333 #define MAX_KMAP        10
 334 #define MAX_KMAPENT     128
 335 #define MAX_MAPENT      128
 336
 337 /*
 338  * Copy-on-write flags for vm_map operations
 339  */
 340 #define MAP_UNUSED_01           0x0001
 341 #define MAP_COPY_ON_WRITE       0x0002
 342 #define MAP_NOFAULT             0x0004
 343 #define MAP_PREFAULT            0x0008
 344 #define MAP_PREFAULT_PARTIAL    0x0010
 345 #define MAP_DISABLE_SYNCER      0x0020
 346 #define MAP_DISABLE_COREDUMP    0x0100
 347 #define MAP_PREFAULT_MADVISE    0x0200  /* from (user) madvise request */
 348
 349 /*
 350  * vm_fault option flags
 351  */
 352 #define VM_FAULT_NORMAL 0               /* Nothing special */
 353 #define VM_FAULT_CHANGE_WIRING 1        /* Change the wiring as appropriate */
 354 #define VM_FAULT_USER_WIRE 2            /* Likewise, but for user purposes */
 355 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
 356 #define VM_FAULT_HOLD 4                 /* Hold the page */
 357 #define VM_FAULT_DIRTY 8                /* Dirty the page */
 358
 359 #ifdef _KERNEL
 360 boolean_t vm_map_check_protection __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t));
 361 struct pmap;
 362 vm_map_t vm_map_create __P((struct pmap *, vm_offset_t, vm_offset_t));
 363 int vm_map_delete __P((vm_map_t, vm_offset_t, vm_offset_t));
 364 int 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));
 365 int vm_map_findspace __P((vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *));
 366 int vm_map_inherit __P((vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t));
 367 void vm_map_init __P((struct vm_map *, vm_offset_t, vm_offset_t));
 368 int 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));
 369 int vm_map_lookup __P((vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
 370     vm_pindex_t *, vm_prot_t *, boolean_t *));
 371 void vm_map_lookup_done __P((vm_map_t, vm_map_entry_t));
 372 boolean_t vm_map_lookup_entry __P((vm_map_t, vm_offset_t, vm_map_entry_t *));
 373 int vm_map_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t));
 374 int vm_map_user_pageable __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t));
 375 int vm_map_clean __P((vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t));
 376 int vm_map_protect __P((vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t));
 377 int vm_map_remove __P((vm_map_t, vm_offset_t, vm_offset_t));
 378 void vm_map_startup __P((void));
 379 int vm_map_submap __P((vm_map_t, vm_offset_t, vm_offset_t, vm_map_t));
 380 int vm_map_madvise __P((vm_map_t, vm_offset_t, vm_offset_t, int));
 381 void vm_map_simplify_entry __P((vm_map_t, vm_map_entry_t));
 382 void vm_init2 __P((void));
 383 int vm_uiomove __P((vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *));
 384 void vm_freeze_copyopts __P((vm_object_t, vm_pindex_t, vm_pindex_t));
 385 int vm_map_stack __P((vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int));
 386 int vm_map_growstack __P((struct proc *p, vm_offset_t addr));
 387 int vmspace_swap_count __P((struct vmspace *vmspace));
 388
 389 #endif
 390 #endif                          /* _VM_MAP_ */