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