1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_VMALLOC_H 2 #ifndef _LINUX_VMALLOC_H
3 #define _LINUX_VMALLOC_H 3 #define _LINUX_VMALLOC_H
4 4
5 #include <linux/alloc_tag.h> <<
6 #include <linux/sched.h> <<
7 #include <linux/spinlock.h> 5 #include <linux/spinlock.h>
8 #include <linux/init.h> 6 #include <linux/init.h>
9 #include <linux/list.h> 7 #include <linux/list.h>
10 #include <linux/llist.h> 8 #include <linux/llist.h>
11 #include <asm/page.h> /* pgprot_t */ 9 #include <asm/page.h> /* pgprot_t */
12 #include <linux/rbtree.h> 10 #include <linux/rbtree.h>
13 #include <linux/overflow.h> 11 #include <linux/overflow.h>
14 12
15 #include <asm/vmalloc.h> 13 #include <asm/vmalloc.h>
16 14
17 struct vm_area_struct; /* vma definin 15 struct vm_area_struct; /* vma defining user mapping in mm_types.h */
18 struct notifier_block; /* in notifier 16 struct notifier_block; /* in notifier.h */
19 struct iov_iter; /* in uio.h */ <<
20 17
21 /* bits in flags of vmalloc's vm_struct below 18 /* bits in flags of vmalloc's vm_struct below */
22 #define VM_IOREMAP 0x00000001 19 #define VM_IOREMAP 0x00000001 /* ioremap() and friends */
23 #define VM_ALLOC 0x00000002 20 #define VM_ALLOC 0x00000002 /* vmalloc() */
24 #define VM_MAP 0x00000004 21 #define VM_MAP 0x00000004 /* vmap()ed pages */
25 #define VM_USERMAP 0x00000008 22 #define VM_USERMAP 0x00000008 /* suitable for remap_vmalloc_range */
26 #define VM_DMA_COHERENT 0x00000010 23 #define VM_DMA_COHERENT 0x00000010 /* dma_alloc_coherent */
27 #define VM_UNINITIALIZED 0x00000020 24 #define VM_UNINITIALIZED 0x00000020 /* vm_struct is not fully initialized */
28 #define VM_NO_GUARD 0x00000040 !! 25 #define VM_NO_GUARD 0x00000040 /* don't add guard page */
29 #define VM_KASAN 0x00000080 26 #define VM_KASAN 0x00000080 /* has allocated kasan shadow memory */
30 #define VM_FLUSH_RESET_PERMS 0x00000100 27 #define VM_FLUSH_RESET_PERMS 0x00000100 /* reset direct map and flush TLB on unmap, can't be freed in atomic context */
31 #define VM_MAP_PUT_PAGES 0x00000200 28 #define VM_MAP_PUT_PAGES 0x00000200 /* put pages and free array in vfree */
32 #define VM_ALLOW_HUGE_VMAP 0x00000400 !! 29 #define VM_NO_HUGE_VMAP 0x00000400 /* force PAGE_SIZE pte mapping */
33 30
34 #if (defined(CONFIG_KASAN_GENERIC) || defined( !! 31 /*
35 !defined(CONFIG_KASAN_VMALLOC) !! 32 * VM_KASAN is used slightly differently depending on CONFIG_KASAN_VMALLOC.
36 #define VM_DEFER_KMEMLEAK 0x00000800 !! 33 *
37 #else !! 34 * If IS_ENABLED(CONFIG_KASAN_VMALLOC), VM_KASAN is set on a vm_struct after
38 #define VM_DEFER_KMEMLEAK 0 !! 35 * shadow memory has been mapped. It's used to handle allocation errors so that
39 #endif !! 36 * we don't try to poison shadow on free if it was never allocated.
40 #define VM_SPARSE 0x00001000 !! 37 *
>> 38 * Otherwise, VM_KASAN is set for kasan_module_alloc() allocations and used to
>> 39 * determine which allocations need the module shadow freed.
>> 40 */
41 41
42 /* bits [20..32] reserved for arch specific io 42 /* bits [20..32] reserved for arch specific ioremap internals */
43 43
44 /* 44 /*
45 * Maximum alignment for ioremap() regions. 45 * Maximum alignment for ioremap() regions.
46 * Can be overridden by arch-specific value. 46 * Can be overridden by arch-specific value.
47 */ 47 */
48 #ifndef IOREMAP_MAX_ORDER 48 #ifndef IOREMAP_MAX_ORDER
49 #define IOREMAP_MAX_ORDER (7 + PAGE_SHIF 49 #define IOREMAP_MAX_ORDER (7 + PAGE_SHIFT) /* 128 pages */
50 #endif 50 #endif
51 51
52 struct vm_struct { 52 struct vm_struct {
53 struct vm_struct *next; 53 struct vm_struct *next;
54 void *addr; 54 void *addr;
55 unsigned long size; 55 unsigned long size;
56 unsigned long flags; 56 unsigned long flags;
57 struct page **pages; 57 struct page **pages;
58 #ifdef CONFIG_HAVE_ARCH_HUGE_VMALLOC 58 #ifdef CONFIG_HAVE_ARCH_HUGE_VMALLOC
59 unsigned int page_order; 59 unsigned int page_order;
60 #endif 60 #endif
61 unsigned int nr_pages; 61 unsigned int nr_pages;
62 phys_addr_t phys_addr; 62 phys_addr_t phys_addr;
63 const void *caller; 63 const void *caller;
64 }; 64 };
65 65
66 struct vmap_area { 66 struct vmap_area {
67 unsigned long va_start; 67 unsigned long va_start;
68 unsigned long va_end; 68 unsigned long va_end;
69 69
70 struct rb_node rb_node; /* add 70 struct rb_node rb_node; /* address sorted rbtree */
71 struct list_head list; /* add 71 struct list_head list; /* address sorted list */
72 72
73 /* 73 /*
74 * The following two variables can be 74 * The following two variables can be packed, because
75 * a vmap_area object can be either: 75 * a vmap_area object can be either:
76 * 1) in "free" tree (root is free_ !! 76 * 1) in "free" tree (root is vmap_area_root)
77 * 2) or "busy" tree (root is vmap_ !! 77 * 2) or "busy" tree (root is free_vmap_area_root)
78 */ 78 */
79 union { 79 union {
80 unsigned long subtree_max_size 80 unsigned long subtree_max_size; /* in "free" tree */
81 struct vm_struct *vm; 81 struct vm_struct *vm; /* in "busy" tree */
82 }; 82 };
83 unsigned long flags; /* mark type of v <<
84 }; 83 };
85 84
86 /* archs that select HAVE_ARCH_HUGE_VMAP shoul 85 /* archs that select HAVE_ARCH_HUGE_VMAP should override one or more of these */
87 #ifndef arch_vmap_p4d_supported 86 #ifndef arch_vmap_p4d_supported
88 static inline bool arch_vmap_p4d_supported(pgp 87 static inline bool arch_vmap_p4d_supported(pgprot_t prot)
89 { 88 {
90 return false; 89 return false;
91 } 90 }
92 #endif 91 #endif
93 92
94 #ifndef arch_vmap_pud_supported 93 #ifndef arch_vmap_pud_supported
95 static inline bool arch_vmap_pud_supported(pgp 94 static inline bool arch_vmap_pud_supported(pgprot_t prot)
96 { 95 {
97 return false; 96 return false;
98 } 97 }
99 #endif 98 #endif
100 99
101 #ifndef arch_vmap_pmd_supported 100 #ifndef arch_vmap_pmd_supported
102 static inline bool arch_vmap_pmd_supported(pgp 101 static inline bool arch_vmap_pmd_supported(pgprot_t prot)
103 { 102 {
104 return false; 103 return false;
105 } 104 }
106 #endif 105 #endif
107 106
108 #ifndef arch_vmap_pte_range_map_size 107 #ifndef arch_vmap_pte_range_map_size
109 static inline unsigned long arch_vmap_pte_rang 108 static inline unsigned long arch_vmap_pte_range_map_size(unsigned long addr, unsigned long end,
110 109 u64 pfn, unsigned int max_page_shift)
111 { 110 {
112 return PAGE_SIZE; 111 return PAGE_SIZE;
113 } 112 }
114 #endif 113 #endif
115 114
116 #ifndef arch_vmap_pte_supported_shift 115 #ifndef arch_vmap_pte_supported_shift
117 static inline int arch_vmap_pte_supported_shif 116 static inline int arch_vmap_pte_supported_shift(unsigned long size)
118 { 117 {
119 return PAGE_SHIFT; 118 return PAGE_SHIFT;
120 } 119 }
121 #endif 120 #endif
122 121
123 #ifndef arch_vmap_pgprot_tagged <<
124 static inline pgprot_t arch_vmap_pgprot_tagged <<
125 { <<
126 return prot; <<
127 } <<
128 #endif <<
129 <<
130 /* 122 /*
131 * Highlevel APIs for driver use 123 * Highlevel APIs for driver use
132 */ 124 */
133 extern void vm_unmap_ram(const void *mem, unsi 125 extern void vm_unmap_ram(const void *mem, unsigned int count);
134 extern void *vm_map_ram(struct page **pages, u 126 extern void *vm_map_ram(struct page **pages, unsigned int count, int node);
135 extern void vm_unmap_aliases(void); 127 extern void vm_unmap_aliases(void);
136 128
137 #ifdef CONFIG_MMU 129 #ifdef CONFIG_MMU
>> 130 extern void __init vmalloc_init(void);
138 extern unsigned long vmalloc_nr_pages(void); 131 extern unsigned long vmalloc_nr_pages(void);
139 #else 132 #else
>> 133 static inline void vmalloc_init(void)
>> 134 {
>> 135 }
140 static inline unsigned long vmalloc_nr_pages(v 136 static inline unsigned long vmalloc_nr_pages(void) { return 0; }
141 #endif 137 #endif
142 138
143 extern void *vmalloc_noprof(unsigned long size !! 139 extern void *vmalloc(unsigned long size);
144 #define vmalloc(...) alloc_hooks(vm !! 140 extern void *vzalloc(unsigned long size);
145 !! 141 extern void *vmalloc_user(unsigned long size);
146 extern void *vzalloc_noprof(unsigned long size !! 142 extern void *vmalloc_node(unsigned long size, int node);
147 #define vzalloc(...) alloc_hooks(vz !! 143 extern void *vzalloc_node(unsigned long size, int node);
148 !! 144 extern void *vmalloc_32(unsigned long size);
149 extern void *vmalloc_user_noprof(unsigned long !! 145 extern void *vmalloc_32_user(unsigned long size);
150 #define vmalloc_user(...) alloc_hooks(vm !! 146 extern void *__vmalloc(unsigned long size, gfp_t gfp_mask);
151 !! 147 extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
152 extern void *vmalloc_node_noprof(unsigned long <<
153 #define vmalloc_node(...) alloc_hooks(vm <<
154 <<
155 extern void *vzalloc_node_noprof(unsigned long <<
156 #define vzalloc_node(...) alloc_hooks(vz <<
157 <<
158 extern void *vmalloc_32_noprof(unsigned long s <<
159 #define vmalloc_32(...) alloc_hooks(vm <<
160 <<
161 extern void *vmalloc_32_user_noprof(unsigned l <<
162 #define vmalloc_32_user(...) alloc_hooks(vm <<
163 <<
164 extern void *__vmalloc_noprof(unsigned long si <<
165 #define __vmalloc(...) alloc_hooks(__ <<
166 <<
167 extern void *__vmalloc_node_range_noprof(unsig <<
168 unsigned long start, u 148 unsigned long start, unsigned long end, gfp_t gfp_mask,
169 pgprot_t prot, unsigne 149 pgprot_t prot, unsigned long vm_flags, int node,
170 const void *caller) __ !! 150 const void *caller);
171 #define __vmalloc_node_range(...) alloc_ !! 151 void *__vmalloc_node(unsigned long size, unsigned long align, gfp_t gfp_mask,
172 !! 152 int node, const void *caller);
173 void *__vmalloc_node_noprof(unsigned long size !! 153 void *vmalloc_no_huge(unsigned long size);
174 int node, const void *caller) <<
175 #define __vmalloc_node(...) alloc_hooks(__ <<
176 <<
177 void *vmalloc_huge_noprof(unsigned long size, <<
178 #define vmalloc_huge(...) alloc_hooks(vm <<
179 <<
180 extern void *__vmalloc_array_noprof(size_t n, <<
181 #define __vmalloc_array(...) alloc_hooks(__ <<
182 <<
183 extern void *vmalloc_array_noprof(size_t n, si <<
184 #define vmalloc_array(...) alloc_hooks(vm <<
185 <<
186 extern void *__vcalloc_noprof(size_t n, size_t <<
187 #define __vcalloc(...) alloc_hooks(__ <<
188 <<
189 extern void *vcalloc_noprof(size_t n, size_t s <<
190 #define vcalloc(...) alloc_hooks(vc <<
191 <<
192 void * __must_check vrealloc_noprof(const void <<
193 __realloc_size(2); <<
194 #define vrealloc(...) alloc_hooks(vr <<
195 154
196 extern void vfree(const void *addr); 155 extern void vfree(const void *addr);
197 extern void vfree_atomic(const void *addr); 156 extern void vfree_atomic(const void *addr);
198 157
199 extern void *vmap(struct page **pages, unsigne 158 extern void *vmap(struct page **pages, unsigned int count,
200 unsigned long flags, p 159 unsigned long flags, pgprot_t prot);
201 void *vmap_pfn(unsigned long *pfns, unsigned i 160 void *vmap_pfn(unsigned long *pfns, unsigned int count, pgprot_t prot);
202 extern void vunmap(const void *addr); 161 extern void vunmap(const void *addr);
203 162
204 extern int remap_vmalloc_range_partial(struct 163 extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
205 unsigne 164 unsigned long uaddr, void *kaddr,
206 unsigne 165 unsigned long pgoff, unsigned long size);
207 166
208 extern int remap_vmalloc_range(struct vm_area_ 167 extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
209 168 unsigned long pgoff);
210 169
211 /* 170 /*
212 * Architectures can set this mask to a combin 171 * Architectures can set this mask to a combination of PGTBL_P?D_MODIFIED values
213 * and let generic vmalloc and ioremap code kn 172 * and let generic vmalloc and ioremap code know when arch_sync_kernel_mappings()
214 * needs to be called. 173 * needs to be called.
215 */ 174 */
216 #ifndef ARCH_PAGE_TABLE_SYNC_MASK 175 #ifndef ARCH_PAGE_TABLE_SYNC_MASK
217 #define ARCH_PAGE_TABLE_SYNC_MASK 0 176 #define ARCH_PAGE_TABLE_SYNC_MASK 0
218 #endif 177 #endif
219 178
220 /* 179 /*
221 * There is no default implementation for arch 180 * There is no default implementation for arch_sync_kernel_mappings(). It is
222 * relied upon the compiler to optimize calls 181 * relied upon the compiler to optimize calls out if ARCH_PAGE_TABLE_SYNC_MASK
223 * is 0. 182 * is 0.
224 */ 183 */
225 void arch_sync_kernel_mappings(unsigned long s 184 void arch_sync_kernel_mappings(unsigned long start, unsigned long end);
226 185
227 /* 186 /*
228 * Lowlevel-APIs (not for driver use!) 187 * Lowlevel-APIs (not for driver use!)
229 */ 188 */
230 189
231 static inline size_t get_vm_area_size(const st 190 static inline size_t get_vm_area_size(const struct vm_struct *area)
232 { 191 {
233 if (!(area->flags & VM_NO_GUARD)) 192 if (!(area->flags & VM_NO_GUARD))
234 /* return actual size without 193 /* return actual size without guard page */
235 return area->size - PAGE_SIZE; 194 return area->size - PAGE_SIZE;
236 else 195 else
237 return area->size; 196 return area->size;
238 197
239 } 198 }
240 199
241 extern struct vm_struct *get_vm_area(unsigned 200 extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
242 extern struct vm_struct *get_vm_area_caller(un 201 extern struct vm_struct *get_vm_area_caller(unsigned long size,
243 unsign 202 unsigned long flags, const void *caller);
244 extern struct vm_struct *__get_vm_area_caller( 203 extern struct vm_struct *__get_vm_area_caller(unsigned long size,
245 unsign 204 unsigned long flags,
246 unsign 205 unsigned long start, unsigned long end,
247 const 206 const void *caller);
248 void free_vm_area(struct vm_struct *area); 207 void free_vm_area(struct vm_struct *area);
249 extern struct vm_struct *remove_vm_area(const 208 extern struct vm_struct *remove_vm_area(const void *addr);
250 extern struct vm_struct *find_vm_area(const vo 209 extern struct vm_struct *find_vm_area(const void *addr);
251 struct vmap_area *find_vmap_area(unsigned long <<
252 210
253 static inline bool is_vm_area_hugepages(const 211 static inline bool is_vm_area_hugepages(const void *addr)
254 { 212 {
255 /* 213 /*
256 * This may not 100% tell if the area 214 * This may not 100% tell if the area is mapped with > PAGE_SIZE
257 * page table entries, if for some rea 215 * page table entries, if for some reason the architecture indicates
258 * larger sizes are available but deci 216 * larger sizes are available but decides not to use them, nothing
259 * prevents that. This only indicates 217 * prevents that. This only indicates the size of the physical page
260 * allocated in the vmalloc layer. 218 * allocated in the vmalloc layer.
261 */ 219 */
262 #ifdef CONFIG_HAVE_ARCH_HUGE_VMALLOC 220 #ifdef CONFIG_HAVE_ARCH_HUGE_VMALLOC
263 return find_vm_area(addr)->page_order 221 return find_vm_area(addr)->page_order > 0;
264 #else 222 #else
265 return false; 223 return false;
266 #endif 224 #endif
267 } 225 }
268 226
269 #ifdef CONFIG_MMU 227 #ifdef CONFIG_MMU
270 int vm_area_map_pages(struct vm_struct *area, !! 228 int vmap_range(unsigned long addr, unsigned long end,
271 unsigned long end, struc !! 229 phys_addr_t phys_addr, pgprot_t prot,
272 void vm_area_unmap_pages(struct vm_struct *are !! 230 unsigned int max_page_shift);
273 unsigned long end); <<
274 void vunmap_range(unsigned long addr, unsigned 231 void vunmap_range(unsigned long addr, unsigned long end);
275 static inline void set_vm_flush_reset_perms(vo 232 static inline void set_vm_flush_reset_perms(void *addr)
276 { 233 {
277 struct vm_struct *vm = find_vm_area(ad 234 struct vm_struct *vm = find_vm_area(addr);
278 235
279 if (vm) 236 if (vm)
280 vm->flags |= VM_FLUSH_RESET_PE 237 vm->flags |= VM_FLUSH_RESET_PERMS;
281 } 238 }
282 239
283 #else 240 #else
284 static inline void set_vm_flush_reset_perms(vo 241 static inline void set_vm_flush_reset_perms(void *addr)
285 { 242 {
286 } 243 }
287 #endif 244 #endif
288 245
289 /* for /proc/kcore */ 246 /* for /proc/kcore */
290 extern long vread_iter(struct iov_iter *iter, !! 247 extern long vread(char *buf, char *addr, unsigned long count);
291 248
292 /* 249 /*
293 * Internals. Don't use.. 250 * Internals. Don't use..
294 */ 251 */
>> 252 extern struct list_head vmap_area_list;
295 extern __init void vm_area_add_early(struct vm 253 extern __init void vm_area_add_early(struct vm_struct *vm);
296 extern __init void vm_area_register_early(stru 254 extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);
297 255
298 #ifdef CONFIG_SMP 256 #ifdef CONFIG_SMP
299 # ifdef CONFIG_MMU 257 # ifdef CONFIG_MMU
300 struct vm_struct **pcpu_get_vm_areas(const uns 258 struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets,
301 const siz 259 const size_t *sizes, int nr_vms,
302 size_t al 260 size_t align);
303 261
304 void pcpu_free_vm_areas(struct vm_struct **vms 262 void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
305 # else 263 # else
306 static inline struct vm_struct ** 264 static inline struct vm_struct **
307 pcpu_get_vm_areas(const unsigned long *offsets 265 pcpu_get_vm_areas(const unsigned long *offsets,
308 const size_t *sizes, int nr_vm 266 const size_t *sizes, int nr_vms,
309 size_t align) 267 size_t align)
310 { 268 {
311 return NULL; 269 return NULL;
312 } 270 }
313 271
314 static inline void 272 static inline void
315 pcpu_free_vm_areas(struct vm_struct **vms, int 273 pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
316 { 274 {
317 } 275 }
318 # endif 276 # endif
319 #endif 277 #endif
320 278
321 #ifdef CONFIG_MMU 279 #ifdef CONFIG_MMU
322 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_S 280 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
323 #else 281 #else
324 #define VMALLOC_TOTAL 0UL 282 #define VMALLOC_TOTAL 0UL
325 #endif 283 #endif
326 284
327 int register_vmap_purge_notifier(struct notifi 285 int register_vmap_purge_notifier(struct notifier_block *nb);
328 int unregister_vmap_purge_notifier(struct noti 286 int unregister_vmap_purge_notifier(struct notifier_block *nb);
329 287
330 #if defined(CONFIG_MMU) && defined(CONFIG_PRIN 288 #if defined(CONFIG_MMU) && defined(CONFIG_PRINTK)
331 bool vmalloc_dump_obj(void *object); 289 bool vmalloc_dump_obj(void *object);
332 #else 290 #else
333 static inline bool vmalloc_dump_obj(void *obje 291 static inline bool vmalloc_dump_obj(void *object) { return false; }
334 #endif 292 #endif
335 293
336 #endif /* _LINUX_VMALLOC_H */ 294 #endif /* _LINUX_VMALLOC_H */
337 295
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.