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