xref: /freebsd/sys/compat/linuxkpi/common/include/linux/mm.h (revision b9f654b163bce26de79705e77b872427c9f2afa1)
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$
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 typedef int (*pte_fn_t)(linux_pte_t *, pgtable_t, unsigned long addr, void *data);
95 
96 struct vm_area_struct {
97 	vm_offset_t vm_start;
98 	vm_offset_t vm_end;
99 	vm_offset_t vm_pgoff;
100 	pgprot_t vm_page_prot;
101 	unsigned long vm_flags;
102 	struct mm_struct *vm_mm;
103 	void   *vm_private_data;
104 	const struct vm_operations_struct *vm_ops;
105 	struct linux_file *vm_file;
106 
107 	/* internal operation */
108 	vm_paddr_t vm_pfn;		/* PFN for memory map */
109 	vm_size_t vm_len;		/* length for memory map */
110 	vm_pindex_t vm_pfn_first;
111 	int	vm_pfn_count;
112 	int    *vm_pfn_pcount;
113 	vm_object_t vm_obj;
114 	vm_map_t vm_cached_map;
115 	TAILQ_ENTRY(vm_area_struct) vm_entry;
116 };
117 
118 struct vm_fault {
119 	unsigned int flags;
120 	pgoff_t	pgoff;
121 	union {
122 		/* user-space address */
123 		void *virtual_address;	/* < 4.11 */
124 		unsigned long address;	/* >= 4.11 */
125 	};
126 	struct page *page;
127 	struct vm_area_struct *vma;
128 };
129 
130 struct vm_operations_struct {
131 	void    (*open) (struct vm_area_struct *);
132 	void    (*close) (struct vm_area_struct *);
133 	int     (*fault) (struct vm_area_struct *, struct vm_fault *);
134 	int	(*access) (struct vm_area_struct *, unsigned long, void *, int, int);
135 };
136 
137 struct sysinfo {
138 	uint64_t totalram;
139 	uint64_t totalhigh;
140 	uint32_t mem_unit;
141 };
142 
143 /*
144  * Compute log2 of the power of two rounded up count of pages
145  * needed for size bytes.
146  */
147 static inline int
148 get_order(unsigned long size)
149 {
150 	int order;
151 
152 	size = (size - 1) >> PAGE_SHIFT;
153 	order = 0;
154 	while (size) {
155 		order++;
156 		size >>= 1;
157 	}
158 	return (order);
159 }
160 
161 static inline void *
162 lowmem_page_address(struct page *page)
163 {
164 	return (page_address(page));
165 }
166 
167 /*
168  * This only works via memory map operations.
169  */
170 static inline int
171 io_remap_pfn_range(struct vm_area_struct *vma,
172     unsigned long addr, unsigned long pfn, unsigned long size,
173     vm_memattr_t prot)
174 {
175 	vma->vm_page_prot = prot;
176 	vma->vm_pfn = pfn;
177 	vma->vm_len = size;
178 
179 	return (0);
180 }
181 
182 static inline int
183 apply_to_page_range(struct mm_struct *mm, unsigned long address,
184     unsigned long size, pte_fn_t fn, void *data)
185 {
186 	return (-ENOTSUP);
187 }
188 
189 int zap_vma_ptes(struct vm_area_struct *vma, unsigned long address,
190     unsigned long size);
191 
192 static inline int
193 remap_pfn_range(struct vm_area_struct *vma, unsigned long addr,
194     unsigned long pfn, unsigned long size, pgprot_t prot)
195 {
196 	return (-ENOTSUP);
197 }
198 
199 static inline unsigned long
200 vma_pages(struct vm_area_struct *vma)
201 {
202 	return ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT);
203 }
204 
205 #define	offset_in_page(off)	((off) & (PAGE_SIZE - 1))
206 
207 static inline void
208 set_page_dirty(struct vm_page *page)
209 {
210 	vm_page_dirty(page);
211 }
212 
213 static inline void
214 set_page_dirty_lock(struct vm_page *page)
215 {
216 	vm_page_lock(page);
217 	vm_page_dirty(page);
218 	vm_page_unlock(page);
219 }
220 
221 static inline void
222 mark_page_accessed(struct vm_page *page)
223 {
224 	vm_page_reference(page);
225 }
226 
227 static inline void
228 get_page(struct vm_page *page)
229 {
230 	vm_page_lock(page);
231 	vm_page_wire(page);
232 	vm_page_unlock(page);
233 }
234 
235 extern long
236 get_user_pages(unsigned long start, unsigned long nr_pages,
237     int gup_flags, struct page **,
238     struct vm_area_struct **);
239 
240 extern int
241 __get_user_pages_fast(unsigned long start, int nr_pages, int write,
242     struct page **);
243 
244 extern long
245 get_user_pages_remote(struct task_struct *, struct mm_struct *,
246     unsigned long start, unsigned long nr_pages,
247     int gup_flags, struct page **,
248     struct vm_area_struct **);
249 
250 static inline void
251 put_page(struct vm_page *page)
252 {
253 	vm_page_lock(page);
254 	if (vm_page_unwire(page, PQ_ACTIVE) && page->object == NULL)
255 		vm_page_free(page);
256 	vm_page_unlock(page);
257 }
258 
259 #define	copy_highpage(to, from) pmap_copy_page(from, to)
260 
261 static inline pgprot_t
262 vm_get_page_prot(unsigned long vm_flags)
263 {
264 	return (vm_flags & VM_PROT_ALL);
265 }
266 
267 static inline vm_page_t
268 vmalloc_to_page(const void *addr)
269 {
270 	vm_paddr_t paddr;
271 
272 	paddr = pmap_kextract((vm_offset_t)addr);
273 	return (PHYS_TO_VM_PAGE(paddr));
274 }
275 
276 extern int is_vmalloc_addr(const void *addr);
277 void si_meminfo(struct sysinfo *si);
278 
279 #endif					/* _LINUX_MM_H_ */
280