1 /*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013-2017 Mellanox Technologies, Ltd.
6 * Copyright (c) 2015 François Tigeot
7 * Copyright (c) 2015 Matthew Dillon <dillon@backplane.com>
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice unmodified, this list of conditions, and the following
15 * disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 *
31 * $FreeBSD: stable/12/sys/compat/linuxkpi/common/include/linux/mm.h 370001 2021-06-16 20:25:37Z emaste $
32 */
33 #ifndef _LINUX_MM_H_
34 #define _LINUX_MM_H_
35
36 #include <linux/spinlock.h>
37 #include <linux/gfp.h>
38 #include <linux/kernel.h>
39 #include <linux/mm_types.h>
40 #include <linux/pfn.h>
41 #include <linux/list.h>
42
43 #include <asm/pgtable.h>
44
45 #define PAGE_ALIGN(x) ALIGN(x, PAGE_SIZE)
46
47 /*
48 * Make sure our LinuxKPI defined virtual memory flags don't conflict
49 * with the ones defined by FreeBSD:
50 */
51 CTASSERT((VM_PROT_ALL & -(1 << 8)) == 0);
52
53 #define VM_READ VM_PROT_READ
54 #define VM_WRITE VM_PROT_WRITE
55 #define VM_EXEC VM_PROT_EXECUTE
56
57 #define VM_PFNINTERNAL (1 << 8) /* FreeBSD private flag to vm_insert_pfn() */
58 #define VM_MIXEDMAP (1 << 9)
59 #define VM_NORESERVE (1 << 10)
60 #define VM_PFNMAP (1 << 11)
61 #define VM_IO (1 << 12)
62 #define VM_MAYWRITE (1 << 13)
63 #define VM_DONTCOPY (1 << 14)
64 #define VM_DONTEXPAND (1 << 15)
65 #define VM_DONTDUMP (1 << 16)
66
67 #define VMA_MAX_PREFAULT_RECORD 1
68
69 #define FOLL_WRITE (1 << 0)
70 #define FOLL_FORCE (1 << 1)
71
72 #define VM_FAULT_OOM (1 << 0)
73 #define VM_FAULT_SIGBUS (1 << 1)
74 #define VM_FAULT_MAJOR (1 << 2)
75 #define VM_FAULT_WRITE (1 << 3)
76 #define VM_FAULT_HWPOISON (1 << 4)
77 #define VM_FAULT_HWPOISON_LARGE (1 << 5)
78 #define VM_FAULT_SIGSEGV (1 << 6)
79 #define VM_FAULT_NOPAGE (1 << 7)
80 #define VM_FAULT_LOCKED (1 << 8)
81 #define VM_FAULT_RETRY (1 << 9)
82 #define VM_FAULT_FALLBACK (1 << 10)
83
84 #define FAULT_FLAG_WRITE (1 << 0)
85 #define FAULT_FLAG_MKWRITE (1 << 1)
86 #define FAULT_FLAG_ALLOW_RETRY (1 << 2)
87 #define FAULT_FLAG_RETRY_NOWAIT (1 << 3)
88 #define FAULT_FLAG_KILLABLE (1 << 4)
89 #define FAULT_FLAG_TRIED (1 << 5)
90 #define FAULT_FLAG_USER (1 << 6)
91 #define FAULT_FLAG_REMOTE (1 << 7)
92 #define FAULT_FLAG_INSTRUCTION (1 << 8)
93
94 #define fault_flag_allow_retry_first(flags) \
95 (((flags) & (FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_TRIED)) == FAULT_FLAG_ALLOW_RETRY)
96
97 typedef int (*pte_fn_t)(linux_pte_t *, pgtable_t, unsigned long addr, void *data);
98
99 struct vm_area_struct {
100 vm_offset_t vm_start;
101 vm_offset_t vm_end;
102 vm_offset_t vm_pgoff;
103 pgprot_t vm_page_prot;
104 unsigned long vm_flags;
105 struct mm_struct *vm_mm;
106 void *vm_private_data;
107 const struct vm_operations_struct *vm_ops;
108 struct linux_file *vm_file;
109
110 /* internal operation */
111 vm_paddr_t vm_pfn; /* PFN for memory map */
112 vm_size_t vm_len; /* length for memory map */
113 vm_pindex_t vm_pfn_first;
114 int vm_pfn_count;
115 int *vm_pfn_pcount;
116 vm_object_t vm_obj;
117 vm_map_t vm_cached_map;
118 TAILQ_ENTRY(vm_area_struct) vm_entry;
119 };
120
121 struct vm_fault {
122 unsigned int flags;
123 pgoff_t pgoff;
124 union {
125 /* user-space address */
126 void *virtual_address; /* < 4.11 */
127 unsigned long address; /* >= 4.11 */
128 };
129 struct page *page;
130 struct vm_area_struct *vma;
131 };
132
133 struct vm_operations_struct {
134 void (*open) (struct vm_area_struct *);
135 void (*close) (struct vm_area_struct *);
136 int (*fault) (struct vm_area_struct *, struct vm_fault *);
137 int (*access) (struct vm_area_struct *, unsigned long, void *, int, int);
138 };
139
140 struct sysinfo {
141 uint64_t totalram;
142 uint64_t totalhigh;
143 uint32_t mem_unit;
144 };
145
146 /*
147 * Compute log2 of the power of two rounded up count of pages
148 * needed for size bytes.
149 */
150 static inline int
get_order(unsigned long size)151 get_order(unsigned long size)
152 {
153 int order;
154
155 size = (size - 1) >> PAGE_SHIFT;
156 order = 0;
157 while (size) {
158 order++;
159 size >>= 1;
160 }
161 return (order);
162 }
163
164 static inline void *
lowmem_page_address(struct page * page)165 lowmem_page_address(struct page *page)
166 {
167 return (page_address(page));
168 }
169
170 /*
171 * This only works via memory map operations.
172 */
173 static inline int
io_remap_pfn_range(struct vm_area_struct * vma,unsigned long addr,unsigned long pfn,unsigned long size,vm_memattr_t prot)174 io_remap_pfn_range(struct vm_area_struct *vma,
175 unsigned long addr, unsigned long pfn, unsigned long size,
176 vm_memattr_t prot)
177 {
178 vma->vm_page_prot = prot;
179 vma->vm_pfn = pfn;
180 vma->vm_len = size;
181
182 return (0);
183 }
184
185 static inline int
apply_to_page_range(struct mm_struct * mm,unsigned long address,unsigned long size,pte_fn_t fn,void * data)186 apply_to_page_range(struct mm_struct *mm, unsigned long address,
187 unsigned long size, pte_fn_t fn, void *data)
188 {
189 return (-ENOTSUP);
190 }
191
192 int zap_vma_ptes(struct vm_area_struct *vma, unsigned long address,
193 unsigned long size);
194
195 static inline int
remap_pfn_range(struct vm_area_struct * vma,unsigned long addr,unsigned long pfn,unsigned long size,pgprot_t prot)196 remap_pfn_range(struct vm_area_struct *vma, unsigned long addr,
197 unsigned long pfn, unsigned long size, pgprot_t prot)
198 {
199 return (-ENOTSUP);
200 }
201
202 static inline unsigned long
vma_pages(struct vm_area_struct * vma)203 vma_pages(struct vm_area_struct *vma)
204 {
205 return ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT);
206 }
207
208 #define offset_in_page(off) ((off) & (PAGE_SIZE - 1))
209
210 static inline void
set_page_dirty(struct vm_page * page)211 set_page_dirty(struct vm_page *page)
212 {
213 vm_page_dirty(page);
214 }
215
216 static inline void
mark_page_accessed(struct vm_page * page)217 mark_page_accessed(struct vm_page *page)
218 {
219 vm_page_reference(page);
220 }
221
222 static inline void
get_page(struct vm_page * page)223 get_page(struct vm_page *page)
224 {
225 vm_page_lock(page);
226 vm_page_wire(page);
227 vm_page_unlock(page);
228 }
229
230 extern long
231 get_user_pages(unsigned long start, unsigned long nr_pages,
232 int gup_flags, struct page **,
233 struct vm_area_struct **);
234
235 extern int
236 __get_user_pages_fast(unsigned long start, int nr_pages, int write,
237 struct page **);
238
239 extern long
240 get_user_pages_remote(struct task_struct *, struct mm_struct *,
241 unsigned long start, unsigned long nr_pages,
242 int gup_flags, struct page **,
243 struct vm_area_struct **);
244
245 static inline void
put_page(struct vm_page * page)246 put_page(struct vm_page *page)
247 {
248 vm_page_lock(page);
249 if (vm_page_unwire(page, PQ_ACTIVE) && page->object == NULL)
250 vm_page_free(page);
251 vm_page_unlock(page);
252 }
253
254 #define copy_highpage(to, from) pmap_copy_page(from, to)
255
256 static inline pgprot_t
vm_get_page_prot(unsigned long vm_flags)257 vm_get_page_prot(unsigned long vm_flags)
258 {
259 return (vm_flags & VM_PROT_ALL);
260 }
261
262 static inline vm_page_t
vmalloc_to_page(const void * addr)263 vmalloc_to_page(const void *addr)
264 {
265 vm_paddr_t paddr;
266
267 paddr = pmap_kextract((vm_offset_t)addr);
268 return (PHYS_TO_VM_PAGE(paddr));
269 }
270
271 extern int is_vmalloc_addr(const void *addr);
272 void si_meminfo(struct sysinfo *si);
273
274 #endif /* _LINUX_MM_H_ */
275