1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 *    may be used to endorse or promote products derived from this software
17 *    without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _VM_EXTERN_H_
33#define	_VM_EXTERN_H_
34
35struct pmap;
36struct proc;
37struct vmspace;
38struct vnode;
39struct vmem;
40
41#ifdef _KERNEL
42#include <sys/kassert.h>
43
44struct cdev;
45struct cdevsw;
46struct domainset;
47
48/* These operate on kernel virtual addresses only. */
49vm_offset_t kva_alloc(vm_size_t);
50vm_offset_t kva_alloc_aligned(vm_size_t, vm_size_t);
51void kva_free(vm_offset_t, vm_size_t);
52
53/* These operate on pageable virtual addresses. */
54vm_offset_t kmap_alloc_wait(vm_map_t, vm_size_t);
55void kmap_free_wakeup(vm_map_t, vm_offset_t, vm_size_t);
56
57/* These operate on virtual addresses backed by memory. */
58void *kmem_alloc_attr(vm_size_t size, int flags,
59    vm_paddr_t low, vm_paddr_t high, vm_memattr_t memattr);
60void *kmem_alloc_attr_domainset(struct domainset *ds, vm_size_t size,
61    int flags, vm_paddr_t low, vm_paddr_t high, vm_memattr_t memattr);
62void *kmem_alloc_contig(vm_size_t size, int flags,
63    vm_paddr_t low, vm_paddr_t high, u_long alignment, vm_paddr_t boundary,
64    vm_memattr_t memattr);
65void *kmem_alloc_contig_domainset(struct domainset *ds, vm_size_t size,
66    int flags, vm_paddr_t low, vm_paddr_t high, u_long alignment,
67    vm_paddr_t boundary, vm_memattr_t memattr);
68void *kmem_malloc(vm_size_t size, int flags);
69void *kmem_malloc_domainset(struct domainset *ds, vm_size_t size,
70    int flags);
71void kmem_free(void *addr, vm_size_t size);
72
73/* This provides memory for previously allocated address space. */
74int kmem_back(vm_object_t, vm_offset_t, vm_size_t, int);
75int kmem_back_domain(int, vm_object_t, vm_offset_t, vm_size_t, int);
76void kmem_unback(vm_object_t, vm_offset_t, vm_size_t);
77
78/* Bootstrapping. */
79void kmem_bootstrap_free(vm_offset_t, vm_size_t);
80void kmem_subinit(vm_map_t, vm_map_t, vm_offset_t *, vm_offset_t *, vm_size_t,
81    bool);
82void kmem_init(vm_offset_t, vm_offset_t);
83void kmem_init_zero_region(void);
84void kmeminit(void);
85
86bool kernacc(void *, int, int);
87bool useracc(void *, int, int);
88int vm_fault(vm_map_t map, vm_offset_t vaddr, vm_prot_t fault_type,
89    int fault_flags, vm_page_t *m_hold);
90void vm_fault_copy_entry(vm_map_t, vm_map_t, vm_map_entry_t, vm_map_entry_t,
91    vm_ooffset_t *);
92int vm_fault_disable_pagefaults(void);
93void vm_fault_enable_pagefaults(int save);
94int vm_fault_quick_hold_pages(vm_map_t map, vm_offset_t addr, vm_size_t len,
95    vm_prot_t prot, vm_page_t *ma, int max_count);
96int vm_fault_trap(vm_map_t map, vm_offset_t vaddr, vm_prot_t fault_type,
97    int fault_flags, int *signo, int *ucode);
98int vm_forkproc(struct thread *, struct proc *, struct thread *,
99    struct vmspace *, int);
100void vm_waitproc(struct proc *);
101int vm_mmap(vm_map_t, vm_offset_t *, vm_size_t, vm_prot_t, vm_prot_t, int,
102    objtype_t, void *, vm_ooffset_t);
103int vm_mmap_object(vm_map_t, vm_offset_t *, vm_size_t, vm_prot_t,
104    vm_prot_t, int, vm_object_t, vm_ooffset_t, boolean_t, struct thread *);
105int vm_mmap_to_errno(int rv);
106int vm_mmap_cdev(struct thread *, vm_size_t, vm_prot_t, vm_prot_t *,
107    int *, struct cdev *, struct cdevsw *, vm_ooffset_t *, vm_object_t *);
108int vm_mmap_vnode(struct thread *, vm_size_t, vm_prot_t, vm_prot_t *, int *,
109    struct vnode *, vm_ooffset_t *, vm_object_t *, boolean_t *);
110void vm_set_page_size(void);
111void vm_sync_icache(vm_map_t, vm_offset_t, vm_size_t);
112typedef int (*pmap_pinit_t)(struct pmap *pmap);
113struct vmspace *vmspace_alloc(vm_offset_t, vm_offset_t, pmap_pinit_t);
114struct vmspace *vmspace_fork(struct vmspace *, vm_ooffset_t *);
115int vmspace_exec(struct proc *, vm_offset_t, vm_offset_t);
116int vmspace_unshare(struct proc *);
117void vmspace_exit(struct thread *);
118struct vmspace *vmspace_acquire_ref(struct proc *);
119void vmspace_free(struct vmspace *);
120void vmspace_exitfree(struct proc *);
121void vmspace_switch_aio(struct vmspace *);
122void vnode_pager_setsize(struct vnode *, vm_ooffset_t);
123void vnode_pager_purge_range(struct vnode *, vm_ooffset_t, vm_ooffset_t);
124int vslock(void *, size_t);
125void vsunlock(void *, size_t);
126struct sf_buf *vm_imgact_map_page(vm_object_t object, vm_ooffset_t offset);
127void vm_imgact_unmap_page(struct sf_buf *sf);
128void vm_thread_dispose(struct thread *td);
129int vm_thread_new(struct thread *td, int pages);
130vm_pindex_t vm_kstack_pindex(vm_offset_t ks, int npages);
131vm_object_t vm_thread_kstack_size_to_obj(int npages);
132int vm_thread_stack_back(vm_offset_t kaddr, vm_page_t ma[], int npages,
133    int req_class, int domain);
134u_int vm_active_count(void);
135u_int vm_inactive_count(void);
136u_int vm_laundry_count(void);
137u_int vm_wait_count(void);
138
139/*
140 * Is pa a multiple of alignment, which is a power-of-two?
141 */
142static inline bool
143vm_addr_align_ok(vm_paddr_t pa, u_long alignment)
144{
145	KASSERT(powerof2(alignment), ("%s: alignment is not a power of 2: %#lx",
146	    __func__, alignment));
147	return ((pa & (alignment - 1)) == 0);
148}
149
150/*
151 * Do the first and last addresses of a range match in all bits except the ones
152 * in -boundary (a power-of-two)?  For boundary == 0, all addresses match.
153 */
154static inline bool
155vm_addr_bound_ok(vm_paddr_t pa, vm_paddr_t size, vm_paddr_t boundary)
156{
157	KASSERT(powerof2(boundary), ("%s: boundary is not a power of 2: %#jx",
158	    __func__, (uintmax_t)boundary));
159	return (((pa ^ (pa + size - 1)) & -boundary) == 0);
160}
161
162static inline bool
163vm_addr_ok(vm_paddr_t pa, vm_paddr_t size, u_long alignment,
164    vm_paddr_t boundary)
165{
166	return (vm_addr_align_ok(pa, alignment) &&
167	    vm_addr_bound_ok(pa, size, boundary));
168}
169#endif				/* _KERNEL */
170#endif				/* !_VM_EXTERN_H_ */
171