1 /* $OpenBSD: uvm_extern.h,v 1.167 2023/02/16 04:42:07 deraadt Exp $ */ 2 /* $NetBSD: uvm_extern.h,v 1.57 2001/03/09 01:02:12 chs Exp $ */ 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 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /*- 30 * Copyright (c) 1991, 1992, 1993 31 * The Regents of the University of California. All rights reserved. 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 1. Redistributions of source code must retain the above copyright 37 * notice, this list of conditions and the following disclaimer. 38 * 2. Redistributions in binary form must reproduce the above copyright 39 * notice, this list of conditions and the following disclaimer in the 40 * documentation and/or other materials provided with the distribution. 41 * 3. Neither the name of the University nor the names of its contributors 42 * may be used to endorse or promote products derived from this software 43 * without specific prior written permission. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 48 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 55 * SUCH DAMAGE. 56 * 57 * @(#)vm_extern.h 8.5 (Berkeley) 5/3/95 58 */ 59 60 #ifndef _UVM_UVM_EXTERN_H_ 61 #define _UVM_UVM_EXTERN_H_ 62 63 typedef int vm_fault_t; 64 65 typedef int vm_inherit_t; /* XXX: inheritance codes */ 66 typedef off_t voff_t; /* XXX: offset within a uvm_object */ 67 68 struct vm_map_entry; 69 typedef struct vm_map_entry *vm_map_entry_t; 70 71 struct vm_map; 72 typedef struct vm_map *vm_map_t; 73 74 struct vm_page; 75 typedef struct vm_page *vm_page_t; 76 77 /* 78 * Bit assignments assigned by UVM_MAPFLAG() and extracted by 79 * UVM_{PROTECTION,INHERIT,MAXPROTECTION,ADVICE}(): 80 * bits 0-2 protection 81 * bit 3 unused 82 * bits 4-5 inheritance 83 * bits 6-7 unused 84 * bits 8-10 max protection 85 * bit 11 unused 86 * bits 12-14 advice 87 * bit 15 unused 88 * bits 16-N flags 89 */ 90 91 /* protections bits */ 92 #define PROT_MASK (PROT_READ | PROT_WRITE | PROT_EXEC) 93 94 /* inherit codes */ 95 #define MAP_INHERIT_MASK 0x3 /* inherit mask */ 96 97 typedef int vm_prot_t; 98 99 #define MADV_MASK 0x7 /* mask */ 100 101 /* mapping flags */ 102 #define UVM_FLAG_FIXED 0x0010000 /* find space */ 103 #define UVM_FLAG_OVERLAY 0x0020000 /* establish overlay */ 104 #define UVM_FLAG_NOMERGE 0x0040000 /* don't merge map entries */ 105 #define UVM_FLAG_COPYONW 0x0080000 /* set copy_on_write flag */ 106 #define UVM_FLAG_TRYLOCK 0x0100000 /* fail if we can not lock map */ 107 #define UVM_FLAG_HOLE 0x0200000 /* no backend */ 108 #define UVM_FLAG_QUERY 0x0400000 /* do everything, except actual execution */ 109 #define UVM_FLAG_NOFAULT 0x0800000 /* don't fault */ 110 #define UVM_FLAG_UNMAP 0x1000000 /* unmap to make space */ 111 #define UVM_FLAG_STACK 0x2000000 /* page may contain a stack */ 112 #define UVM_FLAG_WC 0x4000000 /* write combining */ 113 #define UVM_FLAG_CONCEAL 0x8000000 /* omit from dumps */ 114 #define UVM_FLAG_SYSCALL 0x10000000 /* system calls allowed */ 115 #define UVM_FLAG_SIGALTSTACK 0x20000000 /* sigaltstack validation required */ 116 117 /* macros to extract info */ 118 #define UVM_PROTECTION(X) ((X) & PROT_MASK) 119 #define UVM_INHERIT(X) (((X) >> 4) & MAP_INHERIT_MASK) 120 #define UVM_MAXPROTECTION(X) (((X) >> 8) & PROT_MASK) 121 #define UVM_ADVICE(X) (((X) >> 12) & MADV_MASK) 122 123 #define UVM_MAPFLAG(prot, maxprot, inh, advice, flags) \ 124 ((prot) | ((maxprot) << 8) | ((inh) << 4) | ((advice) << 12) | (flags)) 125 126 /* magic offset value */ 127 #define UVM_UNKNOWN_OFFSET ((voff_t) -1) 128 /* offset not known(obj) or don't care(!obj) */ 129 130 /* 131 * the following defines are for uvm_km_kmemalloc's flags 132 */ 133 #define UVM_KMF_NOWAIT 0x1 /* matches M_NOWAIT */ 134 #define UVM_KMF_VALLOC 0x2 /* allocate VA only */ 135 #define UVM_KMF_CANFAIL 0x4 /* caller handles failure */ 136 #define UVM_KMF_ZERO 0x08 /* zero pages */ 137 #define UVM_KMF_TRYLOCK UVM_FLAG_TRYLOCK /* try locking only */ 138 139 /* 140 * flags for uvm_pagealloc() 141 */ 142 #define UVM_PGA_USERESERVE 0x0001 /* ok to use reserve pages */ 143 #define UVM_PGA_ZERO 0x0002 /* returned page must be zeroed */ 144 145 /* 146 * flags for uvm_pglistalloc() also used by uvm_pmr_getpages() 147 */ 148 #define UVM_PLA_WAITOK 0x0001 /* may sleep */ 149 #define UVM_PLA_NOWAIT 0x0002 /* can't sleep (need one of the two) */ 150 #define UVM_PLA_ZERO 0x0004 /* zero all pages before returning */ 151 #define UVM_PLA_TRYCONTIG 0x0008 /* try to allocate contig physmem */ 152 #define UVM_PLA_FAILOK 0x0010 /* caller can handle failure */ 153 #define UVM_PLA_NOWAKE 0x0020 /* don't wake page daemon on failure */ 154 #define UVM_PLA_USERESERVE 0x0040 /* can allocate from kernel reserve */ 155 156 /* 157 * lockflags that control the locking behavior of various functions. 158 */ 159 #define UVM_LK_ENTER 0x00000001 /* map locked on entry */ 160 #define UVM_LK_EXIT 0x00000002 /* leave map locked on exit */ 161 162 /* 163 * flags to uvm_page_physload. 164 */ 165 #define PHYSLOAD_DEVICE 0x01 /* don't add to the page queue */ 166 167 #include <sys/queue.h> 168 #include <sys/tree.h> 169 #include <sys/mman.h> 170 171 #ifdef _KERNEL 172 struct buf; 173 struct mount; 174 struct pglist; 175 struct vmspace; 176 struct pmap; 177 #endif 178 179 #include <uvm/uvm_param.h> 180 181 #include <uvm/uvm_pmap.h> 182 #include <uvm/uvm_object.h> 183 #include <uvm/uvm_page.h> 184 #include <uvm/uvm_map.h> 185 186 #ifdef _KERNEL 187 #include <uvm/uvm_fault.h> 188 #include <uvm/uvm_pager.h> 189 #endif 190 191 /* 192 * Shareable process virtual address space. 193 * May eventually be merged with vm_map. 194 * Several fields are temporary (text, data stuff). 195 * 196 * Locks used to protect struct members in this file: 197 * K kernel lock 198 * I immutable after creation 199 * v vm_map's lock 200 */ 201 struct vmspace { 202 struct vm_map vm_map; /* VM address map */ 203 int vm_refcnt; /* [K] number of references */ 204 caddr_t vm_shm; /* SYS5 shared memory private data XXX */ 205 /* we copy from vm_startcopy to the end of the structure on fork */ 206 #define vm_startcopy vm_rssize 207 segsz_t vm_rssize; /* current resident set size in pages */ 208 segsz_t vm_swrss; /* resident set size before last swap */ 209 segsz_t vm_tsize; /* text size (pages) XXX */ 210 segsz_t vm_dsize; /* data size (pages) XXX */ 211 segsz_t vm_dused; /* data segment length (pages) XXX */ 212 segsz_t vm_ssize; /* [v] stack size (pages) */ 213 caddr_t vm_taddr; /* [I] user virtual address of text */ 214 caddr_t vm_daddr; /* [I] user virtual address of data */ 215 caddr_t vm_maxsaddr; /* [I] user VA at max stack growth */ 216 caddr_t vm_minsaddr; /* [I] user VA at top of stack */ 217 vaddr_t vm_execve; /* [v] execve systemcall stub region */ 218 vaddr_t vm_execve_end; /* [v] execve systemcall stub region */ 219 }; 220 221 /* 222 * uvm_constraint_range's: 223 * MD code is allowed to setup constraint ranges for memory allocators, the 224 * primary use for this is to keep allocation for certain memory consumers 225 * such as mbuf pools within address ranges that are reachable by devices 226 * that perform DMA. 227 * 228 * It is also to discourge memory allocations from being satisfied from ranges 229 * such as the ISA memory range, if they can be satisfied with allocation 230 * from other ranges. 231 * 232 * the MD ranges are defined in arch/ARCH/ARCH/machdep.c 233 */ 234 struct uvm_constraint_range { 235 paddr_t ucr_low; 236 paddr_t ucr_high; 237 }; 238 239 #ifdef _KERNEL 240 241 #include <uvm/uvmexp.h> 242 extern struct uvmexp uvmexp; 243 244 /* Constraint ranges, set by MD code. */ 245 extern struct uvm_constraint_range isa_constraint; 246 extern struct uvm_constraint_range dma_constraint; 247 extern struct uvm_constraint_range no_constraint; 248 extern struct uvm_constraint_range *uvm_md_constraints[]; 249 250 /* 251 * the various kernel maps, owned by MD code 252 */ 253 extern struct vm_map *exec_map; 254 extern struct vm_map *kernel_map; 255 extern struct vm_map *kmem_map; 256 extern struct vm_map *phys_map; 257 258 /* base of kernel virtual memory */ 259 extern vaddr_t vm_min_kernel_address; 260 261 /* zalloc zeros memory, alloc does not */ 262 #define uvm_km_zalloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,0,TRUE) 263 #define uvm_km_alloc(MAP,SIZE) uvm_km_alloc1(MAP,SIZE,0,FALSE) 264 265 #define vm_resident_count(vm) (pmap_resident_count((vm)->vm_map.pmap)) 266 267 struct plimit; 268 269 void vmapbuf(struct buf *, vsize_t); 270 void vunmapbuf(struct buf *, vsize_t); 271 struct uvm_object *uao_create(vsize_t, int); 272 void uao_detach(struct uvm_object *); 273 void uao_reference(struct uvm_object *); 274 int uvm_fault(vm_map_t, vaddr_t, vm_fault_t, vm_prot_t); 275 276 vaddr_t uvm_uarea_alloc(void); 277 void uvm_uarea_free(struct proc *); 278 void uvm_exit(struct process *); 279 void uvm_init_limits(struct plimit *); 280 boolean_t uvm_kernacc(caddr_t, size_t, int); 281 282 int uvm_vslock(struct proc *, caddr_t, size_t, 283 vm_prot_t); 284 void uvm_vsunlock(struct proc *, caddr_t, size_t); 285 int uvm_vslock_device(struct proc *, void *, size_t, 286 vm_prot_t, void **); 287 void uvm_vsunlock_device(struct proc *, void *, size_t, 288 void *); 289 void uvm_pause(void); 290 void uvm_init(void); 291 void uvm_init_percpu(void); 292 int uvm_io(vm_map_t, struct uio *, int); 293 294 #define UVM_IO_FIXPROT 0x01 295 296 vaddr_t uvm_km_alloc1(vm_map_t, vsize_t, vsize_t, boolean_t); 297 void uvm_km_free(vm_map_t, vaddr_t, vsize_t); 298 vaddr_t uvm_km_kmemalloc_pla(struct vm_map *, 299 struct uvm_object *, vsize_t, vsize_t, int, 300 paddr_t, paddr_t, paddr_t, paddr_t, int); 301 #define uvm_km_kmemalloc(map, obj, sz, flags) \ 302 uvm_km_kmemalloc_pla(map, obj, sz, 0, flags, 0, (paddr_t)-1, 0, 0, 0) 303 struct vm_map *uvm_km_suballoc(vm_map_t, vaddr_t *, vaddr_t *, 304 vsize_t, int, boolean_t, vm_map_t); 305 /* 306 * Allocation mode for virtual space. 307 * 308 * kv_map - pointer to the pointer to the map we're allocating from. 309 * kv_align - alignment. 310 * kv_wait - wait for free space in the map if it's full. The default 311 * allocators don't wait since running out of space in kernel_map and 312 * kmem_map is usually fatal. Special maps like exec_map are specifically 313 * limited, so waiting for space in them is necessary. 314 * kv_singlepage - use the single page allocator. 315 * kv_executable - map the physical pages with PROT_EXEC. 316 */ 317 struct kmem_va_mode { 318 struct vm_map **kv_map; 319 vsize_t kv_align; 320 char kv_wait; 321 char kv_singlepage; 322 }; 323 324 /* 325 * Allocation mode for physical pages. 326 * 327 * kp_constraint - allocation constraint for physical pages. 328 * kp_object - if the pages should be allocated from an object. 329 * kp_align - physical alignment of the first page in the allocation. 330 * kp_boundary - boundary that the physical addresses can't cross if 331 * the allocation is contiguous. 332 * kp_nomem - don't allocate any backing pages. 333 * kp_maxseg - maximal amount of contiguous segments. 334 * kp_zero - zero the returned memory. 335 * kp_pageable - allocate pageable memory. 336 */ 337 struct kmem_pa_mode { 338 struct uvm_constraint_range *kp_constraint; 339 struct uvm_object **kp_object; 340 paddr_t kp_align; 341 paddr_t kp_boundary; 342 int kp_maxseg; 343 char kp_nomem; 344 char kp_zero; 345 char kp_pageable; 346 }; 347 348 /* 349 * Dynamic allocation parameters. Stuff that changes too often or too much 350 * to create separate va and pa modes for. 351 * 352 * kd_waitok - is it ok to sleep? 353 * kd_trylock - don't sleep on map locks. 354 * kd_prefer - offset to feed to PMAP_PREFER 355 * kd_slowdown - special parameter for the singlepage va allocator 356 * that tells the caller to sleep if possible to let the singlepage 357 * allocator catch up. 358 */ 359 struct kmem_dyn_mode { 360 voff_t kd_prefer; 361 int *kd_slowdown; 362 char kd_waitok; 363 char kd_trylock; 364 }; 365 366 #define KMEM_DYN_INITIALIZER { UVM_UNKNOWN_OFFSET, NULL, 0, 0 } 367 368 /* 369 * Notice that for kv_ waiting has a different meaning. It's only supposed 370 * to be used for very space constrained maps where waiting is a way 371 * to throttle some other operation. 372 * The exception is kv_page which needs to wait relatively often. 373 * All kv_ except kv_intrsafe will potentially sleep. 374 */ 375 extern const struct kmem_va_mode kv_any; 376 extern const struct kmem_va_mode kv_intrsafe; 377 extern const struct kmem_va_mode kv_page; 378 379 extern const struct kmem_pa_mode kp_dirty; 380 extern const struct kmem_pa_mode kp_zero; 381 extern const struct kmem_pa_mode kp_dma; 382 extern const struct kmem_pa_mode kp_dma_contig; 383 extern const struct kmem_pa_mode kp_dma_zero; 384 extern const struct kmem_pa_mode kp_pageable; 385 extern const struct kmem_pa_mode kp_none; 386 387 extern const struct kmem_dyn_mode kd_waitok; 388 extern const struct kmem_dyn_mode kd_nowait; 389 extern const struct kmem_dyn_mode kd_trylock; 390 391 void *km_alloc(size_t, const struct kmem_va_mode *, 392 const struct kmem_pa_mode *, 393 const struct kmem_dyn_mode *); 394 void km_free(void *, size_t, const struct kmem_va_mode *, 395 const struct kmem_pa_mode *); 396 int uvm_map(vm_map_t, vaddr_t *, vsize_t, 397 struct uvm_object *, voff_t, vsize_t, unsigned int); 398 int uvm_mapanon(vm_map_t, vaddr_t *, vsize_t, vsize_t, unsigned int); 399 int uvm_map_pageable(vm_map_t, vaddr_t, 400 vaddr_t, boolean_t, int); 401 int uvm_map_pageable_all(vm_map_t, int, vsize_t); 402 boolean_t uvm_map_checkprot(vm_map_t, vaddr_t, 403 vaddr_t, vm_prot_t); 404 int uvm_map_protect(vm_map_t, vaddr_t, 405 vaddr_t, vm_prot_t, int etype, boolean_t, boolean_t); 406 struct vmspace *uvmspace_alloc(vaddr_t, vaddr_t, 407 boolean_t, boolean_t); 408 void uvmspace_init(struct vmspace *, struct pmap *, 409 vaddr_t, vaddr_t, boolean_t, boolean_t); 410 void uvmspace_exec(struct proc *, vaddr_t, vaddr_t); 411 struct vmspace *uvmspace_fork(struct process *); 412 void uvmspace_addref(struct vmspace *); 413 void uvmspace_free(struct vmspace *); 414 struct vmspace *uvmspace_share(struct process *); 415 int uvm_share(vm_map_t, vaddr_t, vm_prot_t, 416 vm_map_t, vaddr_t, vsize_t); 417 void uvm_meter(void); 418 int uvm_sysctl(int *, u_int, void *, size_t *, 419 void *, size_t, struct proc *); 420 struct vm_page *uvm_pagealloc(struct uvm_object *, 421 voff_t, struct vm_anon *, int); 422 int uvm_pagealloc_multi(struct uvm_object *, voff_t, 423 vsize_t, int); 424 void uvm_pagerealloc(struct vm_page *, 425 struct uvm_object *, voff_t); 426 int uvm_pagerealloc_multi(struct uvm_object *, voff_t, 427 vsize_t, int, struct uvm_constraint_range *); 428 /* Actually, uvm_page_physload takes PF#s which need their own type */ 429 void uvm_page_physload(paddr_t, paddr_t, paddr_t, 430 paddr_t, int); 431 void uvm_setpagesize(void); 432 void uvm_shutdown(void); 433 void uvm_aio_biodone(struct buf *); 434 void uvm_aio_aiodone(struct buf *); 435 void uvm_pageout(void *); 436 void uvm_aiodone_daemon(void *); 437 void uvm_wait(const char *); 438 int uvm_pglistalloc(psize_t, paddr_t, paddr_t, 439 paddr_t, paddr_t, struct pglist *, int, int); 440 void uvm_pglistfree(struct pglist *); 441 void uvm_pmr_use_inc(paddr_t, paddr_t); 442 void uvm_swap_init(void); 443 typedef int uvm_coredump_setup_cb(int _nsegment, void *_cookie); 444 typedef int uvm_coredump_walk_cb(vaddr_t _start, vaddr_t _realend, 445 vaddr_t _end, vm_prot_t _prot, int _nsegment, 446 void *_cookie); 447 int uvm_coredump_walkmap(struct proc *_p, 448 uvm_coredump_setup_cb *_setup, 449 uvm_coredump_walk_cb *_walk, void *_cookie); 450 void uvm_grow(struct proc *, vaddr_t); 451 void uvm_pagezero_thread(void *); 452 void kmeminit_nkmempages(void); 453 void kmeminit(void); 454 extern u_int nkmempages; 455 456 struct vnode; 457 struct uvm_object *uvn_attach(struct vnode *, vm_prot_t); 458 459 struct process; 460 struct kinfo_vmentry; 461 int fill_vmmap(struct process *, struct kinfo_vmentry *, 462 size_t *); 463 464 #endif /* _KERNEL */ 465 466 #endif /* _UVM_UVM_EXTERN_H_ */ 467