xref: /netbsd-src/sys/uvm/uvm_extern.h (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1 /*	$NetBSD: uvm_extern.h,v 1.168 2011/01/04 08:26:33 matt Exp $	*/
2 
3 /*
4  *
5  * Copyright (c) 1997 Charles D. Cranor and Washington University.
6  * All rights reserved.
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 Charles D. Cranor and
19  *      Washington University.
20  * 4. The name of the author may not be used to endorse or promote products
21  *    derived from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * from: Id: uvm_extern.h,v 1.1.2.21 1998/02/07 01:16:53 chs Exp
35  */
36 
37 /*-
38  * Copyright (c) 1991, 1992, 1993
39  *	The Regents of the University of California.  All rights reserved.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *	@(#)vm_extern.h	8.5 (Berkeley) 5/3/95
66  */
67 
68 #ifndef _UVM_UVM_EXTERN_H_
69 #define _UVM_UVM_EXTERN_H_
70 
71 /*
72  * uvm_extern.h: this file defines the external interface to the VM system.
73  *
74  * this should be the only file included by non-VM parts of the kernel
75  * which need access to VM services.   if you want to know the interface
76  * to the MI VM layer without knowing the details, this is the file to
77  * learn.
78  *
79  * NOTE: vm system calls are prototyped in syscallargs.h
80  */
81 
82 /*
83  * typedefs, necessary for standard UVM headers.
84  */
85 
86 typedef unsigned int uvm_flag_t;
87 
88 typedef int vm_inherit_t;	/* XXX: inheritance codes */
89 typedef off_t voff_t;		/* XXX: offset within a uvm_object */
90 typedef voff_t pgoff_t;		/* XXX: number of pages within a uvm object */
91 
92 /*
93  * defines
94  */
95 
96 /*
97  * the following defines are for uvm_map and functions which call it.
98  */
99 
100 /* protections bits */
101 #define UVM_PROT_MASK	0x07	/* protection mask */
102 #define UVM_PROT_NONE	0x00	/* protection none */
103 #define UVM_PROT_ALL	0x07	/* everything */
104 #define UVM_PROT_READ	0x01	/* read */
105 #define UVM_PROT_WRITE  0x02	/* write */
106 #define UVM_PROT_EXEC	0x04	/* exec */
107 
108 /* protection short codes */
109 #define UVM_PROT_R	0x01	/* read */
110 #define UVM_PROT_W	0x02	/* write */
111 #define UVM_PROT_RW	0x03    /* read-write */
112 #define UVM_PROT_X	0x04	/* exec */
113 #define UVM_PROT_RX	0x05	/* read-exec */
114 #define UVM_PROT_WX	0x06	/* write-exec */
115 #define UVM_PROT_RWX	0x07	/* read-write-exec */
116 
117 /* 0x08: not used */
118 
119 /* inherit codes */
120 #define UVM_INH_MASK	0x30	/* inherit mask */
121 #define UVM_INH_SHARE	0x00	/* "share" */
122 #define UVM_INH_COPY	0x10	/* "copy" */
123 #define UVM_INH_NONE	0x20	/* "none" */
124 #define UVM_INH_DONATE	0x30	/* "donate" << not used */
125 
126 /* 0x40, 0x80: not used */
127 
128 /* bits 0x700: max protection, 0x800: not used */
129 
130 /* bits 0x7000: advice, 0x8000: not used */
131 /* advice: matches MADV_* from sys/mman.h and POSIX_FADV_* from sys/fcntl.h */
132 #define UVM_ADV_NORMAL	0x0	/* 'normal' */
133 #define UVM_ADV_RANDOM	0x1	/* 'random' */
134 #define UVM_ADV_SEQUENTIAL 0x2	/* 'sequential' */
135 #define UVM_ADV_WILLNEED 0x3	/* pages will be needed */
136 #define UVM_ADV_DONTNEED 0x4	/* pages won't be needed */
137 #define UVM_ADV_NOREUSE	0x5	/* pages will be used only once */
138 #define UVM_ADV_MASK	0x7	/* mask */
139 
140 /* bits 0xffff0000: mapping flags */
141 #define UVM_FLAG_FIXED   0x010000 /* find space */
142 #define UVM_FLAG_OVERLAY 0x020000 /* establish overlay */
143 #define UVM_FLAG_NOMERGE 0x040000 /* don't merge map entries */
144 #define UVM_FLAG_COPYONW 0x080000 /* set copy_on_write flag */
145 #define UVM_FLAG_AMAPPAD 0x100000 /* for bss: pad amap to reduce malloc() */
146 #define UVM_FLAG_TRYLOCK 0x200000 /* fail if we can not lock map */
147 #define UVM_FLAG_NOWAIT  0x400000 /* not allowed to sleep */
148 #define UVM_FLAG_QUANTUM 0x800000 /* entry can never be split later */
149 #define UVM_FLAG_WAITVA  0x1000000 /* wait for va */
150 #define UVM_FLAG_VAONLY  0x2000000 /* unmap: no pages are mapped */
151 #define UVM_FLAG_COLORMATCH 0x4000000 /* match color given in off */
152 
153 /* macros to extract info */
154 #define UVM_PROTECTION(X)	((X) & UVM_PROT_MASK)
155 #define UVM_INHERIT(X)		(((X) & UVM_INH_MASK) >> 4)
156 #define UVM_MAXPROTECTION(X)	(((X) >> 8) & UVM_PROT_MASK)
157 #define UVM_ADVICE(X)		(((X) >> 12) & UVM_ADV_MASK)
158 
159 #define UVM_MAPFLAG(PROT,MAXPROT,INH,ADVICE,FLAGS) \
160 	(((MAXPROT) << 8)|(PROT)|(INH)|((ADVICE) << 12)|(FLAGS))
161 
162 /* magic offset value: offset not known(obj) or don't care(!obj) */
163 #define UVM_UNKNOWN_OFFSET ((voff_t) -1)
164 
165 /*
166  * the following defines are for uvm_km_alloc/free's flags
167  */
168 #define UVM_KMF_WIRED	0x1			/* allocation type: wired */
169 #define UVM_KMF_PAGEABLE 0x2			/* allocation type: pageable */
170 #define UVM_KMF_VAONLY	0x4			/* allocation type: VA only */
171 #define	UVM_KMF_TYPEMASK (UVM_KMF_VAONLY | UVM_KMF_PAGEABLE | UVM_KMF_WIRED)
172 #define UVM_KMF_CANFAIL	0x8			/* caller handles failure */
173 #define UVM_KMF_ZERO	0x10			/* want zero filled memory */
174 #define UVM_KMF_EXEC	0x20			/* need executable mapping */
175 #define UVM_KMF_TRYLOCK	UVM_FLAG_TRYLOCK	/* try locking only */
176 #define UVM_KMF_NOWAIT	UVM_FLAG_NOWAIT		/* not allowed to sleep */
177 #define UVM_KMF_WAITVA	UVM_FLAG_WAITVA		/* sleep for va */
178 
179 /*
180  * the following defines the strategies for uvm_pagealloc_strat()
181  */
182 #define	UVM_PGA_STRAT_NORMAL	0	/* priority (low id to high) walk */
183 #define	UVM_PGA_STRAT_ONLY	1	/* only specified free list */
184 #define	UVM_PGA_STRAT_FALLBACK	2	/* ONLY falls back on NORMAL */
185 
186 /*
187  * flags for uvm_pagealloc_strat()
188  */
189 #define UVM_PGA_USERESERVE	0x0001	/* ok to use reserve pages */
190 #define	UVM_PGA_ZERO		0x0002	/* returned page must be zero'd */
191 
192 /*
193  * flags for ubc_alloc()
194  */
195 #define UBC_READ	0x001
196 #define UBC_WRITE	0x002
197 #define UBC_FAULTBUSY	0x004
198 
199 /*
200  * flags for ubc_release()
201  */
202 #define UBC_UNMAP	0x010
203 
204 /*
205  * flags for ubc_uiomve()
206  */
207 #define	UBC_PARTIALOK	0x100
208 
209 /*
210  * flags for uvn_findpages().
211  */
212 #define UFP_ALL		0x00
213 #define UFP_NOWAIT	0x01
214 #define UFP_NOALLOC	0x02
215 #define UFP_NOCACHE	0x04
216 #define UFP_NORDONLY	0x08
217 #define UFP_DIRTYONLY	0x10
218 #define UFP_BACKWARD	0x20
219 
220 /*
221  * lockflags that control the locking behavior of various functions.
222  */
223 #define	UVM_LK_ENTER	0x00000001	/* map locked on entry */
224 #define	UVM_LK_EXIT	0x00000002	/* leave map locked on exit */
225 
226 /*
227  * Default number of pages to allocate on the stack
228  */
229 #define	UBC_MAX_PAGES	8
230 
231 /*
232  * Value representing inactive emap.
233  */
234 #define	UVM_EMAP_INACTIVE	(0)
235 
236 /*
237  * structures
238  */
239 
240 struct buf;
241 struct core;
242 struct loadavg;
243 struct mount;
244 struct pglist;
245 struct proc;
246 struct uio;
247 struct uvm_object;
248 struct vm_anon;
249 struct vmspace;
250 struct pmap;
251 struct vnode;
252 struct simplelock;
253 struct vm_map_entry;
254 struct vm_map;
255 struct vm_page;
256 struct vmtotal;
257 
258 /*
259  * uvm_pctparam: parameter to be shown as percentage to user.
260  */
261 
262 #define	UVM_PCTPARAM_SHIFT	8
263 #define	UVM_PCTPARAM_SCALE	(1 << UVM_PCTPARAM_SHIFT)
264 #define	UVM_PCTPARAM_APPLY(pct, x) \
265 	(((x) * (pct)->pct_scaled) >> UVM_PCTPARAM_SHIFT)
266 struct uvm_pctparam {
267 	int pct_pct;	/* percent [0, 100] */ /* should be the first member */
268 	int pct_scaled;
269 	int (*pct_check)(struct uvm_pctparam *, int);
270 };
271 
272 /*
273  * uvmexp: global data structures that are exported to parts of the kernel
274  * other than the vm system.
275  */
276 
277 struct uvmexp {
278 	/* vm_page constants */
279 	int pagesize;   /* size of a page (PAGE_SIZE): must be power of 2 */
280 	int pagemask;   /* page mask */
281 	int pageshift;  /* page shift */
282 
283 	/* vm_page counters */
284 	int npages;     /* number of pages we manage */
285 	int free;       /* number of free pages */
286 	int paging;	/* number of pages in the process of being paged out */
287 	int wired;      /* number of wired pages */
288 
289 	/*
290 	 * Adding anything before this line will break binary compatibility
291 	 * with top(1) on NetBSD 1.5.
292 	 */
293 
294 	int ncolors;	/* number of page color buckets: must be p-o-2 */
295 	int colormask;	/* color bucket mask */
296 
297 	int zeropages;		/* number of zero'd pages */
298 	int reserve_pagedaemon; /* number of pages reserved for pagedaemon */
299 	int reserve_kernel;	/* number of pages reserved for kernel */
300 	unsigned anonpages;	/* number of pages used by anon mappings */
301 	unsigned filepages;	/* number of pages used by cached file data */
302 	unsigned execpages;	/* number of pages used by cached exec data */
303 
304 	/* pageout params */
305 	int freemin;    /* min number of free pages */
306 	int freetarg;   /* target number of free pages */
307 	int wiredmax;   /* max number of wired pages */
308 
309 	/* swap */
310 	int nswapdev;	/* number of configured swap devices in system */
311 	int swpages;	/* number of PAGE_SIZE'ed swap pages */
312 	int swpgavail;	/* number of swap pages currently available */
313 	int swpginuse;	/* number of swap pages in use */
314 	int swpgonly;	/* number of swap pages in use, not also in RAM */
315 	int nswget;	/* number of times fault calls uvm_swap_get() */
316 
317 	/* stat counters.  XXX: should be 64-bit counters */
318 	int _unused_faults;	/* page fault count */
319 	int _unused_traps;	/* trap count */
320 	int _unused_intrs;	/* interrupt count */
321 	int _unused_swtch;	/* context switch count */
322 	int _unused_softs;	/* software interrupt count */
323 	int _unused_syscalls;	/* system calls */
324 	int pageins;		/* pagein operation count */
325 				/* pageouts are in pdpageouts below */
326 	int _unused1;
327 	int _unused2;
328 	int pgswapin;		/* pages swapped in */
329 	int pgswapout;		/* pages swapped out */
330 	int forks;  		/* forks */
331 	int forks_ppwait;	/* forks where parent waits */
332 	int forks_sharevm;	/* forks where vmspace is shared */
333 	int pga_zerohit;	/* pagealloc where zero wanted and zero
334 				   was available */
335 	int pga_zeromiss;	/* pagealloc where zero wanted and zero
336 				   not available */
337 	int zeroaborts;		/* number of times page zeroing was
338 				   aborted */
339 	int colorhit;		/* pagealloc where we got optimal color */
340 	int colormiss;		/* pagealloc where we didn't */
341 	int cpuhit;		/* pagealloc where we allocated locally */
342 	int cpumiss;		/* pagealloc where we didn't */
343 
344 	/* fault subcounters.  XXX: should be 64-bit counters */
345 	int fltnoram;	/* number of times fault was out of ram */
346 	int fltnoanon;	/* number of times fault was out of anons */
347 	int fltpgwait;	/* number of times fault had to wait on a page */
348 	int fltpgrele;	/* number of times fault found a released page */
349 	int fltrelck;	/* number of times fault relock called */
350 	int fltrelckok;	/* number of times fault relock is a success */
351 	int fltanget;	/* number of times fault gets anon page */
352 	int fltanretry;	/* number of times fault retrys an anon get */
353 	int fltamcopy;	/* number of times fault clears "needs copy" */
354 	int fltnamap;	/* number of times fault maps a neighbor anon page */
355 	int fltnomap;	/* number of times fault maps a neighbor obj page */
356 	int fltlget;	/* number of times fault does a locked pgo_get */
357 	int fltget;	/* number of times fault does an unlocked get */
358 	int flt_anon;	/* number of times fault anon (case 1a) */
359 	int flt_acow;	/* number of times fault anon cow (case 1b) */
360 	int flt_obj;	/* number of times fault is on object page (2a) */
361 	int flt_prcopy;	/* number of times fault promotes with copy (2b) */
362 	int flt_przero;	/* number of times fault promotes with zerofill (2b) */
363 
364 	/* daemon counters.  XXX: should be 64-bit counters */
365 	int pdwoke;	/* number of times daemon woke up */
366 	int pdrevs;	/* number of times daemon rev'd clock hand */
367 	int _unused3;
368 	int pdfreed;	/* number of pages daemon freed since boot */
369 	int pdscans;	/* number of pages daemon scanned since boot */
370 	int pdanscan;	/* number of anonymous pages scanned by daemon */
371 	int pdobscan;	/* number of object pages scanned by daemon */
372 	int pdreact;	/* number of pages daemon reactivated since boot */
373 	int pdbusy;	/* number of times daemon found a busy page */
374 	int pdpageouts;	/* number of times daemon started a pageout */
375 	int pdpending;	/* number of times daemon got a pending pagout */
376 	int pddeact;	/* number of pages daemon deactivates */
377 	int pdreanon;	/* anon pages reactivated due to thresholds */
378 	int pdrefile;	/* file pages reactivated due to thresholds */
379 	int pdreexec;	/* executable pages reactivated due to thresholds */
380 };
381 
382 /*
383  * The following structure is 64-bit alignment safe.  New elements
384  * should only be added to the end of this structure so binary
385  * compatibility can be preserved.
386  */
387 struct uvmexp_sysctl {
388 	int64_t	pagesize;
389 	int64_t	pagemask;
390 	int64_t	pageshift;
391 	int64_t	npages;
392 	int64_t	free;
393 	int64_t	active;
394 	int64_t	inactive;
395 	int64_t	paging;
396 	int64_t	wired;
397 	int64_t	zeropages;
398 	int64_t	reserve_pagedaemon;
399 	int64_t	reserve_kernel;
400 	int64_t	freemin;
401 	int64_t	freetarg;
402 	int64_t	inactarg;		/* unused */
403 	int64_t	wiredmax;
404 	int64_t	nswapdev;
405 	int64_t	swpages;
406 	int64_t	swpginuse;
407 	int64_t	swpgonly;
408 	int64_t	nswget;
409 	int64_t	unused1;		/* unused; was nanon */
410 	int64_t cpuhit;
411 	int64_t cpumiss;
412 	int64_t	faults;
413 	int64_t	traps;
414 	int64_t	intrs;
415 	int64_t	swtch;
416 	int64_t	softs;
417 	int64_t	syscalls;
418 	int64_t	pageins;
419 	int64_t	swapins;		/* unused */
420 	int64_t	swapouts;		/* unused */
421 	int64_t	pgswapin;
422 	int64_t	pgswapout;
423 	int64_t	forks;
424 	int64_t	forks_ppwait;
425 	int64_t	forks_sharevm;
426 	int64_t	pga_zerohit;
427 	int64_t	pga_zeromiss;
428 	int64_t	zeroaborts;
429 	int64_t	fltnoram;
430 	int64_t	fltnoanon;
431 	int64_t	fltpgwait;
432 	int64_t	fltpgrele;
433 	int64_t	fltrelck;
434 	int64_t	fltrelckok;
435 	int64_t	fltanget;
436 	int64_t	fltanretry;
437 	int64_t	fltamcopy;
438 	int64_t	fltnamap;
439 	int64_t	fltnomap;
440 	int64_t	fltlget;
441 	int64_t	fltget;
442 	int64_t	flt_anon;
443 	int64_t	flt_acow;
444 	int64_t	flt_obj;
445 	int64_t	flt_prcopy;
446 	int64_t	flt_przero;
447 	int64_t	pdwoke;
448 	int64_t	pdrevs;
449 	int64_t	unused4;
450 	int64_t	pdfreed;
451 	int64_t	pdscans;
452 	int64_t	pdanscan;
453 	int64_t	pdobscan;
454 	int64_t	pdreact;
455 	int64_t	pdbusy;
456 	int64_t	pdpageouts;
457 	int64_t	pdpending;
458 	int64_t	pddeact;
459 	int64_t	anonpages;
460 	int64_t	filepages;
461 	int64_t	execpages;
462 	int64_t colorhit;
463 	int64_t colormiss;
464 	int64_t ncolors;
465 };
466 
467 #ifdef _KERNEL
468 /* we need this before including uvm_page.h on some platforms */
469 extern struct uvmexp uvmexp;
470 /* MD code needs this without including <uvm/uvm.h> */
471 extern bool vm_page_zero_enable;
472 #endif
473 
474 /*
475  * Finally, bring in standard UVM headers.
476  */
477 #include <sys/vmmeter.h>
478 #include <sys/queue.h>
479 #include <sys/lock.h>
480 #include <uvm/uvm_param.h>
481 #include <uvm/uvm_prot.h>
482 #include <uvm/uvm_pmap.h>
483 #include <uvm/uvm_map.h>
484 #include <uvm/uvm_pager.h>
485 
486 /*
487  * helpers for calling ubc_release()
488  */
489 #ifdef PMAP_CACHE_VIVT
490 #define UBC_WANT_UNMAP(vp) (((vp)->v_iflag & VI_TEXT) != 0)
491 #else
492 #define UBC_WANT_UNMAP(vp) false
493 #endif
494 #define UBC_UNMAP_FLAG(vp) (UBC_WANT_UNMAP(vp) ? UBC_UNMAP : 0)
495 
496 /*
497  * Shareable process virtual address space.
498  * May eventually be merged with vm_map.
499  * Several fields are temporary (text, data stuff).
500  */
501 struct vmspace {
502 	struct	vm_map vm_map;	/* VM address map */
503 	int	vm_refcnt;	/* number of references *
504 				 * note: protected by vm_map.ref_lock */
505 	void *	vm_shm;		/* SYS5 shared memory private data XXX */
506 /* we copy from vm_startcopy to the end of the structure on fork */
507 #define vm_startcopy vm_rssize
508 	segsz_t vm_rssize;	/* current resident set size in pages */
509 	segsz_t vm_swrss;	/* resident set size before last swap */
510 	segsz_t vm_tsize;	/* text size (pages) XXX */
511 	segsz_t vm_dsize;	/* data size (pages) XXX */
512 	segsz_t vm_ssize;	/* stack size (pages) */
513 	segsz_t vm_issize;	/* initial unmapped stack size (pages) */
514 	void *	vm_taddr;	/* user virtual address of text XXX */
515 	void *	vm_daddr;	/* user virtual address of data XXX */
516 	void *vm_maxsaddr;	/* user VA at max stack growth */
517 	void *vm_minsaddr;	/* user VA at top of stack */
518 	size_t vm_aslr_delta_mmap;	/* mmap() random delta for ASLR */
519 };
520 #define	VMSPACE_IS_KERNEL_P(vm)	VM_MAP_IS_KERNEL(&(vm)->vm_map)
521 
522 #ifdef _KERNEL
523 
524 /*
525  * used to keep state while iterating over the map for a core dump.
526  */
527 struct uvm_coredump_state {
528 	void *cookie;		/* opaque for the caller */
529 	vaddr_t start;		/* start of region */
530 	vaddr_t realend;	/* real end of region */
531 	vaddr_t end;		/* virtual end of region */
532 	vm_prot_t prot;		/* protection of region */
533 	int flags;		/* flags; see below */
534 };
535 
536 #define	UVM_COREDUMP_STACK	0x01	/* region is user stack */
537 
538 /*
539  * Structure containig uvm reclaim hooks, uvm_reclaim_list is guarded by
540  * uvm_reclaim_lock.
541  */
542 struct uvm_reclaim_hook {
543 	void (*uvm_reclaim_hook)(void);
544 	SLIST_ENTRY(uvm_reclaim_hook) uvm_reclaim_next;
545 };
546 
547 void	uvm_reclaim_init(void);
548 void	uvm_reclaim_hook_add(struct uvm_reclaim_hook *);
549 void	uvm_reclaim_hook_del(struct uvm_reclaim_hook *);
550 
551 /*
552  * the various kernel maps, owned by MD code
553  */
554 extern struct vm_map *kernel_map;
555 extern struct vm_map *kmem_map;
556 extern struct vm_map *phys_map;
557 
558 /*
559  * macros
560  */
561 
562 #define vm_resident_count(vm) (pmap_resident_count((vm)->vm_map.pmap))
563 
564 #include <sys/mallocvar.h>
565 MALLOC_DECLARE(M_VMMAP);
566 MALLOC_DECLARE(M_VMPMAP);
567 
568 /* vm_machdep.c */
569 void		vmapbuf(struct buf *, vsize_t);
570 void		vunmapbuf(struct buf *, vsize_t);
571 
572 /* uvm_aobj.c */
573 struct uvm_object	*uao_create(vsize_t, int);
574 void			uao_detach(struct uvm_object *);
575 void			uao_reference(struct uvm_object *);
576 
577 /* uvm_bio.c */
578 void			ubc_init(void);
579 void *			ubc_alloc(struct uvm_object *, voff_t, vsize_t *, int,
580 			    int);
581 void			ubc_release(void *, int);
582 int			ubc_uiomove(struct uvm_object *, struct uio *, vsize_t,
583 			    int, int);
584 
585 /* uvm_emap.c */
586 void			uvm_emap_sysinit(void);
587 #ifdef __HAVE_PMAP_EMAP
588 void			uvm_emap_switch(lwp_t *);
589 #else
590 #define			uvm_emap_switch(l)
591 #endif
592 
593 u_int			uvm_emap_gen_return(void);
594 void			uvm_emap_update(u_int);
595 
596 vaddr_t			uvm_emap_alloc(vsize_t, bool);
597 void			uvm_emap_free(vaddr_t, size_t);
598 
599 void			uvm_emap_enter(vaddr_t, struct vm_page **, u_int);
600 void			uvm_emap_remove(vaddr_t, vsize_t);
601 
602 #ifdef __HAVE_PMAP_EMAP
603 void			uvm_emap_consume(u_int);
604 u_int			uvm_emap_produce(void);
605 #else
606 #define			uvm_emap_consume(x)
607 #define			uvm_emap_produce()	UVM_EMAP_INACTIVE
608 #endif
609 
610 /* uvm_fault.c */
611 #define uvm_fault(m, a, p) uvm_fault_internal(m, a, p, 0)
612 int		uvm_fault_internal(struct vm_map *, vaddr_t, vm_prot_t, int);
613 			/* handle a page fault */
614 
615 /* uvm_glue.c */
616 #if defined(KGDB)
617 void			uvm_chgkprot(void *, size_t, int);
618 #endif
619 void			uvm_proc_fork(struct proc *, struct proc *, bool);
620 void			uvm_lwp_fork(struct lwp *, struct lwp *,
621 			    void *, size_t, void (*)(void *), void *);
622 int			uvm_coredump_walkmap(struct proc *,
623 			    void *,
624 			    int (*)(struct proc *, void *,
625 				    struct uvm_coredump_state *), void *);
626 void			uvm_proc_exit(struct proc *);
627 void			uvm_lwp_exit(struct lwp *);
628 void			uvm_init_limits(struct proc *);
629 bool			uvm_kernacc(void *, size_t, int);
630 __dead void		uvm_scheduler(void);
631 vaddr_t			uvm_uarea_alloc(void);
632 void			uvm_uarea_free(vaddr_t);
633 vaddr_t			uvm_lwp_getuarea(lwp_t *);
634 void			uvm_lwp_setuarea(lwp_t *, vaddr_t);
635 int			uvm_vslock(struct vmspace *, void *, size_t, vm_prot_t);
636 void			uvm_vsunlock(struct vmspace *, void *, size_t);
637 void			uvm_cpu_attach(struct cpu_info *);
638 
639 
640 /* uvm_init.c */
641 void			uvm_init(void);
642 
643 /* uvm_io.c */
644 int			uvm_io(struct vm_map *, struct uio *);
645 
646 /* uvm_km.c */
647 vaddr_t			uvm_km_alloc(struct vm_map *, vsize_t, vsize_t,
648 			    uvm_flag_t);
649 void			uvm_km_free(struct vm_map *, vaddr_t, vsize_t,
650 			    uvm_flag_t);
651 
652 struct vm_map		*uvm_km_suballoc(struct vm_map *, vaddr_t *,
653 			    vaddr_t *, vsize_t, int, bool,
654 			    struct vm_map_kernel *);
655 vaddr_t			uvm_km_alloc_poolpage(struct vm_map *, bool);
656 void			uvm_km_free_poolpage(struct vm_map *, vaddr_t);
657 vaddr_t			uvm_km_alloc_poolpage_cache(struct vm_map *, bool);
658 void			uvm_km_free_poolpage_cache(struct vm_map *, vaddr_t);
659 void			uvm_km_vacache_init(struct vm_map *,
660 			    const char *, size_t);
661 
662 /* uvm_map.c */
663 int			uvm_map(struct vm_map *, vaddr_t *, vsize_t,
664 			    struct uvm_object *, voff_t, vsize_t,
665 			    uvm_flag_t);
666 int			uvm_map_pageable(struct vm_map *, vaddr_t,
667 			    vaddr_t, bool, int);
668 int			uvm_map_pageable_all(struct vm_map *, int, vsize_t);
669 bool			uvm_map_checkprot(struct vm_map *, vaddr_t,
670 			    vaddr_t, vm_prot_t);
671 int			uvm_map_protect(struct vm_map *, vaddr_t,
672 			    vaddr_t, vm_prot_t, bool);
673 struct vmspace		*uvmspace_alloc(vaddr_t, vaddr_t);
674 void			uvmspace_init(struct vmspace *, struct pmap *,
675 			    vaddr_t, vaddr_t);
676 void			uvmspace_exec(struct lwp *, vaddr_t, vaddr_t);
677 struct vmspace		*uvmspace_fork(struct vmspace *);
678 void			uvmspace_addref(struct vmspace *);
679 void			uvmspace_free(struct vmspace *);
680 void			uvmspace_share(struct proc *, struct proc *);
681 void			uvmspace_unshare(struct lwp *);
682 
683 void			uvm_whatis(uintptr_t, void (*)(const char *, ...));
684 
685 /* uvm_meter.c */
686 int			uvm_sysctl(int *, u_int, void *, size_t *,
687 			    void *, size_t, struct proc *);
688 int			uvm_pctparam_check(struct uvm_pctparam *, int);
689 void			uvm_pctparam_set(struct uvm_pctparam *, int);
690 int			uvm_pctparam_get(struct uvm_pctparam *);
691 void			uvm_pctparam_init(struct uvm_pctparam *, int,
692 			    int (*)(struct uvm_pctparam *, int));
693 int			uvm_pctparam_createsysctlnode(struct uvm_pctparam *,
694 			    const char *, const char *);
695 
696 /* uvm_mmap.c */
697 int			uvm_mmap(struct vm_map *, vaddr_t *, vsize_t,
698 			    vm_prot_t, vm_prot_t, int,
699 			    void *, voff_t, vsize_t);
700 vaddr_t			uvm_default_mapaddr(struct proc *, vaddr_t, vsize_t);
701 
702 /* uvm_mremap.c */
703 int			uvm_mremap(struct vm_map *, vaddr_t, vsize_t,
704 			    struct vm_map *, vaddr_t *, vsize_t,
705 			    struct proc *, int);
706 
707 /* uvm_object.c */
708 int			uobj_wirepages(struct uvm_object *uobj, off_t start,
709 			    off_t end);
710 void			uobj_unwirepages(struct uvm_object *uobj, off_t start,
711 			    off_t end);
712 
713 /* uvm_page.c */
714 struct vm_page		*uvm_pagealloc_strat(struct uvm_object *,
715 			    voff_t, struct vm_anon *, int, int, int);
716 #define	uvm_pagealloc(obj, off, anon, flags) \
717 	    uvm_pagealloc_strat((obj), (off), (anon), (flags), \
718 				UVM_PGA_STRAT_NORMAL, 0)
719 void			uvm_pagereplace(struct vm_page *,
720 			    struct vm_page *);
721 void			uvm_pagerealloc(struct vm_page *,
722 			    struct uvm_object *, voff_t);
723 /* Actually, uvm_page_physload takes PF#s which need their own type */
724 void			uvm_page_physload(paddr_t, paddr_t, paddr_t,
725 			    paddr_t, int);
726 void			uvm_setpagesize(void);
727 
728 /* uvm_pager.c */
729 void			uvm_aio_biodone(struct buf *);
730 void			uvm_aio_aiodone(struct buf *);
731 void			uvm_aio_aiodone_pages(struct vm_page **, int, bool,
732 			    int);
733 
734 /* uvm_pdaemon.c */
735 void			uvm_pageout(void *);
736 struct work;
737 void			uvm_aiodone_worker(struct work *, void *);
738 void			uvm_pageout_start(int);
739 void			uvm_pageout_done(int);
740 void			uvm_estimatepageable(int *, int *);
741 
742 /* uvm_pglist.c */
743 int			uvm_pglistalloc(psize_t, paddr_t, paddr_t,
744 			    paddr_t, paddr_t, struct pglist *, int, int);
745 void			uvm_pglistfree(struct pglist *);
746 
747 /* uvm_swap.c */
748 void			uvm_swap_init(void);
749 
750 /* uvm_unix.c */
751 int			uvm_grow(struct proc *, vaddr_t);
752 
753 /* uvm_user.c */
754 void			uvm_deallocate(struct vm_map *, vaddr_t, vsize_t);
755 
756 /* uvm_vnode.c */
757 void			uvm_vnp_setsize(struct vnode *, voff_t);
758 void			uvm_vnp_setwritesize(struct vnode *, voff_t);
759 int			uvn_findpages(struct uvm_object *, voff_t,
760 			    int *, struct vm_page **, int);
761 void			uvm_vnp_zerorange(struct vnode *, off_t, size_t);
762 bool			uvn_text_p(struct uvm_object *);
763 bool			uvn_clean_p(struct uvm_object *);
764 bool			uvn_needs_writefault_p(struct uvm_object *);
765 
766 /* kern_malloc.c */
767 void			kmeminit_nkmempages(void);
768 void			kmeminit(void);
769 extern int		nkmempages;
770 
771 #endif /* _KERNEL */
772 
773 #endif /* _UVM_UVM_EXTERN_H_ */
774