xref: /openbsd/sys/uvm/uvm_extern.h (revision 1aba0c0b)
1 /*	$OpenBSD: uvm_extern.h,v 1.179 2024/11/01 20:26:18 mpi 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_SIGALTSTACK 0x20000000 /* sigaltstack validation required */
115 
116 /* macros to extract info */
117 #define UVM_PROTECTION(X)	((X) & PROT_MASK)
118 #define UVM_INHERIT(X)		(((X) >> 4) & MAP_INHERIT_MASK)
119 #define UVM_MAXPROTECTION(X)	(((X) >> 8) & PROT_MASK)
120 #define UVM_ADVICE(X)		(((X) >> 12) & MADV_MASK)
121 
122 #define UVM_MAPFLAG(prot, maxprot, inh, advice, flags) \
123 	((prot) | ((maxprot) << 8) | ((inh) << 4) | ((advice) << 12) | (flags))
124 
125 /* magic offset value */
126 #define UVM_UNKNOWN_OFFSET ((voff_t) -1)
127 				/* offset not known(obj) or don't care(!obj) */
128 
129 /*
130  * the following defines are for uvm_km_kmemalloc's flags
131  */
132 #define UVM_KMF_NOWAIT	0x1			/* matches M_NOWAIT */
133 #define UVM_KMF_VALLOC	0x2			/* allocate VA only */
134 #define UVM_KMF_CANFAIL	0x4			/* caller handles failure */
135 #define UVM_KMF_ZERO	0x08			/* zero pages */
136 #define UVM_KMF_TRYLOCK	UVM_FLAG_TRYLOCK	/* try locking only */
137 
138 /*
139  * flags for uvm_pagealloc()
140  */
141 #define UVM_PGA_USERESERVE	0x0001	/* ok to use reserve pages */
142 #define	UVM_PGA_ZERO		0x0002	/* returned page must be zeroed */
143 
144 /*
145  * flags for uvm_pglistalloc() also used by uvm_pmr_getpages()
146  */
147 #define UVM_PLA_WAITOK		0x0001	/* may sleep */
148 #define UVM_PLA_NOWAIT		0x0002	/* can't sleep (need one of the two) */
149 #define UVM_PLA_ZERO		0x0004	/* zero all pages before returning */
150 #define UVM_PLA_TRYCONTIG	0x0008	/* try to allocate contig physmem */
151 #define UVM_PLA_FAILOK		0x0010	/* caller can handle failure */
152 #define UVM_PLA_NOWAKE		0x0020	/* don't wake page daemon on failure */
153 #define UVM_PLA_USERESERVE	0x0040	/* can allocate from kernel reserve */
154 
155 /*
156  * lockflags that control the locking behavior of various functions.
157  */
158 #define	UVM_LK_ENTER	0x00000001	/* map locked on entry */
159 #define	UVM_LK_EXIT	0x00000002	/* leave map locked on exit */
160 
161 /*
162  * flags to uvm_page_physload.
163  */
164 #define	PHYSLOAD_DEVICE	0x01	/* don't add to the page queue */
165 
166 #include <sys/queue.h>
167 #include <sys/tree.h>
168 #include <sys/mman.h>
169 
170 #ifdef _KERNEL
171 struct buf;
172 struct mount;
173 struct pglist;
174 struct vmspace;
175 struct pmap;
176 #endif
177 
178 #include <uvm/uvm_param.h>
179 
180 #include <uvm/uvm_pmap.h>
181 #include <uvm/uvm_object.h>
182 #include <uvm/uvm_page.h>
183 #include <uvm/uvm_map.h>
184 
185 #ifdef _KERNEL
186 #include <uvm/uvm_fault.h>
187 #include <uvm/uvm_pager.h>
188 #endif
189 
190 /*
191  * Shareable process virtual address space.
192  * May eventually be merged with vm_map.
193  * Several fields are temporary (text, data stuff).
194  *
195  *  Locks used to protect struct members in this file:
196  *	K	kernel lock
197  *	I	immutable after creation
198  *	a	atomic operations
199  *	v	vm_map's lock
200  */
201 struct vmspace {
202 	struct	vm_map vm_map;	/* VM address map */
203 	int	vm_refcnt;	/* [a] 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 };
218 
219 /*
220  * uvm_constraint_range's:
221  * MD code is allowed to setup constraint ranges for memory allocators, the
222  * primary use for this is to keep allocation for certain memory consumers
223  * such as mbuf pools within address ranges that are reachable by devices
224  * that perform DMA.
225  *
226  * It is also to discourage memory allocations from being satisfied from ranges
227  * such as the ISA memory range, if they can be satisfied with allocation
228  * from other ranges.
229  *
230  * the MD ranges are defined in arch/ARCH/ARCH/machdep.c
231  */
232 struct uvm_constraint_range {
233 	paddr_t	ucr_low;
234 	paddr_t ucr_high;
235 };
236 
237 #ifdef _KERNEL
238 
239 #include <uvm/uvmexp.h>
240 extern struct uvmexp uvmexp;
241 
242 /* Constraint ranges, set by MD code. */
243 extern struct uvm_constraint_range  isa_constraint;
244 extern struct uvm_constraint_range  dma_constraint;
245 extern struct uvm_constraint_range  no_constraint;
246 extern struct uvm_constraint_range *uvm_md_constraints[];
247 
248 /*
249  * the various kernel maps, owned by MD code
250  */
251 extern struct vm_map *exec_map;
252 extern struct vm_map *kernel_map;
253 extern struct vm_map *kmem_map;
254 extern struct vm_map *phys_map;
255 
256 /* base of kernel virtual memory */
257 extern vaddr_t vm_min_kernel_address;
258 
259 #define vm_resident_count(vm) (pmap_resident_count((vm)->vm_map.pmap))
260 
261 struct plimit;
262 
263 void			vmapbuf(struct buf *, vsize_t);
264 void			vunmapbuf(struct buf *, vsize_t);
265 struct uvm_object	*uao_create(vsize_t, int);
266 void			uao_detach(struct uvm_object *);
267 void			uao_reference(struct uvm_object *);
268 int			uvm_fault(vm_map_t, vaddr_t, vm_fault_t, vm_prot_t);
269 
270 vaddr_t			uvm_uarea_alloc(void);
271 void			uvm_uarea_free(struct proc *);
272 void			uvm_exit(struct process *);
273 void			uvm_init_limits(struct plimit *);
274 boolean_t		uvm_kernacc(caddr_t, size_t, int);
275 
276 int			uvm_vslock(struct proc *, caddr_t, size_t,
277 			    vm_prot_t);
278 void			uvm_vsunlock(struct proc *, caddr_t, size_t);
279 int			uvm_vslock_device(struct proc *, void *, size_t,
280 			    vm_prot_t, void **);
281 void			uvm_vsunlock_device(struct proc *, void *, size_t,
282 			    void *);
283 void			uvm_init(void);
284 void			uvm_init_percpu(void);
285 int			uvm_io(vm_map_t, struct uio *, int);
286 
287 #define	UVM_IO_FIXPROT	0x01
288 
289 void			uvm_km_free(vm_map_t, vaddr_t, vsize_t);
290 vaddr_t			uvm_km_kmemalloc_pla(struct vm_map *,
291 			    struct uvm_object *, vsize_t, vsize_t, int,
292 			    paddr_t, paddr_t, paddr_t, paddr_t, int);
293 #define uvm_km_kmemalloc(map, obj, sz, flags)				\
294 	uvm_km_kmemalloc_pla(map, obj, sz, 0, flags, 0, (paddr_t)-1, 0, 0, 0)
295 struct vm_map		*uvm_km_suballoc(vm_map_t, vaddr_t *, vaddr_t *,
296 			    vsize_t, int, boolean_t, vm_map_t);
297 /*
298  * Allocation mode for virtual space.
299  *
300  *  kv_map - pointer to the pointer to the map we're allocating from.
301  *  kv_align - alignment.
302  *  kv_wait - wait for free space in the map if it's full. The default
303  *   allocators don't wait since running out of space in kernel_map and
304  *   kmem_map is usually fatal. Special maps like exec_map are specifically
305  *   limited, so waiting for space in them is necessary.
306  *  kv_singlepage - use the single page allocator.
307  *  kv_executable - map the physical pages with PROT_EXEC.
308  */
309 struct kmem_va_mode {
310 	struct vm_map **kv_map;
311 	vsize_t kv_align;
312 	char kv_wait;
313 	char kv_singlepage;
314 };
315 
316 /*
317  * Allocation mode for physical pages.
318  *
319  *  kp_constraint - allocation constraint for physical pages.
320  *  kp_object - if the pages should be allocated from an object.
321  *  kp_align - physical alignment of the first page in the allocation.
322  *  kp_boundary - boundary that the physical addresses can't cross if
323  *   the allocation is contiguous.
324  *  kp_nomem - don't allocate any backing pages.
325  *  kp_maxseg - maximal amount of contiguous segments.
326  *  kp_zero - zero the returned memory.
327  *  kp_pageable - allocate pageable memory.
328  */
329 struct kmem_pa_mode {
330 	struct uvm_constraint_range *kp_constraint;
331 	struct uvm_object **kp_object;
332 	paddr_t kp_align;
333 	paddr_t kp_boundary;
334 	int kp_maxseg;
335 	char kp_nomem;
336 	char kp_zero;
337 	char kp_pageable;
338 };
339 
340 /*
341  * Dynamic allocation parameters. Stuff that changes too often or too much
342  * to create separate va and pa modes for.
343  *
344  * kd_waitok - is it ok to sleep?
345  * kd_trylock - don't sleep on map locks.
346  * kd_prefer - offset to feed to PMAP_PREFER
347  * kd_slowdown - special parameter for the singlepage va allocator
348  *  that tells the caller to sleep if possible to let the singlepage
349  *  allocator catch up.
350  */
351 struct kmem_dyn_mode {
352 	voff_t kd_prefer;
353 	int *kd_slowdown;
354 	char kd_waitok;
355 	char kd_trylock;
356 };
357 
358 #define KMEM_DYN_INITIALIZER { UVM_UNKNOWN_OFFSET, NULL, 0, 0 }
359 
360 /*
361  * Notice that for kv_ waiting has a different meaning. It's only supposed
362  * to be used for very space constrained maps where waiting is a way
363  * to throttle some other operation.
364  * The exception is kv_page which needs to wait relatively often.
365  * All kv_ except kv_intrsafe will potentially sleep.
366  */
367 extern const struct kmem_va_mode kv_any;
368 extern const struct kmem_va_mode kv_intrsafe;
369 extern const struct kmem_va_mode kv_page;
370 
371 extern const struct kmem_pa_mode kp_dirty;
372 extern const struct kmem_pa_mode kp_zero;
373 extern const struct kmem_pa_mode kp_dma;
374 extern const struct kmem_pa_mode kp_dma_contig;
375 extern const struct kmem_pa_mode kp_dma_zero;
376 extern const struct kmem_pa_mode kp_pageable;
377 extern const struct kmem_pa_mode kp_none;
378 
379 extern const struct kmem_dyn_mode kd_waitok;
380 extern const struct kmem_dyn_mode kd_nowait;
381 extern const struct kmem_dyn_mode kd_trylock;
382 
383 void			*km_alloc(size_t, const struct kmem_va_mode *,
384 			    const struct kmem_pa_mode *,
385 			    const struct kmem_dyn_mode *);
386 void			km_free(void *, size_t, const struct kmem_va_mode *,
387 			    const struct kmem_pa_mode *);
388 int			uvm_map(vm_map_t, vaddr_t *, vsize_t,
389 			    struct uvm_object *, voff_t, vsize_t, unsigned int);
390 int			uvm_mapanon(vm_map_t, vaddr_t *, vsize_t, vsize_t, unsigned int);
391 int			uvm_map_pageable(vm_map_t, vaddr_t,
392 			    vaddr_t, boolean_t, int);
393 int			uvm_map_pageable_all(vm_map_t, int, vsize_t);
394 boolean_t		uvm_map_checkprot(vm_map_t, vaddr_t,
395 			    vaddr_t, vm_prot_t);
396 int			uvm_map_protect(vm_map_t, vaddr_t,
397 			    vaddr_t, vm_prot_t, int etype, boolean_t, boolean_t);
398 struct vmspace		*uvmspace_alloc(vaddr_t, vaddr_t,
399 			    boolean_t, boolean_t);
400 void			uvmspace_init(struct vmspace *, struct pmap *,
401 			    vaddr_t, vaddr_t, boolean_t, boolean_t);
402 void			uvmspace_exec(struct proc *, vaddr_t, vaddr_t);
403 struct vmspace		*uvmspace_fork(struct process *);
404 void			uvmspace_addref(struct vmspace *);
405 void			uvmspace_free(struct vmspace *);
406 struct vmspace		*uvmspace_share(struct process *);
407 int			uvm_share(vm_map_t, vaddr_t, vm_prot_t,
408 			    vm_map_t, vaddr_t, vsize_t);
409 int			uvm_sysctl(int *, u_int, void *, size_t *,
410 			    void *, size_t, struct proc *);
411 struct vm_page		*uvm_pagealloc(struct uvm_object *,
412 			    voff_t, struct vm_anon *, int);
413 int			uvm_pagealloc_multi(struct uvm_object *, voff_t,
414     			    vsize_t, int);
415 void			uvm_pagerealloc(struct vm_page *,
416 			    struct uvm_object *, voff_t);
417 int			uvm_pagerealloc_multi(struct uvm_object *, voff_t,
418 			    vsize_t, int, struct uvm_constraint_range *);
419 /* Actually, uvm_page_physload takes PF#s which need their own type */
420 void			uvm_page_physload(paddr_t, paddr_t, paddr_t,
421 			    paddr_t, int);
422 void			uvm_setpagesize(void);
423 void			uvm_shutdown(void);
424 void			uvm_aio_biodone(struct buf *);
425 void			uvm_aio_aiodone(struct buf *);
426 void			uvm_pageout(void *);
427 void			uvm_aiodone_daemon(void *);
428 void			uvm_wait(const char *);
429 int			uvm_pglistalloc(psize_t, paddr_t, paddr_t,
430 			    paddr_t, paddr_t, struct pglist *, int, int);
431 void			uvm_pglistfree(struct pglist *);
432 void			uvm_pmr_use_inc(paddr_t, paddr_t);
433 void			uvm_swap_init(void);
434 typedef int		uvm_coredump_setup_cb(int _nsegment, void *_cookie);
435 typedef int		uvm_coredump_walk_cb(vaddr_t _start, vaddr_t _realend,
436 			    vaddr_t _end, vm_prot_t _prot, int _isvnode,
437 			    int _nsegment, void *_cookie);
438 int			uvm_coredump_walkmap(struct proc *_p,
439 			    uvm_coredump_setup_cb *_setup,
440 			    uvm_coredump_walk_cb *_walk, void *_cookie);
441 void			uvm_grow(struct proc *, vaddr_t);
442 void			uvm_pagezero_thread(void *);
443 void			kmeminit_nkmempages(void);
444 void			kmeminit(void);
445 extern u_int		nkmempages;
446 
447 struct vnode;
448 struct uvm_object	*uvn_attach(struct vnode *, vm_prot_t);
449 
450 struct process;
451 struct kinfo_vmentry;
452 int			fill_vmmap(struct process *, struct kinfo_vmentry *,
453 			    size_t *);
454 
455 #endif /* _KERNEL */
456 
457 #endif /* _UVM_UVM_EXTERN_H_ */
458