sys/vm/vm_map.h

   1 /*-
   2  * SPDX-License-Identifier: (BSD-3-Clause AND MIT-CMU)
   3  *
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * The Mach Operating System project at Carnegie-Mellon University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)vm_map.h    8.9 (Berkeley) 5/17/95
  35  *
  36  *
  37  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
  38  * All rights reserved.
  39  *
  40  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
  41  *
  42  * Permission to use, copy, modify and distribute this software and
  43  * its documentation is hereby granted, provided that both the copyright
  44  * notice and this permission notice appear in all copies of the
  45  * software, derivative works or modified versions, and any portions
  46  * thereof, and that both notices appear in supporting documentation.
  47  *
  48  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  49  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
  50  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  51  *
  52  * Carnegie Mellon requests users of this software to return to
  53  *
  54  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  55  *  School of Computer Science
  56  *  Carnegie Mellon University
  57  *  Pittsburgh PA 15213-3890
  58  *
  59  * any improvements or extensions that they make and grant Carnegie the
  60  * rights to redistribute these changes.
  61  *
  62  * $FreeBSD$
  63  */
  64
  65 /*
  66  *      Virtual memory map module definitions.
  67  */
  68 #ifndef _VM_MAP_
  69 #define _VM_MAP_
  70
  71 #include <sys/lock.h>
  72 #include <sys/sx.h>
  73 #include <sys/_mutex.h>
  74
  75 /*
  76  *      Types defined:
  77  *
  78  *      vm_map_t                the high-level address map data structure.
  79  *      vm_map_entry_t          an entry in an address map.
  80  */
  81
  82 typedef u_char vm_flags_t;
  83 typedef u_int vm_eflags_t;
  84
  85 /*
  86  *      Objects which live in maps may be either VM objects, or
  87  *      another map (called a "sharing map") which denotes read-write
  88  *      sharing with other maps.
  89  */
  90 union vm_map_object {
  91         struct vm_object *vm_object;    /* object object */
  92         struct vm_map *sub_map;         /* belongs to another map */
  93 };
  94
  95 /*
  96  *      Address map entries consist of start and end addresses,
  97  *      a VM object (or sharing map) and offset into that object,
  98  *      and user-exported inheritance and protection information.
  99  *      Also included is control information for virtual copy operations.
 100  */
 101 struct vm_map_entry {
 102         struct vm_map_entry *left;      /* left child or previous entry */
 103         struct vm_map_entry *right;     /* right child or next entry */
 104         vm_offset_t start;              /* start address */
 105         vm_offset_t end;                /* end address */
 106         vm_offset_t next_read;          /* vaddr of the next sequential read */
 107         vm_size_t max_free;             /* max free space in subtree */
 108         union vm_map_object object;     /* object I point to */
 109         vm_ooffset_t offset;            /* offset into object */
 110         vm_eflags_t eflags;             /* map entry flags */
 111         vm_prot_t protection;           /* protection code */
 112         vm_prot_t max_protection;       /* maximum protection */
 113         vm_inherit_t inheritance;       /* inheritance */
 114         uint8_t read_ahead;             /* pages in the read-ahead window */
 115         int wired_count;                /* can be paged if = 0 */
 116         struct ucred *cred;             /* tmp storage for creator ref */
 117         struct thread *wiring_thread;
 118 };
 119
 120 #define MAP_ENTRY_NOSYNC                0x00000001
 121 #define MAP_ENTRY_IS_SUB_MAP            0x00000002
 122 #define MAP_ENTRY_COW                   0x00000004
 123 #define MAP_ENTRY_NEEDS_COPY            0x00000008
 124 #define MAP_ENTRY_NOFAULT               0x00000010
 125 #define MAP_ENTRY_USER_WIRED            0x00000020
 126
 127 #define MAP_ENTRY_BEHAV_NORMAL          0x00000000      /* default behavior */
 128 #define MAP_ENTRY_BEHAV_SEQUENTIAL      0x00000040      /* expect sequential
 129                                                            access */
 130 #define MAP_ENTRY_BEHAV_RANDOM          0x00000080      /* expect random
 131                                                            access */
 132 #define MAP_ENTRY_BEHAV_RESERVED        0x000000c0      /* future use */
 133 #define MAP_ENTRY_BEHAV_MASK            0x000000c0
 134 #define MAP_ENTRY_IN_TRANSITION         0x00000100      /* entry being
 135                                                            changed */
 136 #define MAP_ENTRY_NEEDS_WAKEUP          0x00000200      /* waiters in
 137                                                            transition */
 138 #define MAP_ENTRY_NOCOREDUMP            0x00000400      /* don't include in
 139                                                            a core */
 140 #define MAP_ENTRY_VN_EXEC               0x00000800      /* text vnode mapping */
 141 #define MAP_ENTRY_GROWS_DOWN            0x00001000      /* top-down stacks */
 142 #define MAP_ENTRY_GROWS_UP              0x00002000      /* bottom-up stacks */
 143
 144 #define MAP_ENTRY_WIRE_SKIPPED          0x00004000
 145 #define MAP_ENTRY_WRITECNT              0x00008000      /* tracked writeable
 146                                                            mapping */
 147 #define MAP_ENTRY_GUARD                 0x00010000
 148 #define MAP_ENTRY_STACK_GAP_DN          0x00020000
 149 #define MAP_ENTRY_STACK_GAP_UP          0x00040000
 150 #define MAP_ENTRY_HEADER                0x00080000
 151
 152 #define MAP_ENTRY_SPLIT_BOUNDARY_MASK   0x00300000
 153
 154 #define MAP_ENTRY_SPLIT_BOUNDARY_SHIFT  20
 155
 156 #ifdef  _KERNEL
 157 static __inline u_char
 158 vm_map_entry_behavior(vm_map_entry_t entry)
 159 {
 160         return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
 161 }
 162
 163 static __inline int
 164 vm_map_entry_user_wired_count(vm_map_entry_t entry)
 165 {
 166         if (entry->eflags & MAP_ENTRY_USER_WIRED)
 167                 return (1);
 168         return (0);
 169 }
 170
 171 static __inline int
 172 vm_map_entry_system_wired_count(vm_map_entry_t entry)
 173 {
 174         return (entry->wired_count - vm_map_entry_user_wired_count(entry));
 175 }
 176 #endif  /* _KERNEL */
 177
 178 /*
 179  *      A map is a set of map entries.  These map entries are
 180  *      organized as a threaded binary search tree.  Both structures
 181  *      are ordered based upon the start and end addresses contained
 182  *      within each map entry.  The largest gap between an entry in a
 183  *      subtree and one of its neighbors is saved in the max_free
 184  *      field, and that field is updated when the tree is
 185  *      restructured.
 186  *
 187  *      Sleator and Tarjan's top-down splay algorithm is employed to
 188  *      control height imbalance in the binary search tree.
 189  *
 190  *      The map's min offset value is stored in map->header.end, and
 191  *      its max offset value is stored in map->header.start.  These
 192  *      values act as sentinels for any forward or backward address
 193  *      scan of the list.  The right and left fields of the map
 194  *      header point to the first and list map entries.  The map
 195  *      header has a special value for the eflags field,
 196  *      MAP_ENTRY_HEADER, that is set initially, is never changed,
 197  *      and prevents an eflags match of the header with any other map
 198  *      entry.
 199  *
 200  *      List of locks
 201  *      (c)     const until freed
 202  */
 203 struct vm_map {
 204         struct vm_map_entry header;     /* List of entries */
 205         struct sx lock;                 /* Lock for map data */
 206         struct mtx system_mtx;
 207         int nentries;                   /* Number of entries */
 208         vm_size_t size;                 /* virtual size */
 209         u_int timestamp;                /* Version number */
 210         u_char needs_wakeup;
 211         u_char system_map;              /* (c) Am I a system map? */
 212         vm_flags_t flags;               /* flags for this vm_map */
 213         vm_map_entry_t root;            /* Root of a binary search tree */
 214         pmap_t pmap;                    /* (c) Physical map */
 215         vm_offset_t anon_loc;
 216         int busy;
 217 #ifdef DIAGNOSTIC
 218         int nupdates;
 219 #endif
 220 };
 221
 222 /*
 223  * vm_flags_t values
 224  */
 225 #define MAP_WIREFUTURE          0x01    /* wire all future pages */
 226 #define MAP_BUSY_WAKEUP         0x02    /* thread(s) waiting on busy state */
 227 #define MAP_IS_SUB_MAP          0x04    /* has parent */
 228 #define MAP_ASLR                0x08    /* enabled ASLR */
 229 #define MAP_ASLR_IGNSTART       0x10    /* ASLR ignores data segment */
 230 #define MAP_REPLENISH           0x20    /* kmapent zone needs to be refilled */
 231 #define MAP_WXORX               0x40    /* enforce W^X */
 232 #define MAP_ASLR_STACK          0x80    /* stack location is randomized */
 233
 234 #ifdef  _KERNEL
 235 #if defined(KLD_MODULE) && !defined(KLD_TIED)
 236 #define vm_map_max(map)         vm_map_max_KBI((map))
 237 #define vm_map_min(map)         vm_map_min_KBI((map))
 238 #define vm_map_pmap(map)        vm_map_pmap_KBI((map))
 239 #define vm_map_range_valid(map, start, end)     \
 240         vm_map_range_valid_KBI((map), (start), (end))
 241 #else
 242 static __inline vm_offset_t
 243 vm_map_max(const struct vm_map *map)
 244 {
 245
 246         return (map->header.start);
 247 }
 248
 249 static __inline vm_offset_t
 250 vm_map_min(const struct vm_map *map)
 251 {
 252
 253         return (map->header.end);
 254 }
 255
 256 static __inline pmap_t
 257 vm_map_pmap(vm_map_t map)
 258 {
 259         return (map->pmap);
 260 }
 261
 262 static __inline void
 263 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
 264 {
 265         map->flags = (map->flags | set) & ~clear;
 266 }
 267
 268 static inline bool
 269 vm_map_range_valid(vm_map_t map, vm_offset_t start, vm_offset_t end)
 270 {
 271         if (end < start)
 272                 return (false);
 273         if (start < vm_map_min(map) || end > vm_map_max(map))
 274                 return (false);
 275         return (true);
 276 }
 277
 278 #endif  /* KLD_MODULE */
 279 #endif  /* _KERNEL */
 280
 281 /*
 282  * Shareable process virtual address space.
 283  *
 284  * List of locks
 285  *      (c)     const until freed
 286  */
 287 struct vmspace {
 288         struct vm_map vm_map;   /* VM address map */
 289         struct shmmap_state *vm_shm;    /* SYS5 shared memory private data XXX */
 290         segsz_t vm_swrss;       /* resident set size before last swap */
 291         segsz_t vm_tsize;       /* text size (pages) XXX */
 292         segsz_t vm_dsize;       /* data size (pages) XXX */
 293         segsz_t vm_ssize;       /* stack size (pages) */
 294         caddr_t vm_taddr;       /* (c) user virtual address of text */
 295         caddr_t vm_daddr;       /* (c) user virtual address of data */
 296         caddr_t vm_maxsaddr;    /* user VA at max stack growth */
 297         vm_offset_t vm_stacktop; /* top of the stack, may not be page-aligned */
 298         u_int vm_refcnt;        /* number of references */
 299         /*
 300          * Keep the PMAP last, so that CPU-specific variations of that
 301          * structure on a single architecture don't result in offset
 302          * variations of the machine-independent fields in the vmspace.
 303          */
 304         struct pmap vm_pmap;    /* private physical map */
 305 };
 306
 307 #ifdef  _KERNEL
 308 static __inline pmap_t
 309 vmspace_pmap(struct vmspace *vmspace)
 310 {
 311         return &vmspace->vm_pmap;
 312 }
 313 #endif  /* _KERNEL */
 314
 315 #ifdef  _KERNEL
 316 /*
 317  *      Macros:         vm_map_lock, etc.
 318  *      Function:
 319  *              Perform locking on the data portion of a map.  Note that
 320  *              these macros mimic procedure calls returning void.  The
 321  *              semicolon is supplied by the user of these macros, not
 322  *              by the macros themselves.  The macros can safely be used
 323  *              as unbraced elements in a higher level statement.
 324  */
 325
 326 void _vm_map_lock(vm_map_t map, const char *file, int line);
 327 void _vm_map_unlock(vm_map_t map, const char *file, int line);
 328 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line);
 329 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
 330 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
 331 int _vm_map_trylock(vm_map_t map, const char *file, int line);
 332 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
 333 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
 334 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
 335 int vm_map_locked(vm_map_t map);
 336 void vm_map_wakeup(vm_map_t map);
 337 void vm_map_busy(vm_map_t map);
 338 void vm_map_unbusy(vm_map_t map);
 339 void vm_map_wait_busy(vm_map_t map);
 340 vm_offset_t vm_map_max_KBI(const struct vm_map *map);
 341 vm_offset_t vm_map_min_KBI(const struct vm_map *map);
 342 pmap_t vm_map_pmap_KBI(vm_map_t map);
 343 bool vm_map_range_valid_KBI(vm_map_t map, vm_offset_t start, vm_offset_t end);
 344
 345 #define vm_map_lock(map)        _vm_map_lock(map, LOCK_FILE, LOCK_LINE)
 346 #define vm_map_unlock(map)      _vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
 347 #define vm_map_unlock_and_wait(map, timo)       \
 348                         _vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE)
 349 #define vm_map_lock_read(map)   _vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
 350 #define vm_map_unlock_read(map) _vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
 351 #define vm_map_trylock(map)     _vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
 352 #define vm_map_trylock_read(map)        \
 353                         _vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
 354 #define vm_map_lock_upgrade(map)        \
 355                         _vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
 356 #define vm_map_lock_downgrade(map)      \
 357                         _vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
 358
 359 long vmspace_resident_count(struct vmspace *vmspace);
 360 #endif  /* _KERNEL */
 361
 362 /*
 363  * Copy-on-write flags for vm_map operations
 364  */
 365 #define MAP_INHERIT_SHARE       0x00000001
 366 #define MAP_COPY_ON_WRITE       0x00000002
 367 #define MAP_NOFAULT             0x00000004
 368 #define MAP_PREFAULT            0x00000008
 369 #define MAP_PREFAULT_PARTIAL    0x00000010
 370 #define MAP_DISABLE_SYNCER      0x00000020
 371 #define MAP_CHECK_EXCL          0x00000040
 372 #define MAP_CREATE_GUARD        0x00000080
 373 #define MAP_DISABLE_COREDUMP    0x00000100
 374 #define MAP_PREFAULT_MADVISE    0x00000200    /* from (user) madvise request */
 375 #define MAP_WRITECOUNT          0x00000400
 376 #define MAP_REMAP               0x00000800
 377 #define MAP_STACK_GROWS_DOWN    0x00001000
 378 #define MAP_STACK_GROWS_UP      0x00002000
 379 #define MAP_ACC_CHARGED         0x00004000
 380 #define MAP_ACC_NO_CHARGE       0x00008000
 381 #define MAP_CREATE_STACK_GAP_UP 0x00010000
 382 #define MAP_CREATE_STACK_GAP_DN 0x00020000
 383 #define MAP_VN_EXEC             0x00040000
 384 #define MAP_SPLIT_BOUNDARY_MASK 0x00180000
 385
 386 #define MAP_SPLIT_BOUNDARY_SHIFT 19
 387
 388 /*
 389  * vm_fault option flags
 390  */
 391 #define VM_FAULT_NORMAL 0x00    /* Nothing special */
 392 #define VM_FAULT_WIRE   0x01    /* Wire the mapped page */
 393 #define VM_FAULT_DIRTY  0x02    /* Dirty the page; use w/VM_PROT_COPY */
 394 #define VM_FAULT_NOFILL 0x04    /* Fail if the pager doesn't have a copy */
 395
 396 /*
 397  * Initially, mappings are slightly sequential.  The maximum window size must
 398  * account for the map entry's "read_ahead" field being defined as an uint8_t.
 399  */
 400 #define VM_FAULT_READ_AHEAD_MIN         7
 401 #define VM_FAULT_READ_AHEAD_INIT        15
 402 #define VM_FAULT_READ_AHEAD_MAX         min(atop(maxphys) - 1, UINT8_MAX)
 403
 404 /*
 405  * The following "find_space" options are supported by vm_map_find().
 406  *
 407  * For VMFS_ALIGNED_SPACE, the desired alignment is specified to
 408  * the macro argument as log base 2 of the desired alignment.
 409  */
 410 #define VMFS_NO_SPACE           0       /* don't find; use the given range */
 411 #define VMFS_ANY_SPACE          1       /* find a range with any alignment */
 412 #define VMFS_OPTIMAL_SPACE      2       /* find a range with optimal alignment*/
 413 #define VMFS_SUPER_SPACE        3       /* find a superpage-aligned range */
 414 #define VMFS_ALIGNED_SPACE(x)   ((x) << 8) /* find a range with fixed alignment */
 415
 416 /*
 417  * vm_map_wire and vm_map_unwire option flags
 418  */
 419 #define VM_MAP_WIRE_SYSTEM      0       /* wiring in a kernel map */
 420 #define VM_MAP_WIRE_USER        1       /* wiring in a user map */
 421
 422 #define VM_MAP_WIRE_NOHOLES     0       /* region must not have holes */
 423 #define VM_MAP_WIRE_HOLESOK     2       /* region may have holes */
 424
 425 #define VM_MAP_WIRE_WRITE       4       /* Validate writable. */
 426
 427 typedef int vm_map_entry_reader(void *token, vm_map_entry_t addr,
 428     vm_map_entry_t dest);
 429
 430 #ifndef _KERNEL
 431 /*
 432  * Find the successor of a map_entry, using a reader to dereference pointers.
 433  * '*clone' is a copy of a vm_map entry.  'reader' is used to copy a map entry
 434  * at some address into '*clone'.  Change *clone to a copy of the next map
 435  * entry, and return the address of that entry, or NULL if copying has failed.
 436  *
 437  * This function is made available to user-space code that needs to traverse
 438  * map entries.
 439  */
 440 static inline vm_map_entry_t
 441 vm_map_entry_read_succ(void *token, struct vm_map_entry *const clone,
 442     vm_map_entry_reader reader)
 443 {
 444         vm_map_entry_t after, backup;
 445         vm_offset_t start;
 446
 447         after = clone->right;
 448         start = clone->start;
 449         if (!reader(token, after, clone))
 450                 return (NULL);
 451         backup = clone->left;
 452         if (!reader(token, backup, clone))
 453                 return (NULL);
 454         if (clone->start > start) {
 455                 do {
 456                         after = backup;
 457                         backup = clone->left;
 458                         if (!reader(token, backup, clone))
 459                                 return (NULL);
 460                 } while (clone->start != start);
 461         }
 462         if (!reader(token, after, clone))
 463                 return (NULL);
 464         return (after);
 465 }
 466 #endif                          /* ! _KERNEL */
 467
 468 #ifdef _KERNEL
 469 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
 470 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t);
 471 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t,
 472     vm_offset_t, int, vm_prot_t, vm_prot_t, int);
 473 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
 474     vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
 475 int vm_map_find_aligned(vm_map_t map, vm_offset_t *addr, vm_size_t length,
 476     vm_offset_t max_addr, vm_offset_t alignment);
 477 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t,
 478     vm_prot_t, vm_prot_t, int);
 479 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t);
 480 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
 481 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t);
 482 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);
 483 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
 484     vm_pindex_t *, vm_prot_t *, boolean_t *);
 485 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
 486     vm_pindex_t *, vm_prot_t *, boolean_t *);
 487 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
 488 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
 489
 490 static inline vm_map_entry_t
 491 vm_map_entry_first(vm_map_t map)
 492 {
 493
 494         return (map->header.right);
 495 }
 496
 497 static inline vm_map_entry_t
 498 vm_map_entry_succ(vm_map_entry_t entry)
 499 {
 500         vm_map_entry_t after;
 501
 502         after = entry->right;
 503         if (after->left->start > entry->start) {
 504                 do
 505                         after = after->left;
 506                 while (after->left != entry);
 507         }
 508         return (after);
 509 }
 510
 511 #define VM_MAP_ENTRY_FOREACH(it, map)           \
 512         for ((it) = vm_map_entry_first(map);    \
 513             (it) != &(map)->header;             \
 514             (it) = vm_map_entry_succ(it))
 515
 516 #define VM_MAP_PROTECT_SET_PROT         0x0001
 517 #define VM_MAP_PROTECT_SET_MAXPROT      0x0002
 518
 519 int vm_map_protect(vm_map_t map, vm_offset_t start, vm_offset_t end,
 520     vm_prot_t new_prot, vm_prot_t new_maxprot, int flags);
 521 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
 522 void vm_map_try_merge_entries(vm_map_t map, vm_map_entry_t prev,
 523     vm_map_entry_t entry);
 524 void vm_map_startup (void);
 525 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
 526 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
 527 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
 528 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
 529 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
 530     int flags);
 531 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, int flags);
 532 int vm_map_wire_locked(vm_map_t map, vm_offset_t start, vm_offset_t end,
 533     int flags);
 534 long vmspace_swap_count(struct vmspace *vmspace);
 535 void vm_map_entry_set_vnode_text(vm_map_entry_t entry, bool add);
 536 #endif                          /* _KERNEL */
 537 #endif                          /* _VM_MAP_ */