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 struct vm_area_struct; /* vma defining user mapping in mm_types.h */
14 struct notifier_block; /* in notifier.h */
16 /* bits in flags of vmalloc's vm_struct below */
17 #define VM_IOREMAP 0x00000001 /* ioremap() and friends */
18 #define VM_ALLOC 0x00000002 /* vmalloc() */
19 #define VM_MAP 0x00000004 /* vmap()ed pages */
20 #define VM_USERMAP 0x00000008 /* suitable for remap_vmalloc_range */
21 #define VM_DMA_COHERENT 0x00000010 /* dma_alloc_coherent */
22 #define VM_UNINITIALIZED 0x00000020 /* vm_struct is not fully initialized */
23 #define VM_NO_GUARD 0x00000040 /* don't add guard page */
24 #define VM_KASAN 0x00000080 /* has allocated kasan shadow memory */
27 * VM_KASAN is used slighly differently depending on CONFIG_KASAN_VMALLOC.
29 * If IS_ENABLED(CONFIG_KASAN_VMALLOC), VM_KASAN is set on a vm_struct after
30 * shadow memory has been mapped. It's used to handle allocation errors so that
31 * we don't try to poision shadow on free if it was never allocated.
33 * Otherwise, VM_KASAN is set for kasan_module_alloc() allocations and used to
34 * determine which allocations need the module shadow freed.
38 * Memory with VM_FLUSH_RESET_PERMS cannot be freed in an interrupt or with
41 #define VM_FLUSH_RESET_PERMS 0x00000100 /* Reset direct map and flush TLB on unmap */
43 /* bits [20..32] reserved for arch specific ioremap internals */
46 * Maximum alignment for ioremap() regions.
47 * Can be overriden by arch-specific value.
49 #ifndef IOREMAP_MAX_ORDER
50 #define IOREMAP_MAX_ORDER (7 + PAGE_SHIFT) /* 128 pages */
54 struct vm_struct *next;
59 unsigned int nr_pages;
60 phys_addr_t phys_addr;
65 unsigned long va_start;
68 struct rb_node rb_node; /* address sorted rbtree */
69 struct list_head list; /* address sorted list */
72 * The following three variables can be packed, because
73 * a vmap_area object is always one of the three states:
74 * 1) in "free" tree (root is vmap_area_root)
75 * 2) in "busy" tree (root is free_vmap_area_root)
76 * 3) in purge list (head is vmap_purge_list)
79 unsigned long subtree_max_size; /* in "free" tree */
80 struct vm_struct *vm; /* in "busy" tree */
81 struct llist_node purge_list; /* in purge list */
86 * Highlevel APIs for driver use
88 extern void vm_unmap_ram(const void *mem, unsigned int count);
89 extern void *vm_map_ram(struct page **pages, unsigned int count,
90 int node, pgprot_t prot);
91 extern void vm_unmap_aliases(void);
94 extern void __init vmalloc_init(void);
95 extern unsigned long vmalloc_nr_pages(void);
97 static inline void vmalloc_init(void)
100 static inline unsigned long vmalloc_nr_pages(void) { return 0; }
103 extern void *vmalloc(unsigned long size);
104 extern void *vzalloc(unsigned long size);
105 extern void *vmalloc_user(unsigned long size);
106 extern void *vmalloc_node(unsigned long size, int node);
107 extern void *vzalloc_node(unsigned long size, int node);
108 extern void *vmalloc_user_node_flags(unsigned long size, int node, gfp_t flags);
109 extern void *vmalloc_exec(unsigned long size);
110 extern void *vmalloc_32(unsigned long size);
111 extern void *vmalloc_32_user(unsigned long size);
112 extern void *__vmalloc(unsigned long size, gfp_t gfp_mask, pgprot_t prot);
113 extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
114 unsigned long start, unsigned long end, gfp_t gfp_mask,
115 pgprot_t prot, unsigned long vm_flags, int node,
118 extern void *__vmalloc_node_flags(unsigned long size, int node, gfp_t flags);
119 static inline void *__vmalloc_node_flags_caller(unsigned long size, int node,
120 gfp_t flags, void *caller)
122 return __vmalloc_node_flags(size, node, flags);
125 extern void *__vmalloc_node_flags_caller(unsigned long size,
126 int node, gfp_t flags, void *caller);
129 extern void vfree(const void *addr);
130 extern void vfree_atomic(const void *addr);
132 extern void *vmap(struct page **pages, unsigned int count,
133 unsigned long flags, pgprot_t prot);
134 extern void vunmap(const void *addr);
136 extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
137 unsigned long uaddr, void *kaddr,
140 extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
141 unsigned long pgoff);
142 void vmalloc_sync_all(void);
145 * Lowlevel-APIs (not for driver use!)
148 static inline size_t get_vm_area_size(const struct vm_struct *area)
150 if (!(area->flags & VM_NO_GUARD))
151 /* return actual size without guard page */
152 return area->size - PAGE_SIZE;
158 extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
159 extern struct vm_struct *get_vm_area_caller(unsigned long size,
160 unsigned long flags, const void *caller);
161 extern struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags,
162 unsigned long start, unsigned long end);
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);
170 extern int map_vm_area(struct vm_struct *area, pgprot_t prot,
171 struct page **pages);
173 extern int map_kernel_range_noflush(unsigned long start, unsigned long size,
174 pgprot_t prot, 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;
192 unmap_kernel_range_noflush(unsigned long addr, unsigned long size)
196 unmap_kernel_range(unsigned long addr, unsigned long size)
199 static inline void set_vm_flush_reset_perms(void *addr)
204 /* Allocate/destroy a 'vmalloc' VM area. */
205 extern struct vm_struct *alloc_vm_area(size_t size, pte_t **ptes);
206 extern void free_vm_area(struct vm_struct *area);
209 extern long vread(char *buf, char *addr, unsigned long count);
210 extern long vwrite(char *buf, char *addr, unsigned long count);
213 * Internals. Dont't use..
215 extern struct list_head vmap_area_list;
216 extern __init void vm_area_add_early(struct vm_struct *vm);
217 extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);
221 struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets,
222 const size_t *sizes, int nr_vms,
225 void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
227 static inline struct vm_struct **
228 pcpu_get_vm_areas(const unsigned long *offsets,
229 const size_t *sizes, int nr_vms,
236 pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
243 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
245 #define VMALLOC_TOTAL 0UL
248 int register_vmap_purge_notifier(struct notifier_block *nb);
249 int unregister_vmap_purge_notifier(struct notifier_block *nb);
251 #endif /* _LINUX_VMALLOC_H */