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