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