xref: /freebsd/sys/vm/vm_map.h (revision aa7957345732816fb0ba8308798d2f79f45597f9)
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  *	For stack gap map entries (MAP_ENTRY_GUARD | MAP_ENTRY_GROWS_DOWN
102  *	or UP), the next_read member is reused as the stack_guard_page
103  *	storage, and offset is the stack protection.
104  */
105 struct vm_map_entry {
106 	struct vm_map_entry *left;	/* left child or previous entry */
107 	struct vm_map_entry *right;	/* right child or next entry */
108 	vm_offset_t start;		/* start address */
109 	vm_offset_t end;		/* end address */
110 	vm_offset_t next_read;		/* vaddr of the next sequential read */
111 	vm_size_t max_free;		/* max free space in subtree */
112 	union vm_map_object object;	/* object I point to */
113 	vm_ooffset_t offset;		/* offset into object */
114 	vm_eflags_t eflags;		/* map entry flags */
115 	vm_prot_t protection;		/* protection code */
116 	vm_prot_t max_protection;	/* maximum protection */
117 	vm_inherit_t inheritance;	/* inheritance */
118 	uint8_t read_ahead;		/* pages in the read-ahead window */
119 	int wired_count;		/* can be paged if = 0 */
120 	struct ucred *cred;		/* tmp storage for creator ref */
121 	struct thread *wiring_thread;
122 };
123 
124 #define	MAP_ENTRY_NOSYNC		0x00000001
125 #define	MAP_ENTRY_IS_SUB_MAP		0x00000002
126 #define	MAP_ENTRY_COW			0x00000004
127 #define	MAP_ENTRY_NEEDS_COPY		0x00000008
128 #define	MAP_ENTRY_NOFAULT		0x00000010
129 #define	MAP_ENTRY_USER_WIRED		0x00000020
130 
131 #define	MAP_ENTRY_BEHAV_NORMAL		0x00000000	/* default behavior */
132 #define	MAP_ENTRY_BEHAV_SEQUENTIAL	0x00000040	/* expect sequential
133 							   access */
134 #define	MAP_ENTRY_BEHAV_RANDOM		0x00000080	/* expect random
135 							   access */
136 #define	MAP_ENTRY_BEHAV_RESERVED	0x000000c0	/* future use */
137 #define	MAP_ENTRY_BEHAV_MASK		0x000000c0
138 #define	MAP_ENTRY_IN_TRANSITION		0x00000100	/* entry being
139 							   changed */
140 #define	MAP_ENTRY_NEEDS_WAKEUP		0x00000200	/* waiters in
141 							   transition */
142 #define	MAP_ENTRY_NOCOREDUMP		0x00000400	/* don't include in
143 							   a core */
144 #define	MAP_ENTRY_VN_EXEC		0x00000800	/* text vnode mapping */
145 #define	MAP_ENTRY_GROWS_DOWN		0x00001000	/* top-down stacks */
146 #define	MAP_ENTRY_GROWS_UP		0x00002000	/* bottom-up stacks */
147 
148 #define	MAP_ENTRY_WIRE_SKIPPED		0x00004000
149 #define	MAP_ENTRY_WRITECNT		0x00008000	/* tracked writeable
150 							   mapping */
151 #define	MAP_ENTRY_GUARD			0x00010000
152 #define	MAP_ENTRY_STACK_GAP_DN		0x00020000
153 #define	MAP_ENTRY_STACK_GAP_UP		0x00040000
154 #define	MAP_ENTRY_HEADER		0x00080000
155 
156 #define	MAP_ENTRY_SPLIT_BOUNDARY_MASK	0x00300000
157 #define	MAP_ENTRY_SPLIT_BOUNDARY_SHIFT	20
158 #define	MAP_ENTRY_SPLIT_BOUNDARY_INDEX(entry)			\
159 	(((entry)->eflags & MAP_ENTRY_SPLIT_BOUNDARY_MASK) >>	\
160 	    MAP_ENTRY_SPLIT_BOUNDARY_SHIFT)
161 
162 #ifdef	_KERNEL
163 static __inline u_char
164 vm_map_entry_behavior(vm_map_entry_t entry)
165 {
166 	return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
167 }
168 
169 static __inline int
170 vm_map_entry_user_wired_count(vm_map_entry_t entry)
171 {
172 	if (entry->eflags & MAP_ENTRY_USER_WIRED)
173 		return (1);
174 	return (0);
175 }
176 
177 static __inline int
178 vm_map_entry_system_wired_count(vm_map_entry_t entry)
179 {
180 	return (entry->wired_count - vm_map_entry_user_wired_count(entry));
181 }
182 #endif	/* _KERNEL */
183 
184 /*
185  *	A map is a set of map entries.  These map entries are
186  *	organized as a threaded binary search tree.  The tree is
187  *	ordered based upon the start and end addresses contained
188  *	within each map entry.  The largest gap between an entry in a
189  *	subtree and one of its neighbors is saved in the max_free
190  *	field, and that field is updated when the tree is restructured.
191  *
192  *	Sleator and Tarjan's top-down splay algorithm is employed to
193  *	control height imbalance in the binary search tree.
194  *
195  *	The map's min offset value is stored in map->header.end, and
196  *	its max offset value is stored in map->header.start.  These
197  *	values act as sentinels for any forward or backward address
198  *	scan of the list.  The right and left fields of the map
199  *	header point to the first and list map entries.  The map
200  *	header has a special value for the eflags field,
201  *	MAP_ENTRY_HEADER, that is set initially, is never changed,
202  *	and prevents an eflags match of the header with any other map
203  *	entry.
204  *
205  *	List of locks
206  *	(c)	const until freed
207  */
208 struct vm_map {
209 	struct vm_map_entry header;	/* List of entries */
210 	struct sx lock;			/* Lock for map data */
211 	struct mtx system_mtx;
212 	int nentries;			/* Number of entries */
213 	vm_size_t size;			/* virtual size */
214 	u_int timestamp;		/* Version number */
215 	u_char needs_wakeup;
216 	u_char system_map;		/* (c) Am I a system map? */
217 	vm_flags_t flags;		/* flags for this vm_map */
218 	vm_map_entry_t root;		/* Root of a binary search tree */
219 	pmap_t pmap;			/* (c) Physical map */
220 	vm_offset_t anon_loc;
221 	int busy;
222 #ifdef DIAGNOSTIC
223 	int nupdates;
224 #endif
225 };
226 
227 /*
228  * vm_flags_t values
229  */
230 #define MAP_WIREFUTURE		0x01	/* wire all future pages */
231 #define	MAP_BUSY_WAKEUP		0x02	/* thread(s) waiting on busy state */
232 #define	MAP_IS_SUB_MAP		0x04	/* has parent */
233 #define	MAP_ASLR		0x08	/* enabled ASLR */
234 #define	MAP_ASLR_IGNSTART	0x10	/* ASLR ignores data segment */
235 #define	MAP_REPLENISH		0x20	/* kmapent zone needs to be refilled */
236 #define	MAP_WXORX		0x40	/* enforce W^X */
237 #define	MAP_ASLR_STACK		0x80	/* stack location is randomized */
238 
239 #ifdef	_KERNEL
240 #if defined(KLD_MODULE) && !defined(KLD_TIED)
241 #define	vm_map_max(map)		vm_map_max_KBI((map))
242 #define	vm_map_min(map)		vm_map_min_KBI((map))
243 #define	vm_map_pmap(map)	vm_map_pmap_KBI((map))
244 #define	vm_map_range_valid(map, start, end)	\
245 	vm_map_range_valid_KBI((map), (start), (end))
246 #else
247 static __inline vm_offset_t
248 vm_map_max(const struct vm_map *map)
249 {
250 
251 	return (map->header.start);
252 }
253 
254 static __inline vm_offset_t
255 vm_map_min(const struct vm_map *map)
256 {
257 
258 	return (map->header.end);
259 }
260 
261 static __inline pmap_t
262 vm_map_pmap(vm_map_t map)
263 {
264 	return (map->pmap);
265 }
266 
267 static __inline void
268 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
269 {
270 	map->flags = (map->flags | set) & ~clear;
271 }
272 
273 static inline bool
274 vm_map_range_valid(vm_map_t map, vm_offset_t start, vm_offset_t end)
275 {
276 	if (end < start)
277 		return (false);
278 	if (start < vm_map_min(map) || end > vm_map_max(map))
279 		return (false);
280 	return (true);
281 }
282 
283 #endif	/* KLD_MODULE */
284 #endif	/* _KERNEL */
285 
286 /*
287  * Shareable process virtual address space.
288  *
289  * List of locks
290  *	(c)	const until freed
291  */
292 struct vmspace {
293 	struct vm_map vm_map;	/* VM address map */
294 	struct shmmap_state *vm_shm;	/* SYS5 shared memory private data XXX */
295 	segsz_t vm_swrss;	/* resident set size before last swap */
296 	segsz_t vm_tsize;	/* text size (pages) XXX */
297 	segsz_t vm_dsize;	/* data size (pages) XXX */
298 	segsz_t vm_ssize;	/* stack size (pages) */
299 	caddr_t vm_taddr;	/* (c) user virtual address of text */
300 	caddr_t vm_daddr;	/* (c) user virtual address of data */
301 	caddr_t vm_maxsaddr;	/* user VA at max stack growth */
302 	vm_offset_t vm_stacktop; /* top of the stack, may not be page-aligned */
303 	vm_offset_t vm_shp_base; /* shared page address */
304 	u_int vm_refcnt;	/* number of references */
305 	/*
306 	 * Keep the PMAP last, so that CPU-specific variations of that
307 	 * structure on a single architecture don't result in offset
308 	 * variations of the machine-independent fields in the vmspace.
309 	 */
310 	struct pmap vm_pmap;	/* private physical map */
311 };
312 
313 #ifdef	_KERNEL
314 static __inline pmap_t
315 vmspace_pmap(struct vmspace *vmspace)
316 {
317 	return &vmspace->vm_pmap;
318 }
319 #endif	/* _KERNEL */
320 
321 #ifdef	_KERNEL
322 /*
323  *	Macros:		vm_map_lock, etc.
324  *	Function:
325  *		Perform locking on the data portion of a map.  Note that
326  *		these macros mimic procedure calls returning void.  The
327  *		semicolon is supplied by the user of these macros, not
328  *		by the macros themselves.  The macros can safely be used
329  *		as unbraced elements in a higher level statement.
330  */
331 
332 void _vm_map_lock(vm_map_t map, const char *file, int line);
333 void _vm_map_unlock(vm_map_t map, const char *file, int line);
334 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line);
335 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
336 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
337 int _vm_map_trylock(vm_map_t map, const char *file, int line);
338 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
339 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
340 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
341 int vm_map_locked(vm_map_t map);
342 void vm_map_wakeup(vm_map_t map);
343 void vm_map_busy(vm_map_t map);
344 void vm_map_unbusy(vm_map_t map);
345 void vm_map_wait_busy(vm_map_t map);
346 vm_offset_t vm_map_max_KBI(const struct vm_map *map);
347 vm_offset_t vm_map_min_KBI(const struct vm_map *map);
348 pmap_t vm_map_pmap_KBI(vm_map_t map);
349 bool vm_map_range_valid_KBI(vm_map_t map, vm_offset_t start, vm_offset_t end);
350 
351 #define	vm_map_lock(map)	_vm_map_lock(map, LOCK_FILE, LOCK_LINE)
352 #define	vm_map_unlock(map)	_vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
353 #define	vm_map_unlock_and_wait(map, timo)	\
354 			_vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE)
355 #define	vm_map_lock_read(map)	_vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
356 #define	vm_map_unlock_read(map)	_vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
357 #define	vm_map_trylock(map)	_vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
358 #define	vm_map_trylock_read(map)	\
359 			_vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
360 #define	vm_map_lock_upgrade(map)	\
361 			_vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
362 #define	vm_map_lock_downgrade(map)	\
363 			_vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
364 
365 long vmspace_resident_count(struct vmspace *vmspace);
366 #endif	/* _KERNEL */
367 
368 /*
369  * Copy-on-write flags for vm_map operations
370  */
371 #define	MAP_INHERIT_SHARE	0x00000001
372 #define	MAP_COPY_ON_WRITE	0x00000002
373 #define	MAP_NOFAULT		0x00000004
374 #define	MAP_PREFAULT		0x00000008
375 #define	MAP_PREFAULT_PARTIAL	0x00000010
376 #define	MAP_DISABLE_SYNCER	0x00000020
377 #define	MAP_CHECK_EXCL		0x00000040
378 #define	MAP_CREATE_GUARD	0x00000080
379 #define	MAP_DISABLE_COREDUMP	0x00000100
380 #define	MAP_PREFAULT_MADVISE	0x00000200    /* from (user) madvise request */
381 #define	MAP_WRITECOUNT		0x00000400
382 #define	MAP_REMAP		0x00000800
383 #define	MAP_STACK_GROWS_DOWN	0x00001000
384 #define	MAP_STACK_GROWS_UP	0x00002000
385 #define	MAP_ACC_CHARGED		0x00004000
386 #define	MAP_ACC_NO_CHARGE	0x00008000
387 #define	MAP_CREATE_STACK_GAP_UP	0x00010000
388 #define	MAP_CREATE_STACK_GAP_DN	0x00020000
389 #define	MAP_VN_EXEC		0x00040000
390 #define	MAP_SPLIT_BOUNDARY_MASK	0x00180000
391 #define	MAP_NO_HINT		0x00200000
392 
393 #define	MAP_SPLIT_BOUNDARY_SHIFT 19
394 
395 /*
396  * vm_fault option flags
397  */
398 #define	VM_FAULT_NORMAL	0x00	/* Nothing special */
399 #define	VM_FAULT_WIRE	0x01	/* Wire the mapped page */
400 #define	VM_FAULT_DIRTY	0x02	/* Dirty the page; use w/VM_PROT_COPY */
401 #define	VM_FAULT_NOFILL	0x04	/* Fail if the pager doesn't have a copy */
402 
403 /*
404  * Initially, mappings are slightly sequential.  The maximum window size must
405  * account for the map entry's "read_ahead" field being defined as an uint8_t.
406  */
407 #define	VM_FAULT_READ_AHEAD_MIN		7
408 #define	VM_FAULT_READ_AHEAD_INIT	15
409 #define	VM_FAULT_READ_AHEAD_MAX		min(atop(maxphys) - 1, UINT8_MAX)
410 
411 /*
412  * The following "find_space" options are supported by vm_map_find().
413  *
414  * For VMFS_ALIGNED_SPACE, the desired alignment is specified to
415  * the macro argument as log base 2 of the desired alignment.
416  */
417 #define	VMFS_NO_SPACE		0	/* don't find; use the given range */
418 #define	VMFS_ANY_SPACE		1	/* find a range with any alignment */
419 #define	VMFS_OPTIMAL_SPACE	2	/* find a range with optimal alignment*/
420 #define	VMFS_SUPER_SPACE	3	/* find a superpage-aligned range */
421 #define	VMFS_ALIGNED_SPACE(x)	((x) << 8) /* find a range with fixed alignment */
422 
423 /*
424  * vm_map_wire and vm_map_unwire option flags
425  */
426 #define VM_MAP_WIRE_SYSTEM	0	/* wiring in a kernel map */
427 #define VM_MAP_WIRE_USER	1	/* wiring in a user map */
428 
429 #define VM_MAP_WIRE_NOHOLES	0	/* region must not have holes */
430 #define VM_MAP_WIRE_HOLESOK	2	/* region may have holes */
431 
432 #define VM_MAP_WIRE_WRITE	4	/* Validate writable. */
433 
434 typedef int vm_map_entry_reader(void *token, vm_map_entry_t addr,
435     vm_map_entry_t dest);
436 
437 #ifndef _KERNEL
438 /*
439  * Find the successor of a map_entry, using a reader to dereference pointers.
440  * '*clone' is a copy of a vm_map entry.  'reader' is used to copy a map entry
441  * at some address into '*clone'.  Change *clone to a copy of the next map
442  * entry, and return the address of that entry, or NULL if copying has failed.
443  *
444  * This function is made available to user-space code that needs to traverse
445  * map entries.
446  */
447 static inline vm_map_entry_t
448 vm_map_entry_read_succ(void *token, struct vm_map_entry *const clone,
449     vm_map_entry_reader reader)
450 {
451 	vm_map_entry_t after, backup;
452 	vm_offset_t start;
453 
454 	after = clone->right;
455 	start = clone->start;
456 	if (!reader(token, after, clone))
457 		return (NULL);
458 	backup = clone->left;
459 	if (!reader(token, backup, clone))
460 		return (NULL);
461 	if (clone->start > start) {
462 		do {
463 			after = backup;
464 			backup = clone->left;
465 			if (!reader(token, backup, clone))
466 				return (NULL);
467 		} while (clone->start != start);
468 	}
469 	if (!reader(token, after, clone))
470 		return (NULL);
471 	return (after);
472 }
473 #endif				/* ! _KERNEL */
474 
475 #ifdef _KERNEL
476 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
477 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t);
478 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t,
479     vm_offset_t, int, vm_prot_t, vm_prot_t, int);
480 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
481     vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
482 int vm_map_find_aligned(vm_map_t map, vm_offset_t *addr, vm_size_t length,
483     vm_offset_t max_addr, vm_offset_t alignment);
484 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t,
485     vm_prot_t, vm_prot_t, int);
486 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t);
487 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
488 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t);
489 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);
490 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
491     vm_pindex_t *, vm_prot_t *, boolean_t *);
492 int vm_map_lookup_locked(vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
493     vm_pindex_t *, vm_prot_t *, boolean_t *);
494 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
495 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
496 
497 static inline vm_map_entry_t
498 vm_map_entry_first(vm_map_t map)
499 {
500 
501 	return (map->header.right);
502 }
503 
504 static inline vm_map_entry_t
505 vm_map_entry_succ(vm_map_entry_t entry)
506 {
507 	vm_map_entry_t after;
508 
509 	after = entry->right;
510 	if (after->left->start > entry->start) {
511 		do
512 			after = after->left;
513 		while (after->left != entry);
514 	}
515 	return (after);
516 }
517 
518 #define VM_MAP_ENTRY_FOREACH(it, map)		\
519 	for ((it) = vm_map_entry_first(map);	\
520 	    (it) != &(map)->header;		\
521 	    (it) = vm_map_entry_succ(it))
522 
523 #define	VM_MAP_PROTECT_SET_PROT		0x0001
524 #define	VM_MAP_PROTECT_SET_MAXPROT	0x0002
525 
526 int vm_map_protect(vm_map_t map, vm_offset_t start, vm_offset_t end,
527     vm_prot_t new_prot, vm_prot_t new_maxprot, int flags);
528 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
529 void vm_map_try_merge_entries(vm_map_t map, vm_map_entry_t prev,
530     vm_map_entry_t entry);
531 void vm_map_startup (void);
532 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
533 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
534 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
535 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
536 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
537     int flags);
538 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, int flags);
539 int vm_map_wire_locked(vm_map_t map, vm_offset_t start, vm_offset_t end,
540     int flags);
541 long vmspace_swap_count(struct vmspace *vmspace);
542 void vm_map_entry_set_vnode_text(vm_map_entry_t entry, bool add);
543 #endif				/* _KERNEL */
544 #endif				/* _VM_MAP_ */
545