xref: /netbsd-src/sys/uvm/uvm_extern.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: uvm_extern.h,v 1.231 2020/08/14 09:06:15 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 #define	UVM_PGA_STRAT_NUMA	3	/* strongly prefer ideal bucket */
214 
215 /*
216  * flags for uvm_pagealloc_strat()
217  */
218 #define UVM_PGA_USERESERVE	0x0001	/* ok to use reserve pages */
219 #define	UVM_PGA_ZERO		0x0002	/* returned page must be zero'd */
220 
221 /*
222  * flags for ubc_uiomove()
223  */
224 #define UBC_READ	0x001	/* reading from object */
225 #define UBC_WRITE	0x002	/* writing to object */
226 #define UBC_FAULTBUSY	0x004	/* nobody else is using these pages, so busy
227 				 * them at alloc and unbusy at release (e.g.,
228 				 * for writes extending a file) */
229 #define	UBC_ISMAPPED	0x008	/* object may be mapped by a process */
230 
231 /*
232  * flags for ubc_release()
233  */
234 #define UBC_UNMAP	0x010	/* unmap pages now -- don't leave the
235 				 * mappings cached indefinitely */
236 
237 /*
238  * flags for ubc_uiomove()
239  */
240 #define	UBC_PARTIALOK	0x100	/* return early on error; otherwise, zero all
241 				 * remaining bytes after error */
242 
243 /*
244  * flags for uvn_findpages().
245  */
246 #define UFP_ALL		0x00
247 #define UFP_NOWAIT	0x01
248 #define UFP_NOALLOC	0x02
249 #define UFP_NOCACHE	0x04
250 #define UFP_NORDONLY	0x08
251 #define UFP_DIRTYONLY	0x10
252 #define UFP_BACKWARD	0x20
253 #define UFP_NOBUSY	0x40
254 
255 /*
256  * lockflags that control the locking behavior of various functions.
257  */
258 #define	UVM_LK_ENTER	0x00000001	/* map locked on entry */
259 #define	UVM_LK_EXIT	0x00000002	/* leave map locked on exit */
260 
261 /*
262  * Default number of pages to allocate on the stack
263  */
264 #define	UBC_MAX_PAGES	8
265 
266 /*
267  * Value representing inactive emap.
268  */
269 #define	UVM_EMAP_INACTIVE	(0)
270 
271 /*
272  * structures
273  */
274 
275 struct buf;
276 struct core;
277 struct loadavg;
278 struct mount;
279 struct pglist;
280 struct proc;
281 struct uio;
282 struct uvm_object;
283 struct vm_anon;
284 struct vmspace;
285 struct pmap;
286 struct vnode;
287 struct vm_map_entry;
288 struct vm_map;
289 struct vm_page;
290 struct vmtotal;
291 
292 /*
293  * uvm_pctparam: parameter to be shown as percentage to user.
294  */
295 
296 #define	UVM_PCTPARAM_SHIFT	8
297 #define	UVM_PCTPARAM_SCALE	(1 << UVM_PCTPARAM_SHIFT)
298 #define	UVM_PCTPARAM_APPLY(pct, x) \
299 	(((x) * (pct)->pct_scaled) >> UVM_PCTPARAM_SHIFT)
300 struct uvm_pctparam {
301 	int pct_pct;	/* percent [0, 100] */ /* should be the first member */
302 	int pct_scaled;
303 	int (*pct_check)(struct uvm_pctparam *, int);
304 };
305 
306 /*
307  * uvmexp: global data structures that are exported to parts of the kernel
308  * other than the vm system.
309  */
310 
311 struct uvmexp {
312 	/* vm_page constants */
313 	int pagesize;   /* size of a page (PAGE_SIZE): must be power of 2 */
314 	int pagemask;   /* page mask */
315 	int pageshift;  /* page shift */
316 
317 	/* vm_page counters */
318 	int npages;     /* number of pages we manage */
319 	int free;       /* number of free pages */
320 	int paging;	/* number of pages in the process of being paged out */
321 	int wired;      /* number of wired pages */
322 
323 	/*
324 	 * Adding anything before this line will break binary compatibility
325 	 * with top(1) on NetBSD 1.5.
326 	 */
327 
328 	int ncolors;	/* number of page color buckets: must be p-o-2 */
329 	int colormask;	/* color bucket mask */
330 
331 	int zeropages;		/* number of zero'd pages */
332 	int reserve_pagedaemon; /* number of pages reserved for pagedaemon */
333 	int reserve_kernel;	/* number of pages reserved for kernel */
334 	unsigned anonpages;	/* number of pages used by anon mappings */
335 	unsigned filepages;	/* number of pages used by cached file data */
336 	unsigned execpages;	/* number of pages used by cached exec data */
337 
338 	/* pageout params */
339 	int freemin;    /* min number of free pages */
340 	int freetarg;   /* target number of free pages */
341 	int wiredmax;   /* max number of wired pages */
342 
343 	/* swap */
344 	int nswapdev;	/* number of configured swap devices in system */
345 	int swpages;	/* number of PAGE_SIZE'ed swap pages */
346 	int swpgavail;	/* number of swap pages currently available */
347 	int swpginuse;	/* number of swap pages in use */
348 	int swpgonly;	/* number of swap pages in use, not also in RAM */
349 	int nswget;	/* number of times fault calls uvm_swap_get() */
350 
351 	/* stat counters.  XXX: should be 64-bit counters */
352 	int faults;		/* page fault count */
353 	int traps;		/* trap count */
354 	int intrs;		/* interrupt count */
355 	int swtch;		/* context switch count */
356 	int softs;		/* software interrupt count */
357 	int syscalls;		/* system calls */
358 	int pageins;		/* pagein operation count */
359 				/* pageouts are in pdpageouts below */
360 	int _unused1;
361 	int _unused2;
362 	int pgswapin;		/* pages swapped in */
363 	int pgswapout;		/* pages swapped out */
364 	int forks;  		/* forks */
365 	int forks_ppwait;	/* forks where parent waits */
366 	int forks_sharevm;	/* forks where vmspace is shared */
367 	int pga_zerohit;	/* pagealloc where zero wanted and zero
368 				   was available */
369 	int pga_zeromiss;	/* pagealloc where zero wanted and zero
370 				   not available */
371 	int zeroaborts;		/* number of times page zeroing was
372 				   aborted */
373 	int colorhit;		/* pagealloc where we got optimal color */
374 	int colormiss;		/* pagealloc where we didn't */
375 	int cpuhit;		/* pagealloc where we allocated locally */
376 	int cpumiss;		/* pagealloc where we didn't */
377 
378 	/* fault subcounters.  XXX: should be 64-bit counters */
379 	int fltnoram;	/* number of times fault was out of ram */
380 	int fltnoanon;	/* number of times fault was out of anons */
381 	int fltpgwait;	/* number of times fault had to wait on a page */
382 	int fltpgrele;	/* number of times fault found a released page */
383 	int fltrelck;	/* number of times fault relock called */
384 	int fltrelckok;	/* number of times fault relock is a success */
385 	int fltanget;	/* number of times fault gets anon page */
386 	int fltanretry;	/* number of times fault retrys an anon get */
387 	int fltamcopy;	/* number of times fault clears "needs copy" */
388 	int fltnamap;	/* number of times fault maps a neighbor anon page */
389 	int fltnomap;	/* number of times fault maps a neighbor obj page */
390 	int fltlget;	/* number of times fault does a locked pgo_get */
391 	int fltget;	/* number of times fault does an unlocked get */
392 	int flt_anon;	/* number of times fault anon (case 1a) */
393 	int flt_acow;	/* number of times fault anon cow (case 1b) */
394 	int flt_obj;	/* number of times fault is on object page (2a) */
395 	int flt_prcopy;	/* number of times fault promotes with copy (2b) */
396 	int flt_przero;	/* number of times fault promotes with zerofill (2b) */
397 
398 	/* daemon counters.  XXX: should be 64-bit counters */
399 	int pdwoke;	/* number of times daemon woke up */
400 	int pdrevs;	/* number of times daemon rev'd clock hand */
401 	int _unused3;
402 	int pdfreed;	/* number of pages daemon freed since boot */
403 	int pdscans;	/* number of pages daemon scanned since boot */
404 	int pdanscan;	/* number of anonymous pages scanned by daemon */
405 	int pdobscan;	/* number of object pages scanned by daemon */
406 	int pdreact;	/* number of pages daemon reactivated since boot */
407 	int pdbusy;	/* number of times daemon found a busy page */
408 	int pdpageouts;	/* number of times daemon started a pageout */
409 	int pdpending;	/* number of times daemon got a pending pagout */
410 	int pddeact;	/* number of pages daemon deactivates */
411 	int pdreanon;	/* anon pages reactivated due to thresholds */
412 	int pdrefile;	/* file pages reactivated due to thresholds */
413 	int pdreexec;	/* executable pages reactivated due to thresholds */
414 
415 	int bootpages;  /* number of pages stolen at boot */
416 };
417 
418 /*
419  * The following structure is 64-bit alignment safe.  New elements
420  * should only be added to the end of this structure so binary
421  * compatibility can be preserved.
422  */
423 struct uvmexp_sysctl {
424 	int64_t	pagesize;
425 	int64_t	pagemask;
426 	int64_t	pageshift;
427 	int64_t	npages;
428 	int64_t	free;
429 	int64_t	active;
430 	int64_t	inactive;
431 	int64_t	paging;
432 	int64_t	wired;
433 	int64_t	zeropages;
434 	int64_t	reserve_pagedaemon;
435 	int64_t	reserve_kernel;
436 	int64_t	freemin;
437 	int64_t	freetarg;
438 	int64_t	inactarg;		/* unused */
439 	int64_t	wiredmax;
440 	int64_t	nswapdev;
441 	int64_t	swpages;
442 	int64_t	swpginuse;
443 	int64_t	swpgonly;
444 	int64_t	nswget;
445 	int64_t	unused1;		/* unused; was nanon */
446 	int64_t cpuhit;
447 	int64_t cpumiss;
448 	int64_t	faults;
449 	int64_t	traps;
450 	int64_t	intrs;
451 	int64_t	swtch;
452 	int64_t	softs;
453 	int64_t	syscalls;
454 	int64_t	pageins;
455 	int64_t	swapins;		/* unused */
456 	int64_t	swapouts;		/* unused */
457 	int64_t	pgswapin;		/* unused */
458 	int64_t	pgswapout;
459 	int64_t	forks;
460 	int64_t	forks_ppwait;
461 	int64_t	forks_sharevm;
462 	int64_t	pga_zerohit;
463 	int64_t	pga_zeromiss;
464 	int64_t	zeroaborts;
465 	int64_t	fltnoram;
466 	int64_t	fltnoanon;
467 	int64_t	fltpgwait;
468 	int64_t	fltpgrele;
469 	int64_t	fltrelck;
470 	int64_t	fltrelckok;
471 	int64_t	fltanget;
472 	int64_t	fltanretry;
473 	int64_t	fltamcopy;
474 	int64_t	fltnamap;
475 	int64_t	fltnomap;
476 	int64_t	fltlget;
477 	int64_t	fltget;
478 	int64_t	flt_anon;
479 	int64_t	flt_acow;
480 	int64_t	flt_obj;
481 	int64_t	flt_prcopy;
482 	int64_t	flt_przero;
483 	int64_t	pdwoke;
484 	int64_t	pdrevs;
485 	int64_t	unused4;
486 	int64_t	pdfreed;
487 	int64_t	pdscans;
488 	int64_t	pdanscan;
489 	int64_t	pdobscan;
490 	int64_t	pdreact;
491 	int64_t	pdbusy;
492 	int64_t	pdpageouts;
493 	int64_t	pdpending;
494 	int64_t	pddeact;
495 	int64_t	anonpages;
496 	int64_t	filepages;
497 	int64_t	execpages;
498 	int64_t colorhit;
499 	int64_t colormiss;
500 	int64_t ncolors;
501 	int64_t bootpages;
502 	int64_t poolpages;
503 	int64_t countsyncone;
504 	int64_t countsyncall;
505 	int64_t anonunknown;
506 	int64_t anonclean;
507 	int64_t anondirty;
508 	int64_t fileunknown;
509 	int64_t fileclean;
510 	int64_t filedirty;
511 	int64_t fltup;
512 	int64_t fltnoup;
513 };
514 
515 #ifdef _KERNEL
516 /* we need this before including uvm_page.h on some platforms */
517 extern struct uvmexp uvmexp;
518 #endif
519 
520 /*
521  * Finally, bring in standard UVM headers.
522  */
523 #include <sys/vmmeter.h>
524 #include <sys/queue.h>
525 #include <sys/lock.h>
526 #ifdef _KERNEL
527 #include <sys/vmem.h>
528 #endif
529 #include <uvm/uvm_param.h>
530 #include <uvm/uvm_prot.h>
531 #include <uvm/uvm_pmap.h>
532 #if defined(_KERNEL) || defined(_KMEMUSER)
533 #include <uvm/uvm_map.h>
534 #include <uvm/uvm_pager.h>
535 #endif
536 
537 #ifdef _KERNEL
538 /*
539  * Include the uvm_hotplug(9) API unconditionally until
540  * uvm_page_physload() et. al. are obsoleted
541  *
542  * After this, MD code will have to explicitly include it if needed.
543  */
544 #include <uvm/uvm_physseg.h>
545 #endif
546 
547 /*
548  * helpers for calling ubc_release()
549  */
550 #ifdef PMAP_CACHE_VIVT
551 #define UBC_VNODE_FLAGS(vp) \
552     ((((vp)->v_iflag & VI_TEXT) != 0 ? UBC_UNMAP : 0) | \
553     (((vp)->v_vflag & VV_MAPPED) != 0 ? UBC_ISMAPPED : 0))
554 #else
555 #define UBC_VNODE_FLAGS(vp) \
556     (((vp)->v_vflag & VV_MAPPED) != 0 ? UBC_ISMAPPED : 0)
557 #endif
558 
559 #if defined(_KERNEL) || defined(_KMEMUSER)
560 /*
561  * Shareable process virtual address space.
562  * May eventually be merged with vm_map.
563  * Several fields are temporary (text, data stuff).
564  */
565 struct vmspace {
566 	struct	vm_map vm_map;	/* VM address map */
567 	volatile int vm_refcnt;	/* number of references */
568 	void *	vm_shm;		/* SYS5 shared memory private data XXX */
569 /* we copy from vm_startcopy to the end of the structure on fork */
570 #define vm_startcopy vm_rssize
571 	segsz_t vm_rssize;	/* current resident set size in pages */
572 	segsz_t vm_rssmax;	/* max resident size in pages */
573 	segsz_t vm_tsize;	/* text size (pages) XXX */
574 	segsz_t vm_dsize;	/* data size (pages) XXX */
575 	segsz_t vm_ssize;	/* stack size (pages) */
576 	segsz_t vm_issize;	/* initial unmapped stack size (pages) */
577 	void *	vm_taddr;	/* user virtual address of text XXX */
578 	void *	vm_daddr;	/* user virtual address of data XXX */
579 	void *vm_maxsaddr;	/* user VA at max stack growth */
580 	void *vm_minsaddr;	/* user VA at top of stack */
581 	size_t vm_aslr_delta_mmap;	/* mmap() random delta for ASLR */
582 };
583 #define	VMSPACE_IS_KERNEL_P(vm)	VM_MAP_IS_KERNEL(&(vm)->vm_map)
584 #endif
585 
586 #ifdef _KERNEL
587 
588 /*
589  * used to keep state while iterating over the map for a core dump.
590  */
591 struct uvm_coredump_state {
592 	void *cookie;		/* opaque for the caller */
593 	vaddr_t start;		/* start of region */
594 	vaddr_t realend;	/* real end of region */
595 	vaddr_t end;		/* virtual end of region */
596 	vm_prot_t prot;		/* protection of region */
597 	int flags;		/* flags; see below */
598 };
599 
600 #define	UVM_COREDUMP_STACK	0x01	/* region is user stack */
601 
602 /*
603  * the various kernel maps, owned by MD code
604  */
605 extern struct vm_map *kernel_map;
606 extern struct vm_map *phys_map;
607 
608 /*
609  *	uvm_voaddr:
610  *
611  *	This structure encapsulates UVM's unique virtual object address
612  *	for an individual byte inside a pageable page. Pageable pages can
613  *	be owned by either a uvm_object or a vm_anon.
614  *
615  *	In each case, the byte offset into the owning object
616  *	(uvm_object or vm_anon) is included in the ID, so that
617  *	two different offsets into the same page have distinct
618  *	IDs.
619  *
620  *	Note that the page does not necessarily have to be resident
621  *	in order to know the virtual object address.  However, it
622  *	is required that any pending copy-on-write is resolved.
623  *
624  *	When someone wants a virtual object address, an extra reference
625  *	is taken on the owner while the caller uses the ID.  This
626  *	ensures that the identity is stable for the duration of its
627  *	use.
628  */
629 struct uvm_voaddr {
630 	uintptr_t object;
631 	voff_t offset;
632 };
633 
634 /*
635  * macros
636  */
637 
638 #define vm_resident_count(vm) (pmap_resident_count((vm)->vm_map.pmap))
639 
640 
641 /* vm_machdep.c */
642 int		vmapbuf(struct buf *, vsize_t);
643 void		vunmapbuf(struct buf *, vsize_t);
644 void		ktext_write(void *, const void *, size_t);
645 
646 /* uvm_aobj.c */
647 struct uvm_object	*uao_create(voff_t, int);
648 void			uao_set_pgfl(struct uvm_object *, int);
649 void			uao_detach(struct uvm_object *);
650 void			uao_reference(struct uvm_object *);
651 
652 /* uvm_bio.c */
653 void			ubc_init(void);
654 void			ubchist_init(void);
655 int			ubc_uiomove(struct uvm_object *, struct uio *, vsize_t,
656 			    int, int);
657 void			ubc_zerorange(struct uvm_object *, off_t, size_t, int);
658 void			ubc_purge(struct uvm_object *);
659 
660 /* uvm_fault.c */
661 #define uvm_fault(m, a, p) uvm_fault_internal(m, a, p, 0)
662 int		uvm_fault_internal(struct vm_map *, vaddr_t, vm_prot_t, int);
663 			/* handle a page fault */
664 
665 /* uvm_glue.c */
666 #if defined(KGDB)
667 void			uvm_chgkprot(void *, size_t, int);
668 #endif
669 void			uvm_proc_fork(struct proc *, struct proc *, bool);
670 void			uvm_lwp_fork(struct lwp *, struct lwp *,
671 			    void *, size_t, void (*)(void *), void *);
672 int			uvm_coredump_walkmap(struct proc *,
673 			    int (*)(struct uvm_coredump_state *), void *);
674 int			uvm_coredump_count_segs(struct proc *);
675 void			uvm_proc_exit(struct proc *);
676 void			uvm_lwp_exit(struct lwp *);
677 void			uvm_idle(void);
678 void			uvm_init_limits(struct proc *);
679 bool			uvm_kernacc(void *, size_t, vm_prot_t);
680 __dead void		uvm_scheduler(void);
681 vaddr_t			uvm_uarea_alloc(void);
682 void			uvm_uarea_free(vaddr_t);
683 vaddr_t			uvm_uarea_system_alloc(struct cpu_info *);
684 void			uvm_uarea_system_free(vaddr_t);
685 vaddr_t			uvm_lwp_getuarea(lwp_t *);
686 void			uvm_lwp_setuarea(lwp_t *, vaddr_t);
687 int			uvm_vslock(struct vmspace *, void *, size_t, vm_prot_t);
688 void			uvm_vsunlock(struct vmspace *, void *, size_t);
689 void			uvm_cpu_attach(struct cpu_info *);
690 
691 
692 /* uvm_init.c */
693 void			uvm_md_init(void);
694 void			uvm_init(void);
695 
696 /* uvm_io.c */
697 int			uvm_io(struct vm_map *, struct uio *, int);
698 
699 /* uvm_km.c */
700 vaddr_t			uvm_km_alloc(struct vm_map *, vsize_t, vsize_t,
701 			    uvm_flag_t);
702 int			uvm_km_protect(struct vm_map *, vaddr_t, vsize_t,
703 			    vm_prot_t);
704 void			uvm_km_free(struct vm_map *, vaddr_t, vsize_t,
705 			    uvm_flag_t);
706 
707 struct vm_map		*uvm_km_suballoc(struct vm_map *, vaddr_t *,
708 			    vaddr_t *, vsize_t, int, bool,
709 			    struct vm_map *);
710 int			uvm_km_kmem_alloc(vmem_t *, vmem_size_t, vm_flag_t,
711 			    vmem_addr_t *);
712 void			uvm_km_kmem_free(vmem_t *, vmem_addr_t, vmem_size_t);
713 bool			uvm_km_va_starved_p(void);
714 
715 /* uvm_map.c */
716 int			uvm_map(struct vm_map *, vaddr_t *, vsize_t,
717 			    struct uvm_object *, voff_t, vsize_t,
718 			    uvm_flag_t);
719 int			uvm_map_pageable(struct vm_map *, vaddr_t,
720 			    vaddr_t, bool, int);
721 int			uvm_map_pageable_all(struct vm_map *, int, vsize_t);
722 bool			uvm_map_checkprot(struct vm_map *, vaddr_t,
723 			    vaddr_t, vm_prot_t);
724 int			uvm_map_protect(struct vm_map *, vaddr_t,
725 			    vaddr_t, vm_prot_t, bool);
726 int			uvm_map_protect_user(struct lwp *, vaddr_t, vaddr_t,
727 			    vm_prot_t);
728 struct vmspace		*uvmspace_alloc(vaddr_t, vaddr_t, bool);
729 void			uvmspace_init(struct vmspace *, struct pmap *,
730 			    vaddr_t, vaddr_t, bool);
731 void			uvmspace_exec(struct lwp *, vaddr_t, vaddr_t, bool);
732 void			uvmspace_spawn(struct lwp *, vaddr_t, vaddr_t, bool);
733 struct vmspace		*uvmspace_fork(struct vmspace *);
734 void			uvmspace_addref(struct vmspace *);
735 void			uvmspace_free(struct vmspace *);
736 void			uvmspace_share(struct proc *, struct proc *);
737 void			uvmspace_unshare(struct lwp *);
738 
739 bool			uvm_voaddr_acquire(struct vm_map *, vaddr_t,
740 			    struct uvm_voaddr *);
741 void			uvm_voaddr_release(struct uvm_voaddr *);
742 int			uvm_voaddr_compare(const struct uvm_voaddr *,
743 			    const struct uvm_voaddr *);
744 
745 void			uvm_whatis(uintptr_t, void (*)(const char *, ...));
746 
747 /* uvm_meter.c */
748 int			uvm_sysctl(int *, u_int, void *, size_t *,
749 			    void *, size_t, struct proc *);
750 int			uvm_pctparam_check(struct uvm_pctparam *, int);
751 void			uvm_pctparam_set(struct uvm_pctparam *, int);
752 int			uvm_pctparam_get(struct uvm_pctparam *);
753 void			uvm_pctparam_init(struct uvm_pctparam *, int,
754 			    int (*)(struct uvm_pctparam *, int));
755 int			uvm_pctparam_createsysctlnode(struct uvm_pctparam *,
756 			    const char *, const char *);
757 void			uvm_update_uvmexp(void);
758 
759 /* uvm_mmap.c */
760 int			uvm_mmap_dev(struct proc *, void **, size_t, dev_t,
761 			    off_t);
762 int			uvm_mmap_anon(struct proc *, void **, size_t);
763 vaddr_t			uvm_default_mapaddr(struct proc *, vaddr_t, vsize_t,
764 			    int);
765 
766 /* uvm_mremap.c */
767 int			uvm_mremap(struct vm_map *, vaddr_t, vsize_t,
768 			    struct vm_map *, vaddr_t *, vsize_t,
769 			    struct proc *, int);
770 
771 /* uvm_object.c */
772 void			uvm_obj_init(struct uvm_object *,
773 			    const struct uvm_pagerops *, bool, u_int);
774 void			uvm_obj_setlock(struct uvm_object *, krwlock_t *);
775 void			uvm_obj_destroy(struct uvm_object *, bool);
776 int			uvm_obj_wirepages(struct uvm_object *, off_t, off_t,
777 			    struct pglist *);
778 void			uvm_obj_unwirepages(struct uvm_object *, off_t, off_t);
779 bool			uvm_obj_clean_p(struct uvm_object *);
780 bool			uvm_obj_nowriteback_p(struct uvm_object *);
781 bool			uvm_obj_page_dirty_p(struct vm_page *);
782 void			uvm_obj_page_set_dirty(struct vm_page *);
783 void			uvm_obj_page_clear_dirty(struct vm_page *);
784 bool			uvm_obj_page_writeback_p(struct vm_page *);
785 void			uvm_obj_page_set_writeback(struct vm_page *);
786 void			uvm_obj_page_clear_writeback(struct vm_page *);
787 
788 /* uvm_page.c */
789 int			uvm_availmem(bool);
790 void			uvm_page_numa_load(paddr_t, paddr_t, u_int);
791 struct vm_page		*uvm_pagealloc_strat(struct uvm_object *,
792 			    voff_t, struct vm_anon *, int, int, int);
793 #define	uvm_pagealloc(obj, off, anon, flags) \
794 	    uvm_pagealloc_strat((obj), (off), (anon), (flags), \
795 				UVM_PGA_STRAT_NORMAL, 0)
796 void			uvm_pagereplace(struct vm_page *,
797 			    struct vm_page *);
798 int			uvm_pagerealloc(struct vm_page *,
799 			    struct uvm_object *, voff_t);
800 void			uvm_setpagesize(void);
801 
802 /* uvm_pager.c */
803 void			uvm_aio_aiodone(struct buf *);
804 void			uvm_aio_aiodone_pages(struct vm_page **, int, bool,
805 			    int);
806 
807 /* uvm_pdaemon.c */
808 void			uvm_pageout(void *);
809 struct work;
810 void			uvm_aiodone_worker(struct work *, void *);
811 void			uvm_pageout_start(int);
812 void			uvm_pageout_done(int);
813 void			uvm_estimatepageable(int *, int *);
814 
815 /* uvm_pglist.c */
816 int			uvm_pglistalloc(psize_t, paddr_t, paddr_t,
817 			    paddr_t, paddr_t, struct pglist *, int, int);
818 void			uvm_pglistfree(struct pglist *);
819 
820 /* uvm_swap.c */
821 void			uvm_swap_init(void);
822 
823 /* uvm_unix.c */
824 int			uvm_grow(struct proc *, vaddr_t);
825 
826 /* uvm_user.c */
827 void			uvm_deallocate(struct vm_map *, vaddr_t, vsize_t);
828 
829 /* uvm_vnode.c */
830 struct uvm_page_array;
831 void			uvm_vnp_setsize(struct vnode *, voff_t);
832 void			uvm_vnp_setwritesize(struct vnode *, voff_t);
833 int			uvn_findpages(struct uvm_object *, voff_t,
834 			    unsigned int *, struct vm_page **,
835 			    struct uvm_page_array *, unsigned int);
836 bool			uvn_text_p(struct uvm_object *);
837 bool			uvn_needs_writefault_p(struct uvm_object *);
838 
839 /* kern_malloc.c */
840 void			kmeminit_nkmempages(void);
841 extern int		nkmempages;
842 
843 #endif /* _KERNEL */
844 
845 #endif /* _UVM_UVM_EXTERN_H_ */
846