1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_VMALLOC_H
3 #define _LINUX_VMALLOC_H
5 #include <linux/spinlock.h>
6 #include <linux/init.h>
7 #include <linux/list.h>
8 #include <linux/llist.h>
9 #include <asm/page.h> /* pgprot_t */
10 #include <linux/rbtree.h>
11 #include <linux/overflow.h>
13 #include <asm/vmalloc.h>
15 struct vm_area_struct
; /* vma defining user mapping in mm_types.h */
16 struct notifier_block
; /* in notifier.h */
18 /* bits in flags of vmalloc's vm_struct below */
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 */
23 #define VM_DMA_COHERENT 0x00000010 /* dma_alloc_coherent */
24 #define VM_UNINITIALIZED 0x00000020 /* vm_struct is not fully initialized */
25 #define VM_NO_GUARD 0x00000040 /* don't add guard page */
26 #define VM_KASAN 0x00000080 /* has allocated kasan shadow memory */
29 * VM_KASAN is used slighly differently depending on CONFIG_KASAN_VMALLOC.
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.
35 * Otherwise, VM_KASAN is set for kasan_module_alloc() allocations and used to
36 * determine which allocations need the module shadow freed.
40 * Memory with VM_FLUSH_RESET_PERMS cannot be freed in an interrupt or with
43 #define VM_FLUSH_RESET_PERMS 0x00000100 /* Reset direct map and flush TLB on unmap */
45 /* bits [20..32] reserved for arch specific ioremap internals */
48 * Maximum alignment for ioremap() regions.
49 * Can be overriden by arch-specific value.
51 #ifndef IOREMAP_MAX_ORDER
52 #define IOREMAP_MAX_ORDER (7 + PAGE_SHIFT) /* 128 pages */
56 struct vm_struct
*next
;
61 unsigned int nr_pages
;
62 phys_addr_t phys_addr
;
67 unsigned long va_start
;
70 struct rb_node rb_node
; /* address sorted rbtree */
71 struct list_head list
; /* address sorted list */
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)
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 */
88 * Highlevel APIs for driver use
90 extern void vm_unmap_ram(const void *mem
, unsigned int count
);
91 extern void *vm_map_ram(struct page
**pages
, unsigned int count
, int node
);
92 extern void vm_unmap_aliases(void);
95 extern void __init
vmalloc_init(void);
96 extern unsigned long vmalloc_nr_pages(void);
98 static inline void vmalloc_init(void)
101 static inline unsigned long vmalloc_nr_pages(void) { return 0; }
104 extern void *vmalloc(unsigned long size
);
105 extern void *vzalloc(unsigned long size
);
106 extern void *vmalloc_user(unsigned long size
);
107 extern void *vmalloc_node(unsigned long size
, int node
);
108 extern void *vzalloc_node(unsigned long size
, int node
);
109 extern void *vmalloc_user_node_flags(unsigned long size
, int node
, gfp_t flags
);
110 extern void *vmalloc_exec(unsigned long size
);
111 extern void *vmalloc_32(unsigned long size
);
112 extern void *vmalloc_32_user(unsigned long size
);
113 extern void *__vmalloc(unsigned long size
, gfp_t gfp_mask
);
114 extern void *__vmalloc_node_range(unsigned long size
, unsigned long align
,
115 unsigned long start
, unsigned long end
, gfp_t gfp_mask
,
116 pgprot_t prot
, unsigned long vm_flags
, int node
,
119 extern void *__vmalloc_node_flags(unsigned long size
, int node
, gfp_t flags
);
120 static inline void *__vmalloc_node_flags_caller(unsigned long size
, int node
,
121 gfp_t flags
, void *caller
)
123 return __vmalloc_node_flags(size
, node
, flags
);
126 extern void *__vmalloc_node_flags_caller(unsigned long size
,
127 int node
, gfp_t flags
, void *caller
);
130 extern void vfree(const void *addr
);
131 extern void vfree_atomic(const void *addr
);
133 extern void *vmap(struct page
**pages
, unsigned int count
,
134 unsigned long flags
, pgprot_t prot
);
135 extern void vunmap(const void *addr
);
137 extern int remap_vmalloc_range_partial(struct vm_area_struct
*vma
,
138 unsigned long uaddr
, void *kaddr
,
139 unsigned long pgoff
, unsigned long size
);
141 extern int remap_vmalloc_range(struct vm_area_struct
*vma
, void *addr
,
142 unsigned long pgoff
);
143 void vmalloc_sync_mappings(void);
144 void vmalloc_sync_unmappings(void);
147 * Lowlevel-APIs (not for driver use!)
150 static inline size_t get_vm_area_size(const struct vm_struct
*area
)
152 if (!(area
->flags
& VM_NO_GUARD
))
153 /* return actual size without guard page */
154 return area
->size
- PAGE_SIZE
;
160 extern struct vm_struct
*get_vm_area(unsigned long size
, unsigned long flags
);
161 extern struct vm_struct
*get_vm_area_caller(unsigned long size
,
162 unsigned long flags
, const void *caller
);
163 extern struct vm_struct
*__get_vm_area_caller(unsigned long size
,
165 unsigned long start
, unsigned long end
,
167 extern struct vm_struct
*remove_vm_area(const void *addr
);
168 extern struct vm_struct
*find_vm_area(const void *addr
);
171 extern int map_kernel_range_noflush(unsigned long start
, unsigned long size
,
172 pgprot_t prot
, struct page
**pages
);
173 int map_kernel_range(unsigned long start
, unsigned long size
, pgprot_t prot
,
174 struct page
**pages
);
175 extern void unmap_kernel_range_noflush(unsigned long addr
, unsigned long size
);
176 extern void unmap_kernel_range(unsigned long addr
, unsigned long size
);
177 static inline void set_vm_flush_reset_perms(void *addr
)
179 struct vm_struct
*vm
= find_vm_area(addr
);
182 vm
->flags
|= VM_FLUSH_RESET_PERMS
;
186 map_kernel_range_noflush(unsigned long start
, unsigned long size
,
187 pgprot_t prot
, struct page
**pages
)
189 return size
>> PAGE_SHIFT
;
191 #define map_kernel_range map_kernel_range_noflush
193 unmap_kernel_range_noflush(unsigned long addr
, unsigned long size
)
196 #define unmap_kernel_range unmap_kernel_range_noflush
197 static inline void set_vm_flush_reset_perms(void *addr
)
202 /* Allocate/destroy a 'vmalloc' VM area. */
203 extern struct vm_struct
*alloc_vm_area(size_t size
, pte_t
**ptes
);
204 extern void free_vm_area(struct vm_struct
*area
);
207 extern long vread(char *buf
, char *addr
, unsigned long count
);
208 extern long vwrite(char *buf
, char *addr
, unsigned long count
);
211 * Internals. Dont't use..
213 extern struct list_head vmap_area_list
;
214 extern __init
void vm_area_add_early(struct vm_struct
*vm
);
215 extern __init
void vm_area_register_early(struct vm_struct
*vm
, size_t align
);
219 struct vm_struct
**pcpu_get_vm_areas(const unsigned long *offsets
,
220 const size_t *sizes
, int nr_vms
,
223 void pcpu_free_vm_areas(struct vm_struct
**vms
, int nr_vms
);
225 static inline struct vm_struct
**
226 pcpu_get_vm_areas(const unsigned long *offsets
,
227 const size_t *sizes
, int nr_vms
,
234 pcpu_free_vm_areas(struct vm_struct
**vms
, int nr_vms
)
241 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
243 #define VMALLOC_TOTAL 0UL
246 int register_vmap_purge_notifier(struct notifier_block
*nb
);
247 int unregister_vmap_purge_notifier(struct notifier_block
*nb
);
249 #endif /* _LINUX_VMALLOC_H */