uvm_extern.h revision 1.40
1/* $NetBSD: uvm_extern.h,v 1.40 2000/04/24 17:12:00 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 ((voff_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 /* ok to use reserve pages */ 136#define UVM_PGA_ZERO 0x0002 /* returned page must be zero'd */ 137 138/* 139 * lockflags that control the locking behavior of various functions. 140 */ 141#define UVM_LK_ENTER 0x00000001 /* map locked on entry */ 142#define UVM_LK_EXIT 0x00000002 /* leave map locked on exit */ 143 144/* 145 * structures 146 */ 147 148struct core; 149struct mount; 150struct pglist; 151struct proc; 152struct ucred; 153struct uio; 154struct uvm_object; 155struct vm_anon; 156struct vmspace; 157struct pmap; 158struct vnode; 159struct simplelock; 160 161/* 162 * uvmexp: global data structures that are exported to parts of the kernel 163 * other than the vm system. 164 */ 165 166struct uvmexp { 167 /* vm_page constants */ 168 int pagesize; /* size of a page (PAGE_SIZE): must be power of 2 */ 169 int pagemask; /* page mask */ 170 int pageshift; /* page shift */ 171 172 /* vm_page counters */ 173 int npages; /* number of pages we manage */ 174 int free; /* number of free pages */ 175 int active; /* number of active pages */ 176 int inactive; /* number of pages that we free'd but may want back */ 177 int paging; /* number of pages in the process of being paged out */ 178 int wired; /* number of wired pages */ 179 int zeropages; /* number of zero'd pages */ 180 int reserve_pagedaemon; /* number of pages reserved for pagedaemon */ 181 int reserve_kernel; /* number of pages reserved for kernel */ 182 183 /* pageout params */ 184 int freemin; /* min number of free pages */ 185 int freetarg; /* target number of free pages */ 186 int inactarg; /* target number of inactive pages */ 187 int wiredmax; /* max number of wired pages */ 188 189 /* swap */ 190 int nswapdev; /* number of configured swap devices in system */ 191 int swpages; /* number of PAGE_SIZE'ed swap pages */ 192 int swpguniq; /* number of swap pages in use, not also in RAM */ 193 int swpginuse; /* number of swap pages in use */ 194 int swpgonly; /* number of swap pages in use, not also in RAM */ 195 int nswget; /* number of times fault calls uvm_swap_get() */ 196 int nanon; /* number total of anon's in system */ 197 int nanonneeded;/* number of anons currently needed */ 198 int nfreeanon; /* number of free anon's */ 199 200 /* stat counters */ 201 int faults; /* page fault count */ 202 int traps; /* trap count */ 203 int intrs; /* interrupt count */ 204 int swtch; /* context switch count */ 205 int softs; /* software interrupt count */ 206 int syscalls; /* system calls */ 207 int pageins; /* pagein operation count */ 208 /* pageouts are in pdpageouts below */ 209 int swapins; /* swapins */ 210 int swapouts; /* swapouts */ 211 int pgswapin; /* pages swapped in */ 212 int pgswapout; /* pages swapped out */ 213 int forks; /* forks */ 214 int forks_ppwait; /* forks where parent waits */ 215 int forks_sharevm; /* forks where vmspace is shared */ 216 int pga_zerohit; /* pagealloc where zero wanted and zero 217 was available */ 218 int pga_zeromiss; /* pagealloc where zero wanted and zero 219 not available */ 220 221 /* fault subcounters */ 222 int fltnoram; /* number of times fault was out of ram */ 223 int fltnoanon; /* number of times fault was out of anons */ 224 int fltpgwait; /* number of times fault had to wait on a page */ 225 int fltpgrele; /* number of times fault found a released page */ 226 int fltrelck; /* number of times fault relock called */ 227 int fltrelckok; /* number of times fault relock is a success */ 228 int fltanget; /* number of times fault gets anon page */ 229 int fltanretry; /* number of times fault retrys an anon get */ 230 int fltamcopy; /* number of times fault clears "needs copy" */ 231 int fltnamap; /* number of times fault maps a neighbor anon page */ 232 int fltnomap; /* number of times fault maps a neighbor obj page */ 233 int fltlget; /* number of times fault does a locked pgo_get */ 234 int fltget; /* number of times fault does an unlocked get */ 235 int flt_anon; /* number of times fault anon (case 1a) */ 236 int flt_acow; /* number of times fault anon cow (case 1b) */ 237 int flt_obj; /* number of times fault is on object page (2a) */ 238 int flt_prcopy; /* number of times fault promotes with copy (2b) */ 239 int flt_przero; /* number of times fault promotes with zerofill (2b) */ 240 241 /* daemon counters */ 242 int pdwoke; /* number of times daemon woke up */ 243 int pdrevs; /* number of times daemon rev'd clock hand */ 244 int pdswout; /* number of times daemon called for swapout */ 245 int pdfreed; /* number of pages daemon freed since boot */ 246 int pdscans; /* number of pages daemon scaned since boot */ 247 int pdanscan; /* number of anonymous pages scanned by daemon */ 248 int pdobscan; /* number of object pages scanned by daemon */ 249 int pdreact; /* number of pages daemon reactivated since boot */ 250 int pdbusy; /* number of times daemon found a busy page */ 251 int pdpageouts; /* number of times daemon started a pageout */ 252 int pdpending; /* number of times daemon got a pending pagout */ 253 int pddeact; /* number of pages daemon deactivates */ 254 255 /* kernel memory objects: managed by uvm_km_kmemalloc() only! */ 256 struct uvm_object *kmem_object; 257 struct uvm_object *mb_object; 258}; 259 260#ifdef _KERNEL 261 262extern struct uvmexp uvmexp; 263 264/* 265 * macros 266 */ 267 268/* zalloc zeros memory, alloc does not */ 269#define uvm_km_zalloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,TRUE) 270#define uvm_km_alloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,FALSE) 271 272#endif /* _KERNEL */ 273 274/* 275 * typedefs 276 */ 277 278typedef unsigned int uvm_flag_t; 279typedef int vm_fault_t; 280 281#ifdef _KERNEL 282 283/* uvm_aobj.c */ 284struct uvm_object *uao_create __P((vsize_t, int)); 285void uao_detach __P((struct uvm_object *)); 286void uao_detach_locked __P((struct uvm_object *)); 287void uao_reference __P((struct uvm_object *)); 288void uao_reference_locked __P((struct uvm_object *)); 289 290/* uvm_fault.c */ 291int uvm_fault __P((vm_map_t, vaddr_t, 292 vm_fault_t, vm_prot_t)); 293 /* handle a page fault */ 294 295/* uvm_glue.c */ 296#if defined(KGDB) 297void uvm_chgkprot __P((caddr_t, size_t, int)); 298#endif 299void uvm_sleep __P((void *, struct simplelock *, boolean_t, 300 const char *, int)); 301void uvm_fork __P((struct proc *, struct proc *, boolean_t, 302 void *, size_t)); 303void uvm_exit __P((struct proc *)); 304void uvm_init_limits __P((struct proc *)); 305boolean_t uvm_kernacc __P((caddr_t, size_t, int)); 306__dead void uvm_scheduler __P((void)) __attribute__((noreturn)); 307void uvm_swapin __P((struct proc *)); 308boolean_t uvm_useracc __P((caddr_t, size_t, int)); 309int uvm_vslock __P((struct proc *, caddr_t, size_t, 310 vm_prot_t)); 311void uvm_vsunlock __P((struct proc *, caddr_t, size_t)); 312 313 314/* uvm_init.c */ 315void uvm_init __P((void)); 316 /* init the uvm system */ 317 318/* uvm_io.c */ 319int uvm_io __P((vm_map_t, struct uio *)); 320 321/* uvm_km.c */ 322vaddr_t uvm_km_alloc1 __P((vm_map_t, vsize_t, boolean_t)); 323void uvm_km_free __P((vm_map_t, vaddr_t, vsize_t)); 324void uvm_km_free_wakeup __P((vm_map_t, vaddr_t, 325 vsize_t)); 326vaddr_t uvm_km_kmemalloc __P((vm_map_t, struct uvm_object *, 327 vsize_t, int)); 328struct vm_map *uvm_km_suballoc __P((vm_map_t, vaddr_t *, 329 vaddr_t *, vsize_t, int, 330 boolean_t, vm_map_t)); 331vaddr_t uvm_km_valloc __P((vm_map_t, vsize_t)); 332vaddr_t uvm_km_valloc_wait __P((vm_map_t, vsize_t)); 333vaddr_t uvm_km_alloc_poolpage1 __P((vm_map_t, 334 struct uvm_object *, boolean_t)); 335void uvm_km_free_poolpage1 __P((vm_map_t, vaddr_t)); 336 337#define uvm_km_alloc_poolpage(waitok) uvm_km_alloc_poolpage1(kmem_map, \ 338 uvmexp.kmem_object, (waitok)) 339#define uvm_km_free_poolpage(addr) uvm_km_free_poolpage1(kmem_map, (addr)) 340 341/* uvm_map.c */ 342int uvm_map __P((vm_map_t, vaddr_t *, vsize_t, 343 struct uvm_object *, voff_t, uvm_flag_t)); 344int uvm_map_pageable __P((vm_map_t, vaddr_t, 345 vaddr_t, boolean_t, int)); 346int uvm_map_pageable_all __P((vm_map_t, int, vsize_t)); 347boolean_t uvm_map_checkprot __P((vm_map_t, vaddr_t, 348 vaddr_t, vm_prot_t)); 349int uvm_map_protect __P((vm_map_t, vaddr_t, 350 vaddr_t, vm_prot_t, boolean_t)); 351struct vmspace *uvmspace_alloc __P((vaddr_t, vaddr_t, 352 boolean_t)); 353void uvmspace_init __P((struct vmspace *, struct pmap *, 354 vaddr_t, vaddr_t, boolean_t)); 355void uvmspace_exec __P((struct proc *)); 356struct vmspace *uvmspace_fork __P((struct vmspace *)); 357void uvmspace_free __P((struct vmspace *)); 358void uvmspace_share __P((struct proc *, struct proc *)); 359void uvmspace_unshare __P((struct proc *)); 360 361 362/* uvm_meter.c */ 363void uvm_meter __P((void)); 364int uvm_sysctl __P((int *, u_int, void *, size_t *, 365 void *, size_t, struct proc *)); 366 367/* uvm_mmap.c */ 368int uvm_mmap __P((vm_map_t, vaddr_t *, vsize_t, 369 vm_prot_t, vm_prot_t, int, 370 caddr_t, voff_t, vsize_t)); 371 372/* uvm_page.c */ 373struct vm_page *uvm_pagealloc_strat __P((struct uvm_object *, 374 voff_t, struct vm_anon *, int, int, int)); 375#define uvm_pagealloc(obj, off, anon, flags) \ 376 uvm_pagealloc_strat((obj), (off), (anon), (flags), \ 377 UVM_PGA_STRAT_NORMAL, 0) 378void uvm_pagerealloc __P((struct vm_page *, 379 struct uvm_object *, voff_t)); 380/* Actually, uvm_page_physload takes PF#s which need their own type */ 381void uvm_page_physload __P((paddr_t, paddr_t, 382 paddr_t, paddr_t, int)); 383void uvm_setpagesize __P((void)); 384 385/* uvm_pdaemon.c */ 386void uvm_pageout __P((void)); 387 388/* uvm_pglist.c */ 389int uvm_pglistalloc __P((psize_t, paddr_t, 390 paddr_t, paddr_t, paddr_t, 391 struct pglist *, int, int)); 392void uvm_pglistfree __P((struct pglist *)); 393 394/* uvm_swap.c */ 395void uvm_swap_init __P((void)); 396 397/* uvm_unix.c */ 398int uvm_coredump __P((struct proc *, struct vnode *, 399 struct ucred *, struct core *)); 400int uvm_grow __P((struct proc *, vaddr_t)); 401/* should only be needed if COMPAT_NETBSD32 is defined */ 402struct core32; 403int uvm_coredump32 __P((struct proc *, struct vnode *, 404 struct ucred *, struct core32 *)); 405 406/* uvm_user.c */ 407int uvm_deallocate __P((vm_map_t, vaddr_t, vsize_t)); 408 409/* uvm_vnode.c */ 410void uvm_vnp_setsize __P((struct vnode *, voff_t)); 411void uvm_vnp_sync __P((struct mount *)); 412void uvm_vnp_terminate __P((struct vnode *)); 413 /* terminate a uvm/uvn object */ 414boolean_t uvm_vnp_uncache __P((struct vnode *)); 415struct uvm_object *uvn_attach __P((void *, vm_prot_t)); 416 417/* kern_malloc.c */ 418void kmeminit_nkmempages __P((void)); 419void kmeminit __P((void)); 420extern int nkmempages; 421 422#endif /* _KERNEL */ 423 424#endif /* _UVM_UVM_EXTERN_H_ */ 425