xref: /freebsd/sys/vm/vm_map.h (revision 7a7741af18d6c8a804cc643cb7ecda9d730c6aa6)
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  *
35  * Copyright (c) 1987, 1990 Carnegie-Mellon University.
36  * All rights reserved.
37  *
38  * Authors: Avadis Tevanian, Jr., Michael Wayne Young
39  *
40  * Permission to use, copy, modify and distribute this software and
41  * its documentation is hereby granted, provided that both the copyright
42  * notice and this permission notice appear in all copies of the
43  * software, derivative works or modified versions, and any portions
44  * thereof, and that both notices appear in supporting documentation.
45  *
46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
48  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
49  *
50  * Carnegie Mellon requests users of this software to return to
51  *
52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
53  *  School of Computer Science
54  *  Carnegie Mellon University
55  *  Pittsburgh PA 15213-3890
56  *
57  * any improvements or extensions that they make and grant Carnegie the
58  * rights to redistribute these changes.
59  */
60 
61 /*
62  *	Virtual memory map module definitions.
63  */
64 #ifndef	_VM_MAP_
65 #define	_VM_MAP_
66 
67 #include <sys/lock.h>
68 #include <sys/sx.h>
69 #include <sys/_mutex.h>
70 
71 /*
72  *	Types defined:
73  *
74  *	vm_map_t		the high-level address map data structure.
75  *	vm_map_entry_t		an entry in an address map.
76  */
77 
78 typedef u_char vm_flags_t;
79 typedef u_int vm_eflags_t;
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 union vm_map_object {
87 	struct vm_object *vm_object;	/* object object */
88 	struct vm_map *sub_map;		/* belongs to another map */
89 };
90 
91 /*
92  *	Address map entries consist of start and end addresses,
93  *	a VM object (or sharing map) and offset into that object,
94  *	and user-exported inheritance and protection information.
95  *	Also included is control information for virtual copy operations.
96  *
97  *	For stack gap map entries (MAP_ENTRY_GUARD | MAP_ENTRY_GROWS_DOWN
98  *	or UP), the next_read member is reused as the stack_guard_page
99  *	storage, and offset is the stack protection.
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 #define	MAP_ENTRY_SPLIT_BOUNDARY_SHIFT	20
154 #define	MAP_ENTRY_SPLIT_BOUNDARY_INDEX(entry)			\
155 	(((entry)->eflags & MAP_ENTRY_SPLIT_BOUNDARY_MASK) >>	\
156 	    MAP_ENTRY_SPLIT_BOUNDARY_SHIFT)
157 
158 #ifdef	_KERNEL
159 static __inline u_char
160 vm_map_entry_behavior(vm_map_entry_t entry)
161 {
162 	return (entry->eflags & MAP_ENTRY_BEHAV_MASK);
163 }
164 
165 static __inline int
166 vm_map_entry_user_wired_count(vm_map_entry_t entry)
167 {
168 	if (entry->eflags & MAP_ENTRY_USER_WIRED)
169 		return (1);
170 	return (0);
171 }
172 
173 static __inline int
174 vm_map_entry_system_wired_count(vm_map_entry_t entry)
175 {
176 	return (entry->wired_count - vm_map_entry_user_wired_count(entry));
177 }
178 #endif	/* _KERNEL */
179 
180 /*
181  *	A map is a set of map entries.  These map entries are
182  *	organized as a threaded binary search tree.  The tree is
183  *	ordered based upon the start and end addresses contained
184  *	within each map entry.  The largest gap between an entry in a
185  *	subtree and one of its neighbors is saved in the max_free
186  *	field, and that field is updated when the tree is restructured.
187  *
188  *	Sleator and Tarjan's top-down splay algorithm is employed to
189  *	control height imbalance in the binary search tree.
190  *
191  *	The map's min offset value is stored in map->header.end, and
192  *	its max offset value is stored in map->header.start.  These
193  *	values act as sentinels for any forward or backward address
194  *	scan of the list.  The right and left fields of the map
195  *	header point to the first and list map entries.  The map
196  *	header has a special value for the eflags field,
197  *	MAP_ENTRY_HEADER, that is set initially, is never changed,
198  *	and prevents an eflags match of the header with any other map
199  *	entry.
200  *
201  *	List of locks
202  *	(c)	const until freed
203  */
204 struct vm_map {
205 	struct vm_map_entry header;	/* List of entries */
206 	struct sx lock;			/* Lock for map data */
207 	struct mtx system_mtx;
208 	int nentries;			/* Number of entries */
209 	vm_size_t size;			/* virtual size */
210 	u_int timestamp;		/* Version number */
211 	u_char needs_wakeup;
212 	u_char system_map;		/* (c) Am I a system map? */
213 	vm_flags_t flags;		/* flags for this vm_map */
214 	vm_map_entry_t root;		/* Root of a binary search tree */
215 	pmap_t pmap;			/* (c) Physical map */
216 	vm_offset_t anon_loc;
217 	int busy;
218 #ifdef DIAGNOSTIC
219 	int nupdates;
220 #endif
221 };
222 
223 /*
224  * vm_flags_t values
225  */
226 #define MAP_WIREFUTURE		0x01	/* wire all future pages */
227 #define	MAP_BUSY_WAKEUP		0x02	/* thread(s) waiting on busy state */
228 #define	MAP_IS_SUB_MAP		0x04	/* has parent */
229 #define	MAP_ASLR		0x08	/* enabled ASLR */
230 #define	MAP_ASLR_IGNSTART	0x10	/* ASLR ignores data segment */
231 #define	MAP_REPLENISH		0x20	/* kmapent zone needs to be refilled */
232 #define	MAP_WXORX		0x40	/* enforce W^X */
233 #define	MAP_ASLR_STACK		0x80	/* stack location is randomized */
234 
235 #ifdef	_KERNEL
236 #if defined(KLD_MODULE) && !defined(KLD_TIED)
237 #define	vm_map_max(map)		vm_map_max_KBI((map))
238 #define	vm_map_min(map)		vm_map_min_KBI((map))
239 #define	vm_map_pmap(map)	vm_map_pmap_KBI((map))
240 #define	vm_map_range_valid(map, start, end)	\
241 	vm_map_range_valid_KBI((map), (start), (end))
242 #else
243 static __inline vm_offset_t
244 vm_map_max(const struct vm_map *map)
245 {
246 
247 	return (map->header.start);
248 }
249 
250 static __inline vm_offset_t
251 vm_map_min(const struct vm_map *map)
252 {
253 
254 	return (map->header.end);
255 }
256 
257 static __inline pmap_t
258 vm_map_pmap(vm_map_t map)
259 {
260 	return (map->pmap);
261 }
262 
263 static __inline void
264 vm_map_modflags(vm_map_t map, vm_flags_t set, vm_flags_t clear)
265 {
266 	map->flags = (map->flags | set) & ~clear;
267 }
268 
269 static inline bool
270 vm_map_range_valid(vm_map_t map, vm_offset_t start, vm_offset_t end)
271 {
272 	if (end < start)
273 		return (false);
274 	if (start < vm_map_min(map) || end > vm_map_max(map))
275 		return (false);
276 	return (true);
277 }
278 
279 #endif	/* KLD_MODULE */
280 #endif	/* _KERNEL */
281 
282 /*
283  * Shareable process virtual address space.
284  *
285  * List of locks
286  *	(c)	const until freed
287  */
288 struct vmspace {
289 	struct vm_map vm_map;	/* VM address map */
290 	struct shmmap_state *vm_shm;	/* SYS5 shared memory private data XXX */
291 	segsz_t vm_swrss;	/* resident set size before last swap */
292 	segsz_t vm_tsize;	/* text size (pages) XXX */
293 	segsz_t vm_dsize;	/* data size (pages) XXX */
294 	segsz_t vm_ssize;	/* stack size (pages) */
295 	caddr_t vm_taddr;	/* (c) user virtual address of text */
296 	caddr_t vm_daddr;	/* (c) user virtual address of data */
297 	caddr_t vm_maxsaddr;	/* user VA at max stack growth */
298 	vm_offset_t vm_stacktop; /* top of the stack, may not be page-aligned */
299 	vm_offset_t vm_shp_base; /* shared page address */
300 	u_int vm_refcnt;	/* number of references */
301 	/*
302 	 * Keep the PMAP last, so that CPU-specific variations of that
303 	 * structure on a single architecture don't result in offset
304 	 * variations of the machine-independent fields in the vmspace.
305 	 */
306 	struct pmap vm_pmap;	/* private physical map */
307 };
308 
309 #ifdef	_KERNEL
310 static __inline pmap_t
311 vmspace_pmap(struct vmspace *vmspace)
312 {
313 	return &vmspace->vm_pmap;
314 }
315 #endif	/* _KERNEL */
316 
317 #ifdef	_KERNEL
318 /*
319  *	Macros:		vm_map_lock, etc.
320  *	Function:
321  *		Perform locking on the data portion of a map.  Note that
322  *		these macros mimic procedure calls returning void.  The
323  *		semicolon is supplied by the user of these macros, not
324  *		by the macros themselves.  The macros can safely be used
325  *		as unbraced elements in a higher level statement.
326  */
327 
328 void _vm_map_lock(vm_map_t map, const char *file, int line);
329 void _vm_map_unlock(vm_map_t map, const char *file, int line);
330 int _vm_map_unlock_and_wait(vm_map_t map, int timo, const char *file, int line);
331 void _vm_map_lock_read(vm_map_t map, const char *file, int line);
332 void _vm_map_unlock_read(vm_map_t map, const char *file, int line);
333 int _vm_map_trylock(vm_map_t map, const char *file, int line);
334 int _vm_map_trylock_read(vm_map_t map, const char *file, int line);
335 int _vm_map_lock_upgrade(vm_map_t map, const char *file, int line);
336 void _vm_map_lock_downgrade(vm_map_t map, const char *file, int line);
337 int vm_map_locked(vm_map_t map);
338 void vm_map_wakeup(vm_map_t map);
339 void vm_map_busy(vm_map_t map);
340 void vm_map_unbusy(vm_map_t map);
341 void vm_map_wait_busy(vm_map_t map);
342 vm_offset_t vm_map_max_KBI(const struct vm_map *map);
343 vm_offset_t vm_map_min_KBI(const struct vm_map *map);
344 pmap_t vm_map_pmap_KBI(vm_map_t map);
345 bool vm_map_range_valid_KBI(vm_map_t map, vm_offset_t start, vm_offset_t end);
346 
347 #define	vm_map_lock(map)	_vm_map_lock(map, LOCK_FILE, LOCK_LINE)
348 #define	vm_map_unlock(map)	_vm_map_unlock(map, LOCK_FILE, LOCK_LINE)
349 #define	vm_map_unlock_and_wait(map, timo)	\
350 			_vm_map_unlock_and_wait(map, timo, LOCK_FILE, LOCK_LINE)
351 #define	vm_map_lock_read(map)	_vm_map_lock_read(map, LOCK_FILE, LOCK_LINE)
352 #define	vm_map_unlock_read(map)	_vm_map_unlock_read(map, LOCK_FILE, LOCK_LINE)
353 #define	vm_map_trylock(map)	_vm_map_trylock(map, LOCK_FILE, LOCK_LINE)
354 #define	vm_map_trylock_read(map)	\
355 			_vm_map_trylock_read(map, LOCK_FILE, LOCK_LINE)
356 #define	vm_map_lock_upgrade(map)	\
357 			_vm_map_lock_upgrade(map, LOCK_FILE, LOCK_LINE)
358 #define	vm_map_lock_downgrade(map)	\
359 			_vm_map_lock_downgrade(map, LOCK_FILE, LOCK_LINE)
360 
361 long vmspace_resident_count(struct vmspace *vmspace);
362 #endif	/* _KERNEL */
363 
364 /*
365  * Copy-on-write flags for vm_map operations
366  */
367 #define	MAP_INHERIT_SHARE	0x00000001
368 #define	MAP_COPY_ON_WRITE	0x00000002
369 #define	MAP_NOFAULT		0x00000004
370 #define	MAP_PREFAULT		0x00000008
371 #define	MAP_PREFAULT_PARTIAL	0x00000010
372 #define	MAP_DISABLE_SYNCER	0x00000020
373 #define	MAP_CHECK_EXCL		0x00000040
374 #define	MAP_CREATE_GUARD	0x00000080
375 #define	MAP_DISABLE_COREDUMP	0x00000100
376 #define	MAP_PREFAULT_MADVISE	0x00000200    /* from (user) madvise request */
377 #define	MAP_WRITECOUNT		0x00000400
378 #define	MAP_REMAP		0x00000800
379 #define	MAP_STACK_GROWS_DOWN	0x00001000
380 #define	MAP_STACK_GROWS_UP	0x00002000
381 #define	MAP_ACC_CHARGED		0x00004000
382 #define	MAP_ACC_NO_CHARGE	0x00008000
383 #define	MAP_CREATE_STACK_GAP_UP	0x00010000
384 #define	MAP_CREATE_STACK_GAP_DN	0x00020000
385 #define	MAP_VN_EXEC		0x00040000
386 #define	MAP_SPLIT_BOUNDARY_MASK	0x00180000
387 #define	MAP_NO_HINT		0x00200000
388 
389 #define	MAP_SPLIT_BOUNDARY_SHIFT 19
390 
391 /*
392  * vm_fault option flags
393  */
394 #define	VM_FAULT_NORMAL	0x00	/* Nothing special */
395 #define	VM_FAULT_WIRE	0x01	/* Wire the mapped page */
396 #define	VM_FAULT_DIRTY	0x02	/* Dirty the page; use w/VM_PROT_COPY */
397 #define	VM_FAULT_NOFILL	0x04	/* Fail if the pager doesn't have a copy */
398 
399 /*
400  * Initially, mappings are slightly sequential.  The maximum window size must
401  * account for the map entry's "read_ahead" field being defined as an uint8_t.
402  */
403 #define	VM_FAULT_READ_AHEAD_MIN		7
404 #define	VM_FAULT_READ_AHEAD_INIT	15
405 #define	VM_FAULT_READ_AHEAD_MAX		min(atop(maxphys) - 1, UINT8_MAX)
406 
407 /*
408  * The following "find_space" options are supported by vm_map_find().
409  *
410  * For VMFS_ALIGNED_SPACE, the desired alignment is specified to
411  * the macro argument as log base 2 of the desired alignment.
412  */
413 #define	VMFS_NO_SPACE		0	/* don't find; use the given range */
414 #define	VMFS_ANY_SPACE		1	/* find a range with any alignment */
415 #define	VMFS_OPTIMAL_SPACE	2	/* find a range with optimal alignment*/
416 #define	VMFS_SUPER_SPACE	3	/* find a superpage-aligned range */
417 #define	VMFS_ALIGNED_SPACE(x)	((x) << 8) /* find a range with fixed alignment */
418 
419 /*
420  * vm_map_wire and vm_map_unwire option flags
421  */
422 #define VM_MAP_WIRE_SYSTEM	0	/* wiring in a kernel map */
423 #define VM_MAP_WIRE_USER	1	/* wiring in a user map */
424 
425 #define VM_MAP_WIRE_NOHOLES	0	/* region must not have holes */
426 #define VM_MAP_WIRE_HOLESOK	2	/* region may have holes */
427 
428 #define VM_MAP_WIRE_WRITE	4	/* Validate writable. */
429 
430 typedef int vm_map_entry_reader(void *token, vm_map_entry_t addr,
431     vm_map_entry_t dest);
432 
433 #ifndef _KERNEL
434 /*
435  * Find the successor of a map_entry, using a reader to dereference pointers.
436  * '*clone' is a copy of a vm_map entry.  'reader' is used to copy a map entry
437  * at some address into '*clone'.  Change *clone to a copy of the next map
438  * entry, and return the address of that entry, or NULL if copying has failed.
439  *
440  * This function is made available to user-space code that needs to traverse
441  * map entries.
442  */
443 static inline vm_map_entry_t
444 vm_map_entry_read_succ(void *token, struct vm_map_entry *const clone,
445     vm_map_entry_reader reader)
446 {
447 	vm_map_entry_t after, backup;
448 	vm_offset_t start;
449 
450 	after = clone->right;
451 	start = clone->start;
452 	if (!reader(token, after, clone))
453 		return (NULL);
454 	backup = clone->left;
455 	if (!reader(token, backup, clone))
456 		return (NULL);
457 	if (clone->start > start) {
458 		do {
459 			after = backup;
460 			backup = clone->left;
461 			if (!reader(token, backup, clone))
462 				return (NULL);
463 		} while (clone->start != start);
464 	}
465 	if (!reader(token, after, clone))
466 		return (NULL);
467 	return (after);
468 }
469 #endif				/* ! _KERNEL */
470 
471 #ifdef _KERNEL
472 boolean_t vm_map_check_protection (vm_map_t, vm_offset_t, vm_offset_t, vm_prot_t);
473 int vm_map_delete(vm_map_t, vm_offset_t, vm_offset_t);
474 int vm_map_find(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *, vm_size_t,
475     vm_offset_t, int, vm_prot_t, vm_prot_t, int);
476 int vm_map_find_locked(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
477     vm_size_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
478 int vm_map_find_min(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t *,
479     vm_size_t, vm_offset_t, vm_offset_t, int, vm_prot_t, vm_prot_t, int);
480 int vm_map_find_aligned(vm_map_t map, vm_offset_t *addr, vm_size_t length,
481     vm_offset_t max_addr, vm_offset_t alignment);
482 int vm_map_fixed(vm_map_t, vm_object_t, vm_ooffset_t, vm_offset_t, vm_size_t,
483     vm_prot_t, vm_prot_t, int);
484 vm_offset_t vm_map_findspace(vm_map_t, vm_offset_t, vm_size_t);
485 int vm_map_inherit (vm_map_t, vm_offset_t, vm_offset_t, vm_inherit_t);
486 void vm_map_init(vm_map_t, pmap_t, vm_offset_t, vm_offset_t);
487 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);
488 int vm_map_lookup (vm_map_t *, vm_offset_t, vm_prot_t, vm_map_entry_t *, vm_object_t *,
489     vm_pindex_t *, vm_prot_t *, boolean_t *);
490 int vm_map_lookup_locked(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 void vm_map_lookup_done (vm_map_t, vm_map_entry_t);
493 boolean_t vm_map_lookup_entry (vm_map_t, vm_offset_t, vm_map_entry_t *);
494 
495 static inline vm_map_entry_t
496 vm_map_entry_first(vm_map_t map)
497 {
498 
499 	return (map->header.right);
500 }
501 
502 static inline vm_map_entry_t
503 vm_map_entry_succ(vm_map_entry_t entry)
504 {
505 	vm_map_entry_t after;
506 
507 	after = entry->right;
508 	if (after->left->start > entry->start) {
509 		do
510 			after = after->left;
511 		while (after->left != entry);
512 	}
513 	return (after);
514 }
515 
516 #define VM_MAP_ENTRY_FOREACH(it, map)		\
517 	for ((it) = vm_map_entry_first(map);	\
518 	    (it) != &(map)->header;		\
519 	    (it) = vm_map_entry_succ(it))
520 
521 #define	VM_MAP_PROTECT_SET_PROT		0x0001
522 #define	VM_MAP_PROTECT_SET_MAXPROT	0x0002
523 #define	VM_MAP_PROTECT_GROWSDOWN	0x0004
524 
525 int vm_map_protect(vm_map_t map, vm_offset_t start, vm_offset_t end,
526     vm_prot_t new_prot, vm_prot_t new_maxprot, int flags);
527 int vm_map_remove (vm_map_t, vm_offset_t, vm_offset_t);
528 vm_map_entry_t vm_map_try_merge_entries(vm_map_t map, vm_map_entry_t prev,
529     vm_map_entry_t entry);
530 void vm_map_startup (void);
531 int vm_map_submap (vm_map_t, vm_offset_t, vm_offset_t, vm_map_t);
532 int vm_map_sync(vm_map_t, vm_offset_t, vm_offset_t, boolean_t, boolean_t);
533 int vm_map_madvise (vm_map_t, vm_offset_t, vm_offset_t, int);
534 int vm_map_stack (vm_map_t, vm_offset_t, vm_size_t, vm_prot_t, vm_prot_t, int);
535 int vm_map_unwire(vm_map_t map, vm_offset_t start, vm_offset_t end,
536     int flags);
537 int vm_map_wire(vm_map_t map, vm_offset_t start, vm_offset_t end, int flags);
538 int vm_map_wire_locked(vm_map_t map, vm_offset_t start, vm_offset_t end,
539     int flags);
540 long vmspace_swap_count(struct vmspace *vmspace);
541 void vm_map_entry_set_vnode_text(vm_map_entry_t entry, bool add);
542 #endif				/* _KERNEL */
543 #endif				/* _VM_MAP_ */
544