xref: /netbsd-src/sys/uvm/uvm_extern.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: uvm_extern.h,v 1.213 2018/05/28 21:04:35 chs 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  * defines
77  */
78 
79 /*
80  * the following defines are for uvm_map and functions which call it.
81  */
82 
83 /* protections bits */
84 #define UVM_PROT_MASK	0x07	/* protection mask */
85 #define UVM_PROT_NONE	0x00	/* protection none */
86 #define UVM_PROT_ALL	0x07	/* everything */
87 #define UVM_PROT_READ	0x01	/* read */
88 #define UVM_PROT_WRITE  0x02	/* write */
89 #define UVM_PROT_EXEC	0x04	/* exec */
90 
91 /* protection short codes */
92 #define UVM_PROT_R	0x01	/* read */
93 #define UVM_PROT_W	0x02	/* write */
94 #define UVM_PROT_RW	0x03    /* read-write */
95 #define UVM_PROT_X	0x04	/* exec */
96 #define UVM_PROT_RX	0x05	/* read-exec */
97 #define UVM_PROT_WX	0x06	/* write-exec */
98 #define UVM_PROT_RWX	0x07	/* read-write-exec */
99 
100 /* 0x08: not used */
101 
102 /* inherit codes */
103 #define UVM_INH_MASK	0x30	/* inherit mask */
104 #define UVM_INH_SHARE	0x00	/* "share" */
105 #define UVM_INH_COPY	0x10	/* "copy" */
106 #define UVM_INH_NONE	0x20	/* "none" */
107 #define UVM_INH_DONATE	0x30	/* "donate" << not used */
108 
109 /* 0x40, 0x80: not used */
110 
111 /* bits 0x700: max protection, 0x800: not used */
112 
113 /* bits 0x7000: advice, 0x8000: not used */
114 /* advice: matches MADV_* from sys/mman.h and POSIX_FADV_* from sys/fcntl.h */
115 #define UVM_ADV_NORMAL	0x0	/* 'normal' */
116 #define UVM_ADV_RANDOM	0x1	/* 'random' */
117 #define UVM_ADV_SEQUENTIAL 0x2	/* 'sequential' */
118 #define UVM_ADV_WILLNEED 0x3	/* pages will be needed */
119 #define UVM_ADV_DONTNEED 0x4	/* pages won't be needed */
120 #define UVM_ADV_NOREUSE	0x5	/* pages will be used only once */
121 #define UVM_ADV_MASK	0x7	/* mask */
122 
123 /* bits 0xffff0000: mapping flags */
124 #define UVM_FLAG_FIXED		0x00010000 /* find space */
125 #define UVM_FLAG_OVERLAY	0x00020000 /* establish overlay */
126 #define UVM_FLAG_NOMERGE	0x00040000 /* don't merge map entries */
127 #define UVM_FLAG_COPYONW	0x00080000 /* set copy_on_write flag */
128 #define UVM_FLAG_AMAPPAD	0x00100000 /* for bss: pad amap */
129 #define UVM_FLAG_TRYLOCK	0x00200000 /* fail if we can not lock map */
130 #define UVM_FLAG_NOWAIT		0x00400000 /* not allowed to sleep */
131 #define UVM_FLAG_WAITVA		0x00800000 /* wait for va */
132 #define UVM_FLAG_VAONLY		0x02000000 /* unmap: no pages are mapped */
133 #define UVM_FLAG_COLORMATCH	0x04000000 /* match color given in off */
134 #define UVM_FLAG_UNMAP		0x08000000 /* unmap existing entries */
135 
136 #define UVM_FLAG_BITS "\177\020\
137 F\0\3\
138 :\0PROT=NONE\0\
139 :\1PROT=R\0\
140 :\2PROT=W\0\
141 :\3PROT=RW\0\
142 :\4PROT=X\0\
143 :\5PROT=RX\0\
144 :\6PROT=WX\0\
145 :\7PROT=RWX\0\
146 F\4\2\
147 :\0INH=SHARE\0\
148 :\1INH=COPY\0\
149 :\2INH=NONE\0\
150 :\3INH=DONATE\0\
151 F\10\3\
152 :\0MAXPROT=NONE\0\
153 :\1MAXPROT=R\0\
154 :\2MAXPROT=W\0\
155 :\3MAXPROT=RW\0\
156 :\4MAXPROT=X\0\
157 :\5MAXPROT=RX\0\
158 :\6MAXPROT=WX\0\
159 :\7MAXPROT=RWX\0\
160 F\14\3\
161 :\0ADV=NORMAL\0\
162 :\1ADV=RANDOM\0\
163 :\2ADV=SEQUENTIAL\0\
164 :\3ADV=WILLNEED\0\
165 :\4ADV=DONTNEED\0\
166 :\5ADV=NOREUSE\0\
167 b\20FIXED\0\
168 b\21OVERLAY\0\
169 b\22NOMERGE\0\
170 b\23COPYONW\0\
171 b\24AMAPPAD\0\
172 b\25TRYLOCK\0\
173 b\26NOWAIT\0\
174 b\27WAITVA\0\
175 b\30VAONLY\0\
176 b\31COLORMATCH\0\
177 b\32UNMAP\0\
178 "
179 
180 /* macros to extract info */
181 #define UVM_PROTECTION(X)	((X) & UVM_PROT_MASK)
182 #define UVM_INHERIT(X)		(((X) & UVM_INH_MASK) >> 4)
183 #define UVM_MAXPROTECTION(X)	(((X) >> 8) & UVM_PROT_MASK)
184 #define UVM_ADVICE(X)		(((X) >> 12) & UVM_ADV_MASK)
185 
186 #define UVM_MAPFLAG(PROT,MAXPROT,INH,ADVICE,FLAGS) \
187 	(((MAXPROT) << 8)|(PROT)|(INH)|((ADVICE) << 12)|(FLAGS))
188 
189 /* magic offset value: offset not known(obj) or don't care(!obj) */
190 #define UVM_UNKNOWN_OFFSET ((voff_t) -1)
191 
192 /*
193  * the following defines are for uvm_km_alloc/free's flags
194  */
195 #define UVM_KMF_WIRED	0x1			/* allocation type: wired */
196 #define UVM_KMF_PAGEABLE 0x2			/* allocation type: pageable */
197 #define UVM_KMF_VAONLY	0x4			/* allocation type: VA only */
198 #define	UVM_KMF_TYPEMASK (UVM_KMF_VAONLY | UVM_KMF_PAGEABLE | UVM_KMF_WIRED)
199 #define UVM_KMF_CANFAIL	0x8			/* caller handles failure */
200 #define UVM_KMF_ZERO	0x10			/* want zero filled memory */
201 #define UVM_KMF_EXEC	0x20			/* need executable mapping */
202 #define UVM_KMF_TRYLOCK	UVM_FLAG_TRYLOCK	/* try locking only */
203 #define UVM_KMF_NOWAIT	UVM_FLAG_NOWAIT		/* not allowed to sleep */
204 #define UVM_KMF_WAITVA	UVM_FLAG_WAITVA		/* sleep for va */
205 #define UVM_KMF_COLORMATCH UVM_FLAG_COLORMATCH	/* start at color in align */
206 
207 /*
208  * the following defines the strategies for uvm_pagealloc_strat()
209  */
210 #define	UVM_PGA_STRAT_NORMAL	0	/* priority (low id to high) walk */
211 #define	UVM_PGA_STRAT_ONLY	1	/* only specified free list */
212 #define	UVM_PGA_STRAT_FALLBACK	2	/* ONLY falls back on NORMAL */
213 
214 /*
215  * flags for uvm_pagealloc_strat()
216  */
217 #define UVM_PGA_USERESERVE	0x0001	/* ok to use reserve pages */
218 #define	UVM_PGA_ZERO		0x0002	/* returned page must be zero'd */
219 
220 /*
221  * flags for ubc_uiomove()
222  */
223 #define UBC_READ	0x001	/* reading from object */
224 #define UBC_WRITE	0x002	/* writing to object */
225 #define UBC_FAULTBUSY	0x004	/* nobody else is using these pages, so busy
226 				 * them at alloc and unbusy at release (e.g.,
227 				 * for writes extending a file) */
228 
229 /*
230  * flags for ubc_release()
231  */
232 #define UBC_UNMAP	0x010	/* unmap pages now -- don't leave the
233 				 * mappings cached indefinitely */
234 
235 /*
236  * flags for ubc_uiomove()
237  */
238 #define	UBC_PARTIALOK	0x100	/* return early on error; otherwise, zero all
239 				 * remaining bytes after error */
240 
241 /*
242  * flags for uvn_findpages().
243  */
244 #define UFP_ALL		0x00
245 #define UFP_NOWAIT	0x01
246 #define UFP_NOALLOC	0x02
247 #define UFP_NOCACHE	0x04
248 #define UFP_NORDONLY	0x08
249 #define UFP_DIRTYONLY	0x10
250 #define UFP_BACKWARD	0x20
251 
252 /*
253  * lockflags that control the locking behavior of various functions.
254  */
255 #define	UVM_LK_ENTER	0x00000001	/* map locked on entry */
256 #define	UVM_LK_EXIT	0x00000002	/* leave map locked on exit */
257 
258 /*
259  * Default number of pages to allocate on the stack
260  */
261 #define	UBC_MAX_PAGES	8
262 
263 /*
264  * Value representing inactive emap.
265  */
266 #define	UVM_EMAP_INACTIVE	(0)
267 
268 /*
269  * structures
270  */
271 
272 struct buf;
273 struct core;
274 struct loadavg;
275 struct mount;
276 struct pglist;
277 struct proc;
278 struct uio;
279 struct uvm_object;
280 struct vm_anon;
281 struct vmspace;
282 struct pmap;
283 struct vnode;
284 struct vm_map_entry;
285 struct vm_map;
286 struct vm_page;
287 struct vmtotal;
288 
289 /*
290  * uvm_pctparam: parameter to be shown as percentage to user.
291  */
292 
293 #define	UVM_PCTPARAM_SHIFT	8
294 #define	UVM_PCTPARAM_SCALE	(1 << UVM_PCTPARAM_SHIFT)
295 #define	UVM_PCTPARAM_APPLY(pct, x) \
296 	(((x) * (pct)->pct_scaled) >> UVM_PCTPARAM_SHIFT)
297 struct uvm_pctparam {
298 	int pct_pct;	/* percent [0, 100] */ /* should be the first member */
299 	int pct_scaled;
300 	int (*pct_check)(struct uvm_pctparam *, int);
301 };
302 
303 /*
304  * uvmexp: global data structures that are exported to parts of the kernel
305  * other than the vm system.
306  */
307 
308 struct uvmexp {
309 	/* vm_page constants */
310 	int pagesize;   /* size of a page (PAGE_SIZE): must be power of 2 */
311 	int pagemask;   /* page mask */
312 	int pageshift;  /* page shift */
313 
314 	/* vm_page counters */
315 	int npages;     /* number of pages we manage */
316 	int free;       /* number of free pages */
317 	int paging;	/* number of pages in the process of being paged out */
318 	int wired;      /* number of wired pages */
319 
320 	/*
321 	 * Adding anything before this line will break binary compatibility
322 	 * with top(1) on NetBSD 1.5.
323 	 */
324 
325 	int ncolors;	/* number of page color buckets: must be p-o-2 */
326 	int colormask;	/* color bucket mask */
327 
328 	int zeropages;		/* number of zero'd pages */
329 	int reserve_pagedaemon; /* number of pages reserved for pagedaemon */
330 	int reserve_kernel;	/* number of pages reserved for kernel */
331 	unsigned anonpages;	/* number of pages used by anon mappings */
332 	unsigned filepages;	/* number of pages used by cached file data */
333 	unsigned execpages;	/* number of pages used by cached exec data */
334 
335 	/* pageout params */
336 	int freemin;    /* min number of free pages */
337 	int freetarg;   /* target number of free pages */
338 	int wiredmax;   /* max number of wired pages */
339 
340 	/* swap */
341 	int nswapdev;	/* number of configured swap devices in system */
342 	int swpages;	/* number of PAGE_SIZE'ed swap pages */
343 	int swpgavail;	/* number of swap pages currently available */
344 	int swpginuse;	/* number of swap pages in use */
345 	int swpgonly;	/* number of swap pages in use, not also in RAM */
346 	int nswget;	/* number of times fault calls uvm_swap_get() */
347 
348 	/* stat counters.  XXX: should be 64-bit counters */
349 	int _unused_faults;	/* page fault count */
350 	int _unused_traps;	/* trap count */
351 	int _unused_intrs;	/* interrupt count */
352 	int _unused_swtch;	/* context switch count */
353 	int _unused_softs;	/* software interrupt count */
354 	int _unused_syscalls;	/* system calls */
355 	int pageins;		/* pagein operation count */
356 				/* pageouts are in pdpageouts below */
357 	int _unused1;
358 	int _unused2;
359 	int pgswapin;		/* pages swapped in */
360 	int pgswapout;		/* pages swapped out */
361 	int forks;  		/* forks */
362 	int forks_ppwait;	/* forks where parent waits */
363 	int forks_sharevm;	/* forks where vmspace is shared */
364 	int pga_zerohit;	/* pagealloc where zero wanted and zero
365 				   was available */
366 	int pga_zeromiss;	/* pagealloc where zero wanted and zero
367 				   not available */
368 	int zeroaborts;		/* number of times page zeroing was
369 				   aborted */
370 	int colorhit;		/* pagealloc where we got optimal color */
371 	int colormiss;		/* pagealloc where we didn't */
372 	int cpuhit;		/* pagealloc where we allocated locally */
373 	int cpumiss;		/* pagealloc where we didn't */
374 
375 	/* fault subcounters.  XXX: should be 64-bit counters */
376 	int fltnoram;	/* number of times fault was out of ram */
377 	int fltnoanon;	/* number of times fault was out of anons */
378 	int fltpgwait;	/* number of times fault had to wait on a page */
379 	int fltpgrele;	/* number of times fault found a released page */
380 	int fltrelck;	/* number of times fault relock called */
381 	int fltrelckok;	/* number of times fault relock is a success */
382 	int fltanget;	/* number of times fault gets anon page */
383 	int fltanretry;	/* number of times fault retrys an anon get */
384 	int fltamcopy;	/* number of times fault clears "needs copy" */
385 	int fltnamap;	/* number of times fault maps a neighbor anon page */
386 	int fltnomap;	/* number of times fault maps a neighbor obj page */
387 	int fltlget;	/* number of times fault does a locked pgo_get */
388 	int fltget;	/* number of times fault does an unlocked get */
389 	int flt_anon;	/* number of times fault anon (case 1a) */
390 	int flt_acow;	/* number of times fault anon cow (case 1b) */
391 	int flt_obj;	/* number of times fault is on object page (2a) */
392 	int flt_prcopy;	/* number of times fault promotes with copy (2b) */
393 	int flt_przero;	/* number of times fault promotes with zerofill (2b) */
394 
395 	/* daemon counters.  XXX: should be 64-bit counters */
396 	int pdwoke;	/* number of times daemon woke up */
397 	int pdrevs;	/* number of times daemon rev'd clock hand */
398 	int _unused3;
399 	int pdfreed;	/* number of pages daemon freed since boot */
400 	int pdscans;	/* number of pages daemon scanned since boot */
401 	int pdanscan;	/* number of anonymous pages scanned by daemon */
402 	int pdobscan;	/* number of object pages scanned by daemon */
403 	int pdreact;	/* number of pages daemon reactivated since boot */
404 	int pdbusy;	/* number of times daemon found a busy page */
405 	int pdpageouts;	/* number of times daemon started a pageout */
406 	int pdpending;	/* number of times daemon got a pending pagout */
407 	int pddeact;	/* number of pages daemon deactivates */
408 	int pdreanon;	/* anon pages reactivated due to thresholds */
409 	int pdrefile;	/* file pages reactivated due to thresholds */
410 	int pdreexec;	/* executable pages reactivated due to thresholds */
411 
412 	int bootpages;  /* number of pages stolen at boot */
413 };
414 
415 /*
416  * The following structure is 64-bit alignment safe.  New elements
417  * should only be added to the end of this structure so binary
418  * compatibility can be preserved.
419  */
420 struct uvmexp_sysctl {
421 	int64_t	pagesize;
422 	int64_t	pagemask;
423 	int64_t	pageshift;
424 	int64_t	npages;
425 	int64_t	free;
426 	int64_t	active;
427 	int64_t	inactive;
428 	int64_t	paging;
429 	int64_t	wired;
430 	int64_t	zeropages;
431 	int64_t	reserve_pagedaemon;
432 	int64_t	reserve_kernel;
433 	int64_t	freemin;
434 	int64_t	freetarg;
435 	int64_t	inactarg;		/* unused */
436 	int64_t	wiredmax;
437 	int64_t	nswapdev;
438 	int64_t	swpages;
439 	int64_t	swpginuse;
440 	int64_t	swpgonly;
441 	int64_t	nswget;
442 	int64_t	unused1;		/* unused; was nanon */
443 	int64_t cpuhit;
444 	int64_t cpumiss;
445 	int64_t	faults;
446 	int64_t	traps;
447 	int64_t	intrs;
448 	int64_t	swtch;
449 	int64_t	softs;
450 	int64_t	syscalls;
451 	int64_t	pageins;
452 	int64_t	swapins;		/* unused */
453 	int64_t	swapouts;		/* unused */
454 	int64_t	pgswapin;
455 	int64_t	pgswapout;
456 	int64_t	forks;
457 	int64_t	forks_ppwait;
458 	int64_t	forks_sharevm;
459 	int64_t	pga_zerohit;
460 	int64_t	pga_zeromiss;
461 	int64_t	zeroaborts;
462 	int64_t	fltnoram;
463 	int64_t	fltnoanon;
464 	int64_t	fltpgwait;
465 	int64_t	fltpgrele;
466 	int64_t	fltrelck;
467 	int64_t	fltrelckok;
468 	int64_t	fltanget;
469 	int64_t	fltanretry;
470 	int64_t	fltamcopy;
471 	int64_t	fltnamap;
472 	int64_t	fltnomap;
473 	int64_t	fltlget;
474 	int64_t	fltget;
475 	int64_t	flt_anon;
476 	int64_t	flt_acow;
477 	int64_t	flt_obj;
478 	int64_t	flt_prcopy;
479 	int64_t	flt_przero;
480 	int64_t	pdwoke;
481 	int64_t	pdrevs;
482 	int64_t	unused4;
483 	int64_t	pdfreed;
484 	int64_t	pdscans;
485 	int64_t	pdanscan;
486 	int64_t	pdobscan;
487 	int64_t	pdreact;
488 	int64_t	pdbusy;
489 	int64_t	pdpageouts;
490 	int64_t	pdpending;
491 	int64_t	pddeact;
492 	int64_t	anonpages;
493 	int64_t	filepages;
494 	int64_t	execpages;
495 	int64_t colorhit;
496 	int64_t colormiss;
497 	int64_t ncolors;
498 	int64_t bootpages;
499 	int64_t poolpages;
500 };
501 
502 #ifdef _KERNEL
503 /* we need this before including uvm_page.h on some platforms */
504 extern struct uvmexp uvmexp;
505 /* MD code needs this without including <uvm/uvm.h> */
506 extern bool vm_page_zero_enable;
507 #endif
508 
509 /*
510  * Finally, bring in standard UVM headers.
511  */
512 #include <sys/vmmeter.h>
513 #include <sys/queue.h>
514 #include <sys/lock.h>
515 #ifdef _KERNEL
516 #include <sys/vmem.h>
517 #endif
518 #include <uvm/uvm_param.h>
519 #include <uvm/uvm_prot.h>
520 #include <uvm/uvm_pmap.h>
521 #if defined(_KERNEL) || defined(_KMEMUSER)
522 #include <uvm/uvm_map.h>
523 #include <uvm/uvm_pager.h>
524 #endif
525 
526 #ifdef _KERNEL
527 /*
528  * Include the uvm_hotplug(9) API unconditionally until
529  * uvm_page_physload() et. al. are obsoleted
530  *
531  * After this, MD code will have to explicitly include it if needed.
532  */
533 #include <uvm/uvm_physseg.h>
534 #endif
535 
536 /*
537  * helpers for calling ubc_release()
538  */
539 #ifdef PMAP_CACHE_VIVT
540 #define UBC_WANT_UNMAP(vp) (((vp)->v_iflag & VI_TEXT) != 0)
541 #else
542 #define UBC_WANT_UNMAP(vp) false
543 #endif
544 #define UBC_UNMAP_FLAG(vp) (UBC_WANT_UNMAP(vp) ? UBC_UNMAP : 0)
545 
546 #if defined(_KERNEL) || defined(_KMEMUSER)
547 /*
548  * Shareable process virtual address space.
549  * May eventually be merged with vm_map.
550  * Several fields are temporary (text, data stuff).
551  */
552 struct vmspace {
553 	struct	vm_map vm_map;	/* VM address map */
554 	int	vm_refcnt;	/* number of references *
555 				 * note: protected by vm_map.misc_lock */
556 	void *	vm_shm;		/* SYS5 shared memory private data XXX */
557 /* we copy from vm_startcopy to the end of the structure on fork */
558 #define vm_startcopy vm_rssize
559 	segsz_t vm_rssize;	/* current resident set size in pages */
560 	segsz_t vm_rssmax;	/* max resident size in pages */
561 	segsz_t vm_tsize;	/* text size (pages) XXX */
562 	segsz_t vm_dsize;	/* data size (pages) XXX */
563 	segsz_t vm_ssize;	/* stack size (pages) */
564 	segsz_t vm_issize;	/* initial unmapped stack size (pages) */
565 	void *	vm_taddr;	/* user virtual address of text XXX */
566 	void *	vm_daddr;	/* user virtual address of data XXX */
567 	void *vm_maxsaddr;	/* user VA at max stack growth */
568 	void *vm_minsaddr;	/* user VA at top of stack */
569 	size_t vm_aslr_delta_mmap;	/* mmap() random delta for ASLR */
570 };
571 #define	VMSPACE_IS_KERNEL_P(vm)	VM_MAP_IS_KERNEL(&(vm)->vm_map)
572 #endif
573 
574 #ifdef _KERNEL
575 
576 /*
577  * used to keep state while iterating over the map for a core dump.
578  */
579 struct uvm_coredump_state {
580 	void *cookie;		/* opaque for the caller */
581 	vaddr_t start;		/* start of region */
582 	vaddr_t realend;	/* real end of region */
583 	vaddr_t end;		/* virtual end of region */
584 	vm_prot_t prot;		/* protection of region */
585 	int flags;		/* flags; see below */
586 };
587 
588 #define	UVM_COREDUMP_STACK	0x01	/* region is user stack */
589 
590 /*
591  * the various kernel maps, owned by MD code
592  */
593 extern struct vm_map *kernel_map;
594 extern struct vm_map *phys_map;
595 
596 /*
597  * macros
598  */
599 
600 #define vm_resident_count(vm) (pmap_resident_count((vm)->vm_map.pmap))
601 
602 
603 /* vm_machdep.c */
604 int		vmapbuf(struct buf *, vsize_t);
605 void		vunmapbuf(struct buf *, vsize_t);
606 void		ktext_write(void *, const void *, size_t);
607 
608 /* uvm_aobj.c */
609 struct uvm_object	*uao_create(voff_t, int);
610 void			uao_set_pgfl(struct uvm_object *, int);
611 void			uao_detach(struct uvm_object *);
612 void			uao_reference(struct uvm_object *);
613 
614 /* uvm_bio.c */
615 void			ubc_init(void);
616 void			ubchist_init(void);
617 int			ubc_uiomove(struct uvm_object *, struct uio *, vsize_t,
618 			    int, int);
619 void			ubc_zerorange(struct uvm_object *, off_t, size_t, int);
620 void			ubc_purge(struct uvm_object *);
621 
622 /* uvm_fault.c */
623 #define uvm_fault(m, a, p) uvm_fault_internal(m, a, p, 0)
624 int		uvm_fault_internal(struct vm_map *, vaddr_t, vm_prot_t, int);
625 			/* handle a page fault */
626 
627 /* uvm_glue.c */
628 #if defined(KGDB)
629 void			uvm_chgkprot(void *, size_t, int);
630 #endif
631 void			uvm_proc_fork(struct proc *, struct proc *, bool);
632 void			uvm_lwp_fork(struct lwp *, struct lwp *,
633 			    void *, size_t, void (*)(void *), void *);
634 int			uvm_coredump_walkmap(struct proc *,
635 			    int (*)(struct uvm_coredump_state *), void *);
636 int			uvm_coredump_count_segs(struct proc *);
637 void			uvm_proc_exit(struct proc *);
638 void			uvm_lwp_exit(struct lwp *);
639 void			uvm_init_limits(struct proc *);
640 bool			uvm_kernacc(void *, size_t, vm_prot_t);
641 __dead void		uvm_scheduler(void);
642 vaddr_t			uvm_uarea_alloc(void);
643 void			uvm_uarea_free(vaddr_t);
644 vaddr_t			uvm_uarea_system_alloc(struct cpu_info *);
645 void			uvm_uarea_system_free(vaddr_t);
646 vaddr_t			uvm_lwp_getuarea(lwp_t *);
647 void			uvm_lwp_setuarea(lwp_t *, vaddr_t);
648 int			uvm_vslock(struct vmspace *, void *, size_t, vm_prot_t);
649 void			uvm_vsunlock(struct vmspace *, void *, size_t);
650 void			uvm_cpu_attach(struct cpu_info *);
651 
652 
653 /* uvm_init.c */
654 void			uvm_md_init(void);
655 void			uvm_init(void);
656 
657 /* uvm_io.c */
658 int			uvm_io(struct vm_map *, struct uio *, int);
659 
660 /* uvm_km.c */
661 vaddr_t			uvm_km_alloc(struct vm_map *, vsize_t, vsize_t,
662 			    uvm_flag_t);
663 int			uvm_km_protect(struct vm_map *, vaddr_t, vsize_t,
664 			    vm_prot_t);
665 void			uvm_km_free(struct vm_map *, vaddr_t, vsize_t,
666 			    uvm_flag_t);
667 
668 struct vm_map		*uvm_km_suballoc(struct vm_map *, vaddr_t *,
669 			    vaddr_t *, vsize_t, int, bool,
670 			    struct vm_map *);
671 int			uvm_km_kmem_alloc(vmem_t *, vmem_size_t, vm_flag_t,
672 			    vmem_addr_t *);
673 void			uvm_km_kmem_free(vmem_t *, vmem_addr_t, vmem_size_t);
674 bool			uvm_km_va_starved_p(void);
675 
676 /* uvm_map.c */
677 int			uvm_map(struct vm_map *, vaddr_t *, vsize_t,
678 			    struct uvm_object *, voff_t, vsize_t,
679 			    uvm_flag_t);
680 int			uvm_map_pageable(struct vm_map *, vaddr_t,
681 			    vaddr_t, bool, int);
682 int			uvm_map_pageable_all(struct vm_map *, int, vsize_t);
683 bool			uvm_map_checkprot(struct vm_map *, vaddr_t,
684 			    vaddr_t, vm_prot_t);
685 int			uvm_map_protect(struct vm_map *, vaddr_t,
686 			    vaddr_t, vm_prot_t, bool);
687 int			uvm_map_protect_user(struct lwp *, vaddr_t, vaddr_t,
688 			    vm_prot_t);
689 struct vmspace		*uvmspace_alloc(vaddr_t, vaddr_t, bool);
690 void			uvmspace_init(struct vmspace *, struct pmap *,
691 			    vaddr_t, vaddr_t, bool);
692 void			uvmspace_exec(struct lwp *, vaddr_t, vaddr_t, bool);
693 void			uvmspace_spawn(struct lwp *, vaddr_t, vaddr_t, bool);
694 struct vmspace		*uvmspace_fork(struct vmspace *);
695 void			uvmspace_addref(struct vmspace *);
696 void			uvmspace_free(struct vmspace *);
697 void			uvmspace_share(struct proc *, struct proc *);
698 void			uvmspace_unshare(struct lwp *);
699 
700 void			uvm_whatis(uintptr_t, void (*)(const char *, ...));
701 
702 /* uvm_meter.c */
703 int			uvm_sysctl(int *, u_int, void *, size_t *,
704 			    void *, size_t, struct proc *);
705 int			uvm_pctparam_check(struct uvm_pctparam *, int);
706 void			uvm_pctparam_set(struct uvm_pctparam *, int);
707 int			uvm_pctparam_get(struct uvm_pctparam *);
708 void			uvm_pctparam_init(struct uvm_pctparam *, int,
709 			    int (*)(struct uvm_pctparam *, int));
710 int			uvm_pctparam_createsysctlnode(struct uvm_pctparam *,
711 			    const char *, const char *);
712 
713 /* uvm_mmap.c */
714 int			uvm_mmap_dev(struct proc *, void **, size_t, dev_t,
715 			    off_t);
716 int			uvm_mmap_anon(struct proc *, void **, size_t);
717 vaddr_t			uvm_default_mapaddr(struct proc *, vaddr_t, vsize_t,
718 			    int);
719 
720 /* uvm_mremap.c */
721 int			uvm_mremap(struct vm_map *, vaddr_t, vsize_t,
722 			    struct vm_map *, vaddr_t *, vsize_t,
723 			    struct proc *, int);
724 
725 /* uvm_object.c */
726 void			uvm_obj_init(struct uvm_object *,
727 			    const struct uvm_pagerops *, bool, u_int);
728 void			uvm_obj_setlock(struct uvm_object *, kmutex_t *);
729 void			uvm_obj_destroy(struct uvm_object *, bool);
730 int			uvm_obj_wirepages(struct uvm_object *, off_t, off_t,
731 			    struct pglist *);
732 void			uvm_obj_unwirepages(struct uvm_object *, off_t, off_t);
733 
734 /* uvm_page.c */
735 struct vm_page		*uvm_pagealloc_strat(struct uvm_object *,
736 			    voff_t, struct vm_anon *, int, int, int);
737 #define	uvm_pagealloc(obj, off, anon, flags) \
738 	    uvm_pagealloc_strat((obj), (off), (anon), (flags), \
739 				UVM_PGA_STRAT_NORMAL, 0)
740 void			uvm_pagereplace(struct vm_page *,
741 			    struct vm_page *);
742 void			uvm_pagerealloc(struct vm_page *,
743 			    struct uvm_object *, voff_t);
744 void			uvm_setpagesize(void);
745 
746 /* uvm_pager.c */
747 void			uvm_aio_biodone(struct buf *);
748 void			uvm_aio_aiodone(struct buf *);
749 void			uvm_aio_aiodone_pages(struct vm_page **, int, bool,
750 			    int);
751 
752 /* uvm_pdaemon.c */
753 void			uvm_pageout(void *);
754 struct work;
755 void			uvm_aiodone_worker(struct work *, void *);
756 void			uvm_pageout_start(int);
757 void			uvm_pageout_done(int);
758 void			uvm_estimatepageable(int *, int *);
759 
760 /* uvm_pglist.c */
761 int			uvm_pglistalloc(psize_t, paddr_t, paddr_t,
762 			    paddr_t, paddr_t, struct pglist *, int, int);
763 void			uvm_pglistfree(struct pglist *);
764 
765 /* uvm_swap.c */
766 void			uvm_swap_init(void);
767 
768 /* uvm_unix.c */
769 int			uvm_grow(struct proc *, vaddr_t);
770 
771 /* uvm_user.c */
772 void			uvm_deallocate(struct vm_map *, vaddr_t, vsize_t);
773 
774 /* uvm_vnode.c */
775 void			uvm_vnp_setsize(struct vnode *, voff_t);
776 void			uvm_vnp_setwritesize(struct vnode *, voff_t);
777 int			uvn_findpages(struct uvm_object *, voff_t,
778 			    int *, struct vm_page **, int);
779 bool			uvn_text_p(struct uvm_object *);
780 bool			uvn_clean_p(struct uvm_object *);
781 bool			uvn_needs_writefault_p(struct uvm_object *);
782 
783 /* kern_malloc.c */
784 void			kmeminit_nkmempages(void);
785 extern int		nkmempages;
786 
787 #endif /* _KERNEL */
788 
789 #endif /* _UVM_UVM_EXTERN_H_ */
790