uvm_extern.h revision 1.32 1 /* $NetBSD: uvm_extern.h,v 1.32 1999/07/02 23:20:58 thorpej 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 #ifndef _UVM_UVM_EXTERN_H_
38 #define _UVM_UVM_EXTERN_H_
39
40 /*
41 * uvm_extern.h: this file defines the external interface to the VM system.
42 *
43 * this should be the only file included by non-VM parts of the kernel
44 * which need access to VM services. if you want to know the interface
45 * to the MI VM layer without knowing the details, this is the file to
46 * learn.
47 *
48 * NOTE: vm system calls are prototyped in syscallargs.h
49 */
50
51 /*
52 * defines
53 */
54
55 /*
56 * the following defines are for uvm_map and functions which call it.
57 */
58
59 /* protections bits */
60 #define UVM_PROT_MASK 0x07 /* protection mask */
61 #define UVM_PROT_NONE 0x00 /* protection none */
62 #define UVM_PROT_ALL 0x07 /* everything */
63 #define UVM_PROT_READ 0x01 /* read */
64 #define UVM_PROT_WRITE 0x02 /* write */
65 #define UVM_PROT_EXEC 0x04 /* exec */
66
67 /* protection short codes */
68 #define UVM_PROT_R 0x01 /* read */
69 #define UVM_PROT_W 0x02 /* write */
70 #define UVM_PROT_RW 0x03 /* read-write */
71 #define UVM_PROT_X 0x04 /* exec */
72 #define UVM_PROT_RX 0x05 /* read-exec */
73 #define UVM_PROT_WX 0x06 /* write-exec */
74 #define UVM_PROT_RWX 0x07 /* read-write-exec */
75
76 /* 0x08: not used */
77
78 /* inherit codes */
79 #define UVM_INH_MASK 0x30 /* inherit mask */
80 #define UVM_INH_SHARE 0x00 /* "share" */
81 #define UVM_INH_COPY 0x10 /* "copy" */
82 #define UVM_INH_NONE 0x20 /* "none" */
83 #define UVM_INH_DONATE 0x30 /* "donate" << not used */
84
85 /* 0x40, 0x80: not used */
86
87 /* bits 0x700: max protection, 0x800: not used */
88
89 /* bits 0x7000: advice, 0x8000: not used */
90 /* advice: matches MADV_* from sys/mman.h */
91 #define UVM_ADV_NORMAL 0x0 /* 'normal' */
92 #define UVM_ADV_RANDOM 0x1 /* 'random' */
93 #define UVM_ADV_SEQUENTIAL 0x2 /* 'sequential' */
94 /* 0x3: will need, 0x4: dontneed */
95 #define UVM_ADV_MASK 0x7 /* mask */
96
97 /* mapping flags */
98 #define UVM_FLAG_FIXED 0x010000 /* find space */
99 #define UVM_FLAG_OVERLAY 0x020000 /* establish overlay */
100 #define UVM_FLAG_NOMERGE 0x040000 /* don't merge map entries */
101 #define UVM_FLAG_COPYONW 0x080000 /* set copy_on_write flag */
102 #define UVM_FLAG_AMAPPAD 0x100000 /* for bss: pad amap to reduce malloc() */
103 #define UVM_FLAG_TRYLOCK 0x200000 /* fail if we can not lock map */
104
105 /* macros to extract info */
106 #define UVM_PROTECTION(X) ((X) & UVM_PROT_MASK)
107 #define UVM_INHERIT(X) (((X) & UVM_INH_MASK) >> 4)
108 #define UVM_MAXPROTECTION(X) (((X) >> 8) & UVM_PROT_MASK)
109 #define UVM_ADVICE(X) (((X) >> 12) & UVM_ADV_MASK)
110
111 #define UVM_MAPFLAG(PROT,MAXPROT,INH,ADVICE,FLAGS) \
112 ((MAXPROT << 8)|(PROT)|(INH)|((ADVICE) << 12)|(FLAGS))
113
114 /* magic offset value */
115 #define UVM_UNKNOWN_OFFSET ((vaddr_t) -1)
116 /* offset not known(obj) or don't care(!obj) */
117
118 /*
119 * the following defines are for uvm_km_kmemalloc's flags
120 */
121 #define UVM_KMF_NOWAIT 0x1 /* matches M_NOWAIT */
122 #define UVM_KMF_VALLOC 0x2 /* allocate VA only */
123 #define UVM_KMF_TRYLOCK UVM_FLAG_TRYLOCK /* try locking only */
124
125 /*
126 * the following defines the strategies for uvm_pagealloc_strat()
127 */
128 #define UVM_PGA_STRAT_NORMAL 0 /* high -> low free list walk */
129 #define UVM_PGA_STRAT_ONLY 1 /* only specified free list */
130 #define UVM_PGA_STRAT_FALLBACK 2 /* ONLY falls back on NORMAL */
131
132 /*
133 * flags for uvm_pagealloc_strat()
134 */
135 #define UVM_PGA_USERESERVE 0x0001
136
137 /*
138 * structures
139 */
140
141 struct core;
142 struct mount;
143 struct pglist;
144 struct proc;
145 struct ucred;
146 struct uio;
147 struct uvm_object;
148 struct vm_anon;
149 struct vmspace;
150 struct pmap;
151 struct vnode;
152
153 /*
154 * uvmexp: global data structures that are exported to parts of the kernel
155 * other than the vm system.
156 */
157
158 struct uvmexp {
159 /* vm_page constants */
160 int pagesize; /* size of a page (PAGE_SIZE): must be power of 2 */
161 int pagemask; /* page mask */
162 int pageshift; /* page shift */
163
164 /* vm_page counters */
165 int npages; /* number of pages we manage */
166 int free; /* number of free pages */
167 int active; /* number of active pages */
168 int inactive; /* number of pages that we free'd but may want back */
169 int paging; /* number of pages in the process of being paged out */
170 int wired; /* number of wired pages */
171 int reserve_pagedaemon; /* number of pages reserved for pagedaemon */
172 int reserve_kernel; /* number of pages reserved for kernel */
173
174 /* pageout params */
175 int freemin; /* min number of free pages */
176 int freetarg; /* target number of free pages */
177 int inactarg; /* target number of inactive pages */
178 int wiredmax; /* max number of wired pages */
179
180 /* swap */
181 int nswapdev; /* number of configured swap devices in system */
182 int swpages; /* number of PAGE_SIZE'ed swap pages */
183 int swpguniq; /* number of swap pages in use, not also in RAM */
184 int swpginuse; /* number of swap pages in use */
185 int swpgonly; /* number of swap pages in use, not also in RAM */
186 int nswget; /* number of times fault calls uvm_swap_get() */
187 int nanon; /* number total of anon's in system */
188 int nanonneeded;/* number of anons currently needed */
189 int nfreeanon; /* number of free anon's */
190
191 /* stat counters */
192 int faults; /* page fault count */
193 int traps; /* trap count */
194 int intrs; /* interrupt count */
195 int swtch; /* context switch count */
196 int softs; /* software interrupt count */
197 int syscalls; /* system calls */
198 int pageins; /* pagein operation count */
199 /* pageouts are in pdpageouts below */
200 int swapins; /* swapins */
201 int swapouts; /* swapouts */
202 int pgswapin; /* pages swapped in */
203 int pgswapout; /* pages swapped out */
204 int forks; /* forks */
205 int forks_ppwait; /* forks where parent waits */
206 int forks_sharevm; /* forks where vmspace is shared */
207
208 /* fault subcounters */
209 int fltnoram; /* number of times fault was out of ram */
210 int fltnoanon; /* number of times fault was out of anons */
211 int fltpgwait; /* number of times fault had to wait on a page */
212 int fltpgrele; /* number of times fault found a released page */
213 int fltrelck; /* number of times fault relock called */
214 int fltrelckok; /* number of times fault relock is a success */
215 int fltanget; /* number of times fault gets anon page */
216 int fltanretry; /* number of times fault retrys an anon get */
217 int fltamcopy; /* number of times fault clears "needs copy" */
218 int fltnamap; /* number of times fault maps a neighbor anon page */
219 int fltnomap; /* number of times fault maps a neighbor obj page */
220 int fltlget; /* number of times fault does a locked pgo_get */
221 int fltget; /* number of times fault does an unlocked get */
222 int flt_anon; /* number of times fault anon (case 1a) */
223 int flt_acow; /* number of times fault anon cow (case 1b) */
224 int flt_obj; /* number of times fault is on object page (2a) */
225 int flt_prcopy; /* number of times fault promotes with copy (2b) */
226 int flt_przero; /* number of times fault promotes with zerofill (2b) */
227
228 /* daemon counters */
229 int pdwoke; /* number of times daemon woke up */
230 int pdrevs; /* number of times daemon rev'd clock hand */
231 int pdswout; /* number of times daemon called for swapout */
232 int pdfreed; /* number of pages daemon freed since boot */
233 int pdscans; /* number of pages daemon scaned since boot */
234 int pdanscan; /* number of anonymous pages scanned by daemon */
235 int pdobscan; /* number of object pages scanned by daemon */
236 int pdreact; /* number of pages daemon reactivated since boot */
237 int pdbusy; /* number of times daemon found a busy page */
238 int pdpageouts; /* number of times daemon started a pageout */
239 int pdpending; /* number of times daemon got a pending pagout */
240 int pddeact; /* number of pages daemon deactivates */
241
242 /* kernel memory objects: managed by uvm_km_kmemalloc() only! */
243 struct uvm_object *kmem_object;
244 struct uvm_object *mb_object;
245 };
246
247 #ifdef _KERNEL
248
249 extern struct uvmexp uvmexp;
250
251 /*
252 * macros
253 */
254
255 /* zalloc zeros memory, alloc does not */
256 #define uvm_km_zalloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,TRUE)
257 #define uvm_km_alloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,FALSE)
258
259 #endif /* _KERNEL */
260
261 /*
262 * typedefs
263 */
264
265 typedef unsigned int uvm_flag_t;
266 typedef int vm_fault_t;
267
268 #ifdef _KERNEL
269
270 /* uvm_aobj.c */
271 struct uvm_object *uao_create __P((vsize_t, int));
272 void uao_detach __P((struct uvm_object *));
273 void uao_reference __P((struct uvm_object *));
274
275 /* uvm_fault.c */
276 int uvm_fault __P((vm_map_t, vaddr_t,
277 vm_fault_t, vm_prot_t));
278 /* handle a page fault */
279
280 /* uvm_glue.c */
281 #if defined(KGDB)
282 void uvm_chgkprot __P((caddr_t, size_t, int));
283 #endif
284 void uvm_fork __P((struct proc *, struct proc *, boolean_t,
285 void *, size_t));
286 void uvm_exit __P((struct proc *));
287 void uvm_init_limits __P((struct proc *));
288 boolean_t uvm_kernacc __P((caddr_t, size_t, int));
289 __dead void uvm_scheduler __P((void)) __attribute__((noreturn));
290 void uvm_swapin __P((struct proc *));
291 boolean_t uvm_useracc __P((caddr_t, size_t, int));
292 int uvm_vslock __P((struct proc *, caddr_t, size_t,
293 vm_prot_t));
294 void uvm_vsunlock __P((struct proc *, caddr_t, size_t));
295
296
297 /* uvm_init.c */
298 void uvm_init __P((void));
299 /* init the uvm system */
300
301 /* uvm_io.c */
302 int uvm_io __P((vm_map_t, struct uio *));
303
304 /* uvm_km.c */
305 vaddr_t uvm_km_alloc1 __P((vm_map_t, vsize_t, boolean_t));
306 void uvm_km_free __P((vm_map_t, vaddr_t, vsize_t));
307 void uvm_km_free_wakeup __P((vm_map_t, vaddr_t,
308 vsize_t));
309 vaddr_t uvm_km_kmemalloc __P((vm_map_t, struct uvm_object *,
310 vsize_t, int));
311 struct vm_map *uvm_km_suballoc __P((vm_map_t, vaddr_t *,
312 vaddr_t *, vsize_t, int,
313 boolean_t, vm_map_t));
314 vaddr_t uvm_km_valloc __P((vm_map_t, vsize_t));
315 vaddr_t uvm_km_valloc_wait __P((vm_map_t, vsize_t));
316 vaddr_t uvm_km_alloc_poolpage1 __P((vm_map_t,
317 struct uvm_object *, boolean_t));
318 void uvm_km_free_poolpage1 __P((vm_map_t, vaddr_t));
319
320 #define uvm_km_alloc_poolpage(waitok) uvm_km_alloc_poolpage1(kmem_map, \
321 uvmexp.kmem_object, (waitok))
322 #define uvm_km_free_poolpage(addr) uvm_km_free_poolpage1(kmem_map, (addr))
323
324 /* uvm_map.c */
325 int uvm_map __P((vm_map_t, vaddr_t *, vsize_t,
326 struct uvm_object *, vaddr_t, uvm_flag_t));
327 int uvm_map_pageable __P((vm_map_t, vaddr_t,
328 vaddr_t, boolean_t, boolean_t));
329 int uvm_map_pageable_all __P((vm_map_t, int, vsize_t));
330 boolean_t uvm_map_checkprot __P((vm_map_t, vaddr_t,
331 vaddr_t, vm_prot_t));
332 int uvm_map_protect __P((vm_map_t, vaddr_t,
333 vaddr_t, vm_prot_t, boolean_t));
334 struct vmspace *uvmspace_alloc __P((vaddr_t, vaddr_t,
335 boolean_t));
336 void uvmspace_init __P((struct vmspace *, struct pmap *,
337 vaddr_t, vaddr_t, boolean_t));
338 void uvmspace_exec __P((struct proc *));
339 struct vmspace *uvmspace_fork __P((struct vmspace *));
340 void uvmspace_free __P((struct vmspace *));
341 void uvmspace_share __P((struct proc *, struct proc *));
342 void uvmspace_unshare __P((struct proc *));
343
344
345 /* uvm_meter.c */
346 void uvm_meter __P((void));
347 int uvm_sysctl __P((int *, u_int, void *, size_t *,
348 void *, size_t, struct proc *));
349
350 /* uvm_mmap.c */
351 int uvm_mmap __P((vm_map_t, vaddr_t *, vsize_t,
352 vm_prot_t, vm_prot_t, int,
353 caddr_t, vaddr_t, vsize_t));
354
355 /* uvm_page.c */
356 struct vm_page *uvm_pagealloc_strat __P((struct uvm_object *,
357 vaddr_t, struct vm_anon *, int, int, int));
358 #define uvm_pagealloc(obj, off, anon, flags) \
359 uvm_pagealloc_strat((obj), (off), (anon), (flags), \
360 UVM_PGA_STRAT_NORMAL, 0)
361 void uvm_pagerealloc __P((struct vm_page *,
362 struct uvm_object *, vaddr_t));
363 /* Actually, uvm_page_physload takes PF#s which need their own type */
364 void uvm_page_physload __P((vaddr_t, vaddr_t,
365 vaddr_t, vaddr_t, int));
366 void uvm_setpagesize __P((void));
367
368 /* uvm_pdaemon.c */
369 void uvm_pageout __P((void));
370
371 /* uvm_pglist.c */
372 int uvm_pglistalloc __P((psize_t, paddr_t,
373 paddr_t, paddr_t, paddr_t,
374 struct pglist *, int, int));
375 void uvm_pglistfree __P((struct pglist *));
376
377 /* uvm_swap.c */
378 void uvm_swap_init __P((void));
379
380 /* uvm_unix.c */
381 int uvm_coredump __P((struct proc *, struct vnode *,
382 struct ucred *, struct core *));
383 int uvm_grow __P((struct proc *, vaddr_t));
384
385 /* uvm_user.c */
386 int uvm_deallocate __P((vm_map_t, vaddr_t, vsize_t));
387
388 /* uvm_vnode.c */
389 void uvm_vnp_setsize __P((struct vnode *, u_quad_t));
390 void uvm_vnp_sync __P((struct mount *));
391 void uvm_vnp_terminate __P((struct vnode *));
392 /* terminate a uvm/uvn object */
393 boolean_t uvm_vnp_uncache __P((struct vnode *));
394 struct uvm_object *uvn_attach __P((void *, vm_prot_t));
395
396 #endif /* _KERNEL */
397
398 #endif /* _UVM_UVM_EXTERN_H_ */
399