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 #ifndef _VM_MAP_
  71 #define _VM_MAP_
  72
  73 #include <sys/lockmgr.h>
  74
  75 #ifdef MAP_LOCK_DIAGNOSTIC
  76 #include <sys/systm.h>
  77 #define vm_map_printf(str, arg) printf(str,arg)
  78 #else
  79 #define vm_map_printf(str, arg)
  80 #endif
  81
  82 /*
  83  *      Types defined:
  84  *
  85  *      vm_map_t                the high-level address map data structure.
  86  *      vm_map_entry_t          an entry in an address map.
  87  */
  88
  89 typedef u_int vm_eflags_t;
  90
  91 /*
  92  *      Objects which live in maps may be either VM objects, or
  93  *      another map (called a "sharing map") which denotes read-write
  94  *      sharing with other maps.
  95  */
  96 union vm_map_object {
  97         struct vm_object *vm_object;    /* object object */
  98         struct vm_map *sub_map;         /* belongs to another map */
  99 };
 100
 101 /*
 102  *      Address map entries consist of start and end addresses,
 103  *      a VM object (or sharing map) and offset into that object,
 104  *      and user-exported inheritance and protection information.
 105  *      Also included is control information for virtual copy operations.
 106  */
 107 struct vm_map_entry {
 108         struct vm_map_entry *prev;      /* previous entry */
 109         struct vm_map_entry *next;      /* next entry */
 110         vm_offset_t start;              /* start address */
 111         vm_offset_t end;                /* end address */
 112         vm_offset_t avail_ssize;        /* amt can grow if this is a stack */
 113         union vm_map_object object;     /* object I point to */
 114         vm_ooffset_t offset;            /* offset into object */
 115         vm_eflags_t eflags;             /* map entry flags */
 116         /* Only in task maps: */
 117         vm_prot_t protection;           /* protection code */
 118         vm_prot_t max_protection;       /* maximum protection */
 119         vm_inherit_t inheritance;       /* inheritance */
 120         int wired_count;                /* can be paged if = 0 */
 121         vm_pindex_t lastr;              /* last read */
 122 };
 123
 124 #define MAP_ENTRY_NOSYNC                0x0001
 125 #define MAP_ENTRY_IS_SUB_MAP            0x0002
 126 #define MAP_ENTRY_COW                   0x0004
 127 #define MAP_ENTRY_NEEDS_COPY            0x0008
 128 #define MAP_ENTRY_NOFAULT               0x0010
 129 #define MAP_ENTRY_USER_WIRED            0x0020
 130
 131 #define MAP_ENTRY_BEHAV_NORMAL          0x0000  /* default behavior */
 132 #define MAP_ENTRY_BEHAV_SEQUENTIAL      0x0040  /* expect sequential access */
 133 #define MAP_ENTRY_BEHAV_RANDOM          0x0080  /* expect random access */
 134 #define MAP_ENTRY_BEHAV_RESERVED        0x00C0  /* future use */
 135
 136 #define MAP_ENTRY_BEHAV_MASK            0x00C0
 137
 138 #define MAP_ENTRY_NOCOREDUMP            0x0400  /* don't include in a core */
 139
 140 /*
 141  *      Maps are doubly-linked lists of map entries, kept sorted
 142  *      by address.  A single hint is provided to start
 143  *      searches again from the last successful search,
 144  *      insertion, or removal.
 145  *
 146  *      Note: the lock structure cannot be the first element of vm_map
 147  *      because this can result in a running lockup between two or more
 148  *      system processes trying to kmem_alloc_wait() due to kmem_alloc_wait()
 149  *      and free tsleep/waking up 'map' and the underlying lockmgr also
 150  *      sleeping and waking up on 'map'.  The lockup occurs when the map fills
 151  *      up.  The 'exec' map, for example.
 152  */
 153 struct vm_map {
 154         struct vm_map_entry header;     /* List of entries */
 155         struct lock lock;               /* Lock for map data */
 156         int nentries;                   /* Number of entries */
 157         vm_size_t size;                 /* virtual size */
 158         u_char system_map;              /* Am I a system map? */
 159         u_char infork;                  /* Am I in fork processing? */
 160         vm_map_entry_t hint;            /* hint for quick lookups */
 161         unsigned int timestamp;         /* Version number */
 162         vm_map_entry_t first_free;      /* First free space hint */
 163         struct pmap *pmap;              /* Physical map */
 164 #define min_offset              header.start
 165 #define max_offset              header.end
 166 };
 167
 168 /*
 169  * Shareable process virtual address space.
 170  * May eventually be merged with vm_map.
 171  * Several fields are temporary (text, data stuff).
 172  */
 173 struct vmspace {
 174         struct vm_map vm_map;   /* VM address map */
 175         struct pmap vm_pmap;    /* private physical map */
 176         int vm_refcnt;          /* number of references */
 177         caddr_t vm_shm;         /* SYS5 shared memory private data XXX */
 178 /* we copy from vm_startcopy to the end of the structure on fork */
 179 #define vm_startcopy vm_rssize
 180         segsz_t vm_rssize;      /* current resident set size in pages */
 181         segsz_t vm_swrss;       /* resident set size before last swap */
 182         segsz_t vm_tsize;       /* text size (pages) XXX */
 183         segsz_t vm_dsize;       /* data size (pages) XXX */
 184         segsz_t vm_ssize;       /* stack size (pages) */
 185         caddr_t vm_taddr;       /* user virtual address of text XXX */
 186         caddr_t vm_daddr;       /* user virtual address of data XXX */
 187         caddr_t vm_maxsaddr;    /* user VA at max stack growth */
 188         caddr_t vm_minsaddr;    /* user VA at max stack growth */
 189 #define vm_endcopy vm_freer
 190         struct proc *vm_freer;  /* vm freed on whose behalf */
 191 };
 192
 193 #ifdef  _KERNEL
 194 u_char vm_map_entry_behavior(struct vm_map_entry *entry);
 195 void vm_map_entry_set_behavior(struct vm_map_entry *entry, u_char behavior);
 196
 197 /*
 198  *      Macros:         vm_map_lock, etc.
 199  *      Function:
 200  *              Perform locking on the data portion of a map.  Note that
 201  *              these macros mimic procedure calls returning void.  The
 202  *              semicolon is supplied by the user of these macros, not
 203  *              by the macros themselves.  The macros can safely be used
 204  *              as unbraced elements in a higher level statement.
 205  */
 206
 207 #if 0
 208 /* XXX This macro is not called anywhere, and (map)->ref_lock doesn't exist. */
 209 #define vm_map_lock_drain_interlock(map) \
 210         do { \
 211                 lockmgr(&(map)->lock, LK_DRAIN|LK_INTERLOCK, \
 212                         &(map)->ref_lock, curthread); \
 213                 (map)->timestamp++; \
 214         } while (0)
 215 #endif
 216
 217 void vm_map_lock(vm_map_t map);
 218 void vm_map_unlock(vm_map_t map);
 219 void vm_map_lock_read(vm_map_t map);
 220 void vm_map_unlock_read(vm_map_t map);
 221 int vm_map_lock_upgrade(vm_map_t map);
 222 void vm_map_lock_downgrade(vm_map_t map);
 223 void vm_map_set_recursive(vm_map_t map);
 224 void vm_map_clear_recursive(vm_map_t map);
 225 vm_offset_t vm_map_min(vm_map_t map);
 226 vm_offset_t vm_map_max(vm_map_t map);
 227 struct pmap *vm_map_pmap(vm_map_t map);
 228
 229 struct pmap *vmspace_pmap(struct vmspace *vmspace);
 230 long vmspace_resident_count(struct vmspace *vmspace);
 231 #endif  /* _KERNEL */
 232
 233
 234 /* XXX: number of kernel maps and entries to statically allocate */
 235 #define MAX_KMAP        10
 236 #define MAX_KMAPENT     128
 237 #define MAX_MAPENT      128
 238
 239 /*
 240  * Copy-on-write flags for vm_map operations
 241  */
 242 #define MAP_UNUSED_01           0x0001
 243 #define MAP_COPY_ON_WRITE       0x0002
 244 #define MAP_NOFAULT             0x0004
 245 #define MAP_PREFAULT            0x0008
 246 #define MAP_PREFAULT_PARTIAL    0x0010
 247 #define MAP_DISABLE_SYNCER      0x0020
 248 #define MAP_DISABLE_COREDUMP    0x0100
 249 #define MAP_PREFAULT_MADVISE    0x0200  /* from (user) madvise request */
 250
 251 /*
 252  * vm_fault option flags
 253  */
 254 #define VM_FAULT_NORMAL 0               /* Nothing special */
 255 #define VM_FAULT_CHANGE_WIRING 1        /* Change the wiring as appropriate */
 256 #define VM_FAULT_USER_WIRE 2            /* Likewise, but for user purposes */
 257 #define VM_FAULT_WIRE_MASK (VM_FAULT_CHANGE_WIRING|VM_FAULT_USER_WIRE)
 258 #define VM_FAULT_HOLD 4                 /* Hold the page */
 259 #define VM_FAULT_DIRTY 8                /* Dirty the page */
 260
 261 #ifdef _KERNEL
 262 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
 263 struct pmap;
 264 vm_map_t vm_map_create (struct pmap *, vm_offset_t, vm_offset_t);
 265 int vm_map_delete (vm_map_t, vm_offset_t, vm_offset_t);
 266 int vm_map_find (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t, boolean_t, vm_prot_t, vm_prot_t, int);
 267 int vm_map_findspace (vm_map_t, vm_offset_t, vm_size_t, vm_offset_t *);
 268 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
 269 void vm_map_init (struct vm_map *, vm_offset_t, vm_offset_t);
 270 int vm_map_insert (vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_offset_t, vm_prot_t, vm_prot_t, int);
 271 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
 272     vm_pindex_t *, vm_prot_t *, boolean_t *);
 273 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
 274 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
 275 int vm_map_pageable (vm_map_t, vm_offset_t, vm_offset_t, boolean_t);
 276 int vm_map_user_pageable (vm_map_t, vm_offset_t, vm_offset_t, boolean_t);
 277 int vm_map_clean (vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
 278 int vm_map_protect (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t, boolean_t);
 279 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
 280 void vm_map_startup (void);
 281 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
 282 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
 283 void vm_map_simplify_entry (vm_map_t, vm_map_entry_t);
 284 void vm_init2 (void);
 285 int vm_uiomove (vm_map_t, vm_object_t, off_t, int, vm_offset_t, int *);
 286 void vm_freeze_copyopts (vm_object_t, vm_pindex_t, vm_pindex_t);
 287 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
 288 int vm_map_growstack (struct proc *p, vm_offset_t addr);
 289 int vmspace_swap_count (struct vmspace *vmspace);
 290
 291 #endif                          /* _KERNEL */
 292 #endif                          /* _VM_MAP_ */