Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | #ifndef _LINUX_VMALLOC_H |
3 | #define _LINUX_VMALLOC_H | |
4 | ||
5 | #include <linux/spinlock.h> | |
db64fe02 | 6 | #include <linux/init.h> |
13ba3fcb | 7 | #include <linux/list.h> |
80c4bd7a | 8 | #include <linux/llist.h> |
1da177e4 | 9 | #include <asm/page.h> /* pgprot_t */ |
13ba3fcb | 10 | #include <linux/rbtree.h> |
3b3b1a29 | 11 | #include <linux/overflow.h> |
1da177e4 | 12 | |
1f059dfd IM |
13 | #include <asm/vmalloc.h> |
14 | ||
605d9288 | 15 | struct vm_area_struct; /* vma defining user mapping in mm_types.h */ |
4da56b99 | 16 | struct notifier_block; /* in notifier.h */ |
83342314 | 17 | |
605d9288 | 18 | /* bits in flags of vmalloc's vm_struct below */ |
20fc02b4 ZY |
19 | #define VM_IOREMAP 0x00000001 /* ioremap() and friends */ |
20 | #define VM_ALLOC 0x00000002 /* vmalloc() */ | |
21 | #define VM_MAP 0x00000004 /* vmap()ed pages */ | |
22 | #define VM_USERMAP 0x00000008 /* suitable for remap_vmalloc_range */ | |
fe9041c2 | 23 | #define VM_DMA_COHERENT 0x00000010 /* dma_alloc_coherent */ |
20fc02b4 | 24 | #define VM_UNINITIALIZED 0x00000020 /* vm_struct is not fully initialized */ |
71394fe5 | 25 | #define VM_NO_GUARD 0x00000040 /* don't add guard page */ |
a5af5aa8 | 26 | #define VM_KASAN 0x00000080 /* has allocated kasan shadow memory */ |
3c5c3cfb DA |
27 | |
28 | /* | |
29 | * VM_KASAN is used slighly differently depending on CONFIG_KASAN_VMALLOC. | |
30 | * | |
31 | * If IS_ENABLED(CONFIG_KASAN_VMALLOC), VM_KASAN is set on a vm_struct after | |
32 | * shadow memory has been mapped. It's used to handle allocation errors so that | |
33 | * we don't try to poision shadow on free if it was never allocated. | |
34 | * | |
35 | * Otherwise, VM_KASAN is set for kasan_module_alloc() allocations and used to | |
36 | * determine which allocations need the module shadow freed. | |
37 | */ | |
38 | ||
868b104d RE |
39 | /* |
40 | * Memory with VM_FLUSH_RESET_PERMS cannot be freed in an interrupt or with | |
41 | * vfree_atomic(). | |
42 | */ | |
43 | #define VM_FLUSH_RESET_PERMS 0x00000100 /* Reset direct map and flush TLB on unmap */ | |
fe9041c2 | 44 | |
1da177e4 LT |
45 | /* bits [20..32] reserved for arch specific ioremap internals */ |
46 | ||
fd195c49 DS |
47 | /* |
48 | * Maximum alignment for ioremap() regions. | |
49 | * Can be overriden by arch-specific value. | |
50 | */ | |
51 | #ifndef IOREMAP_MAX_ORDER | |
52 | #define IOREMAP_MAX_ORDER (7 + PAGE_SHIFT) /* 128 pages */ | |
53 | #endif | |
54 | ||
1da177e4 | 55 | struct vm_struct { |
2b4ac44e | 56 | struct vm_struct *next; |
1da177e4 LT |
57 | void *addr; |
58 | unsigned long size; | |
59 | unsigned long flags; | |
60 | struct page **pages; | |
61 | unsigned int nr_pages; | |
ffa71f33 | 62 | phys_addr_t phys_addr; |
5e6cafc8 | 63 | const void *caller; |
1da177e4 LT |
64 | }; |
65 | ||
13ba3fcb AK |
66 | struct vmap_area { |
67 | unsigned long va_start; | |
68 | unsigned long va_end; | |
68ad4a33 | 69 | |
13ba3fcb AK |
70 | struct rb_node rb_node; /* address sorted rbtree */ |
71 | struct list_head list; /* address sorted list */ | |
688fcbfc PL |
72 | |
73 | /* | |
74 | * The following three variables can be packed, because | |
75 | * a vmap_area object is always one of the three states: | |
76 | * 1) in "free" tree (root is vmap_area_root) | |
77 | * 2) in "busy" tree (root is free_vmap_area_root) | |
78 | * 3) in purge list (head is vmap_purge_list) | |
79 | */ | |
80 | union { | |
81 | unsigned long subtree_max_size; /* in "free" tree */ | |
82 | struct vm_struct *vm; /* in "busy" tree */ | |
83 | struct llist_node purge_list; /* in purge list */ | |
84 | }; | |
13ba3fcb AK |
85 | }; |
86 | ||
1da177e4 LT |
87 | /* |
88 | * Highlevel APIs for driver use | |
89 | */ | |
db64fe02 NP |
90 | extern void vm_unmap_ram(const void *mem, unsigned int count); |
91 | extern void *vm_map_ram(struct page **pages, unsigned int count, | |
92 | int node, pgprot_t prot); | |
93 | extern void vm_unmap_aliases(void); | |
94 | ||
95 | #ifdef CONFIG_MMU | |
96 | extern void __init vmalloc_init(void); | |
97105f0a | 97 | extern unsigned long vmalloc_nr_pages(void); |
db64fe02 NP |
98 | #else |
99 | static inline void vmalloc_init(void) | |
100 | { | |
101 | } | |
97105f0a | 102 | static inline unsigned long vmalloc_nr_pages(void) { return 0; } |
db64fe02 NP |
103 | #endif |
104 | ||
1da177e4 | 105 | extern void *vmalloc(unsigned long size); |
e1ca7788 | 106 | extern void *vzalloc(unsigned long size); |
83342314 | 107 | extern void *vmalloc_user(unsigned long size); |
930fc45a | 108 | extern void *vmalloc_node(unsigned long size, int node); |
e1ca7788 | 109 | extern void *vzalloc_node(unsigned long size, int node); |
fc970227 | 110 | extern void *vmalloc_user_node_flags(unsigned long size, int node, gfp_t flags); |
1da177e4 LT |
111 | extern void *vmalloc_exec(unsigned long size); |
112 | extern void *vmalloc_32(unsigned long size); | |
83342314 | 113 | extern void *vmalloc_32_user(unsigned long size); |
dd0fc66f | 114 | extern void *__vmalloc(unsigned long size, gfp_t gfp_mask, pgprot_t prot); |
d0a21265 DR |
115 | extern void *__vmalloc_node_range(unsigned long size, unsigned long align, |
116 | unsigned long start, unsigned long end, gfp_t gfp_mask, | |
cb9e3c29 AR |
117 | pgprot_t prot, unsigned long vm_flags, int node, |
118 | const void *caller); | |
1f5307b1 | 119 | #ifndef CONFIG_MMU |
a7c3e901 | 120 | extern void *__vmalloc_node_flags(unsigned long size, int node, gfp_t flags); |
8594a21c MH |
121 | static inline void *__vmalloc_node_flags_caller(unsigned long size, int node, |
122 | gfp_t flags, void *caller) | |
1f5307b1 | 123 | { |
8594a21c | 124 | return __vmalloc_node_flags(size, node, flags); |
1f5307b1 | 125 | } |
8594a21c MH |
126 | #else |
127 | extern void *__vmalloc_node_flags_caller(unsigned long size, | |
128 | int node, gfp_t flags, void *caller); | |
1f5307b1 | 129 | #endif |
cb9e3c29 | 130 | |
b3bdda02 | 131 | extern void vfree(const void *addr); |
bf22e37a | 132 | extern void vfree_atomic(const void *addr); |
1da177e4 LT |
133 | |
134 | extern void *vmap(struct page **pages, unsigned int count, | |
135 | unsigned long flags, pgprot_t prot); | |
b3bdda02 | 136 | extern void vunmap(const void *addr); |
83342314 | 137 | |
e69e9d4a HD |
138 | extern int remap_vmalloc_range_partial(struct vm_area_struct *vma, |
139 | unsigned long uaddr, void *kaddr, | |
140 | unsigned long size); | |
141 | ||
83342314 NP |
142 | extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr, |
143 | unsigned long pgoff); | |
763802b5 JR |
144 | void vmalloc_sync_mappings(void); |
145 | void vmalloc_sync_unmappings(void); | |
146 | ||
1da177e4 LT |
147 | /* |
148 | * Lowlevel-APIs (not for driver use!) | |
149 | */ | |
9585116b JF |
150 | |
151 | static inline size_t get_vm_area_size(const struct vm_struct *area) | |
152 | { | |
71394fe5 AR |
153 | if (!(area->flags & VM_NO_GUARD)) |
154 | /* return actual size without guard page */ | |
155 | return area->size - PAGE_SIZE; | |
156 | else | |
157 | return area->size; | |
158 | ||
9585116b JF |
159 | } |
160 | ||
1da177e4 | 161 | extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags); |
23016969 | 162 | extern struct vm_struct *get_vm_area_caller(unsigned long size, |
5e6cafc8 | 163 | unsigned long flags, const void *caller); |
1da177e4 LT |
164 | extern struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags, |
165 | unsigned long start, unsigned long end); | |
c2968612 BH |
166 | extern struct vm_struct *__get_vm_area_caller(unsigned long size, |
167 | unsigned long flags, | |
168 | unsigned long start, unsigned long end, | |
5e6cafc8 | 169 | const void *caller); |
b3bdda02 | 170 | extern struct vm_struct *remove_vm_area(const void *addr); |
e9da6e99 | 171 | extern struct vm_struct *find_vm_area(const void *addr); |
c19c03fc | 172 | |
1da177e4 | 173 | extern int map_vm_area(struct vm_struct *area, pgprot_t prot, |
f6f8ed47 | 174 | struct page **pages); |
b554cb42 | 175 | #ifdef CONFIG_MMU |
8fc48985 TH |
176 | extern int map_kernel_range_noflush(unsigned long start, unsigned long size, |
177 | pgprot_t prot, struct page **pages); | |
178 | extern void unmap_kernel_range_noflush(unsigned long addr, unsigned long size); | |
c19c03fc | 179 | extern void unmap_kernel_range(unsigned long addr, unsigned long size); |
868b104d RE |
180 | static inline void set_vm_flush_reset_perms(void *addr) |
181 | { | |
182 | struct vm_struct *vm = find_vm_area(addr); | |
183 | ||
184 | if (vm) | |
185 | vm->flags |= VM_FLUSH_RESET_PERMS; | |
186 | } | |
b554cb42 GY |
187 | #else |
188 | static inline int | |
189 | map_kernel_range_noflush(unsigned long start, unsigned long size, | |
190 | pgprot_t prot, struct page **pages) | |
191 | { | |
192 | return size >> PAGE_SHIFT; | |
193 | } | |
194 | static inline void | |
195 | unmap_kernel_range_noflush(unsigned long addr, unsigned long size) | |
196 | { | |
197 | } | |
198 | static inline void | |
199 | unmap_kernel_range(unsigned long addr, unsigned long size) | |
200 | { | |
201 | } | |
868b104d RE |
202 | static inline void set_vm_flush_reset_perms(void *addr) |
203 | { | |
204 | } | |
b554cb42 | 205 | #endif |
1da177e4 | 206 | |
5f4352fb | 207 | /* Allocate/destroy a 'vmalloc' VM area. */ |
cd12909c | 208 | extern struct vm_struct *alloc_vm_area(size_t size, pte_t **ptes); |
5f4352fb JF |
209 | extern void free_vm_area(struct vm_struct *area); |
210 | ||
69beeb1d KM |
211 | /* for /dev/kmem */ |
212 | extern long vread(char *buf, char *addr, unsigned long count); | |
213 | extern long vwrite(char *buf, char *addr, unsigned long count); | |
214 | ||
1da177e4 LT |
215 | /* |
216 | * Internals. Dont't use.. | |
217 | */ | |
f1c4069e | 218 | extern struct list_head vmap_area_list; |
be9b7335 | 219 | extern __init void vm_area_add_early(struct vm_struct *vm); |
c0c0a293 | 220 | extern __init void vm_area_register_early(struct vm_struct *vm, size_t align); |
1da177e4 | 221 | |
4f8b02b4 | 222 | #ifdef CONFIG_SMP |
b554cb42 | 223 | # ifdef CONFIG_MMU |
ca23e405 TH |
224 | struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets, |
225 | const size_t *sizes, int nr_vms, | |
ec3f64fc | 226 | size_t align); |
ca23e405 TH |
227 | |
228 | void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms); | |
b554cb42 GY |
229 | # else |
230 | static inline struct vm_struct ** | |
231 | pcpu_get_vm_areas(const unsigned long *offsets, | |
232 | const size_t *sizes, int nr_vms, | |
233 | size_t align) | |
234 | { | |
235 | return NULL; | |
236 | } | |
237 | ||
238 | static inline void | |
239 | pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms) | |
240 | { | |
241 | } | |
242 | # endif | |
4f8b02b4 | 243 | #endif |
ca23e405 | 244 | |
db3808c1 JK |
245 | #ifdef CONFIG_MMU |
246 | #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START) | |
db3808c1 | 247 | #else |
db3808c1 | 248 | #define VMALLOC_TOTAL 0UL |
db3808c1 JK |
249 | #endif |
250 | ||
4da56b99 CW |
251 | int register_vmap_purge_notifier(struct notifier_block *nb); |
252 | int unregister_vmap_purge_notifier(struct notifier_block *nb); | |
253 | ||
1da177e4 | 254 | #endif /* _LINUX_VMALLOC_H */ |