xref: /linux-6.15/include/linux/vmalloc.h (revision 4f3dbdf4)
1 #ifndef _LINUX_VMALLOC_H
2 #define _LINUX_VMALLOC_H
3 
4 #include <linux/spinlock.h>
5 #include <linux/init.h>
6 #include <linux/list.h>
7 #include <linux/llist.h>
8 #include <asm/page.h>		/* pgprot_t */
9 #include <linux/rbtree.h>
10 
11 struct vm_area_struct;		/* vma defining user mapping in mm_types.h */
12 struct notifier_block;		/* in notifier.h */
13 
14 /* bits in flags of vmalloc's vm_struct below */
15 #define VM_IOREMAP		0x00000001	/* ioremap() and friends */
16 #define VM_ALLOC		0x00000002	/* vmalloc() */
17 #define VM_MAP			0x00000004	/* vmap()ed pages */
18 #define VM_USERMAP		0x00000008	/* suitable for remap_vmalloc_range */
19 #define VM_UNINITIALIZED	0x00000020	/* vm_struct is not fully initialized */
20 #define VM_NO_GUARD		0x00000040      /* don't add guard page */
21 #define VM_KASAN		0x00000080      /* has allocated kasan shadow memory */
22 /* bits [20..32] reserved for arch specific ioremap internals */
23 
24 /*
25  * Maximum alignment for ioremap() regions.
26  * Can be overriden by arch-specific value.
27  */
28 #ifndef IOREMAP_MAX_ORDER
29 #define IOREMAP_MAX_ORDER	(7 + PAGE_SHIFT)	/* 128 pages */
30 #endif
31 
32 struct vm_struct {
33 	struct vm_struct	*next;
34 	void			*addr;
35 	unsigned long		size;
36 	unsigned long		flags;
37 	struct page		**pages;
38 	unsigned int		nr_pages;
39 	phys_addr_t		phys_addr;
40 	const void		*caller;
41 };
42 
43 struct vmap_area {
44 	unsigned long va_start;
45 	unsigned long va_end;
46 	unsigned long flags;
47 	struct rb_node rb_node;         /* address sorted rbtree */
48 	struct list_head list;          /* address sorted list */
49 	struct llist_node purge_list;    /* "lazy purge" list */
50 	struct vm_struct *vm;
51 	struct rcu_head rcu_head;
52 };
53 
54 /*
55  *	Highlevel APIs for driver use
56  */
57 extern void vm_unmap_ram(const void *mem, unsigned int count);
58 extern void *vm_map_ram(struct page **pages, unsigned int count,
59 				int node, pgprot_t prot);
60 extern void vm_unmap_aliases(void);
61 
62 #ifdef CONFIG_MMU
63 extern void __init vmalloc_init(void);
64 #else
65 static inline void vmalloc_init(void)
66 {
67 }
68 #endif
69 
70 extern void *vmalloc(unsigned long size);
71 extern void *vzalloc(unsigned long size);
72 extern void *vmalloc_user(unsigned long size);
73 extern void *vmalloc_node(unsigned long size, int node);
74 extern void *vzalloc_node(unsigned long size, int node);
75 extern void *vmalloc_exec(unsigned long size);
76 extern void *vmalloc_32(unsigned long size);
77 extern void *vmalloc_32_user(unsigned long size);
78 extern void *__vmalloc(unsigned long size, gfp_t gfp_mask, pgprot_t prot);
79 extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
80 			unsigned long start, unsigned long end, gfp_t gfp_mask,
81 			pgprot_t prot, unsigned long vm_flags, int node,
82 			const void *caller);
83 
84 extern void vfree(const void *addr);
85 extern void vfree_atomic(const void *addr);
86 
87 extern void *vmap(struct page **pages, unsigned int count,
88 			unsigned long flags, pgprot_t prot);
89 extern void vunmap(const void *addr);
90 
91 extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
92 				       unsigned long uaddr, void *kaddr,
93 				       unsigned long size);
94 
95 extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
96 							unsigned long pgoff);
97 void vmalloc_sync_all(void);
98 
99 /*
100  *	Lowlevel-APIs (not for driver use!)
101  */
102 
103 static inline size_t get_vm_area_size(const struct vm_struct *area)
104 {
105 	if (!(area->flags & VM_NO_GUARD))
106 		/* return actual size without guard page */
107 		return area->size - PAGE_SIZE;
108 	else
109 		return area->size;
110 
111 }
112 
113 extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
114 extern struct vm_struct *get_vm_area_caller(unsigned long size,
115 					unsigned long flags, const void *caller);
116 extern struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags,
117 					unsigned long start, unsigned long end);
118 extern struct vm_struct *__get_vm_area_caller(unsigned long size,
119 					unsigned long flags,
120 					unsigned long start, unsigned long end,
121 					const void *caller);
122 extern struct vm_struct *remove_vm_area(const void *addr);
123 extern struct vm_struct *find_vm_area(const void *addr);
124 
125 extern int map_vm_area(struct vm_struct *area, pgprot_t prot,
126 			struct page **pages);
127 #ifdef CONFIG_MMU
128 extern int map_kernel_range_noflush(unsigned long start, unsigned long size,
129 				    pgprot_t prot, struct page **pages);
130 extern void unmap_kernel_range_noflush(unsigned long addr, unsigned long size);
131 extern void unmap_kernel_range(unsigned long addr, unsigned long size);
132 #else
133 static inline int
134 map_kernel_range_noflush(unsigned long start, unsigned long size,
135 			pgprot_t prot, struct page **pages)
136 {
137 	return size >> PAGE_SHIFT;
138 }
139 static inline void
140 unmap_kernel_range_noflush(unsigned long addr, unsigned long size)
141 {
142 }
143 static inline void
144 unmap_kernel_range(unsigned long addr, unsigned long size)
145 {
146 }
147 #endif
148 
149 /* Allocate/destroy a 'vmalloc' VM area. */
150 extern struct vm_struct *alloc_vm_area(size_t size, pte_t **ptes);
151 extern void free_vm_area(struct vm_struct *area);
152 
153 /* for /dev/kmem */
154 extern long vread(char *buf, char *addr, unsigned long count);
155 extern long vwrite(char *buf, char *addr, unsigned long count);
156 
157 /*
158  *	Internals.  Dont't use..
159  */
160 extern struct list_head vmap_area_list;
161 extern __init void vm_area_add_early(struct vm_struct *vm);
162 extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);
163 
164 #ifdef CONFIG_SMP
165 # ifdef CONFIG_MMU
166 struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets,
167 				     const size_t *sizes, int nr_vms,
168 				     size_t align);
169 
170 void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
171 # else
172 static inline struct vm_struct **
173 pcpu_get_vm_areas(const unsigned long *offsets,
174 		const size_t *sizes, int nr_vms,
175 		size_t align)
176 {
177 	return NULL;
178 }
179 
180 static inline void
181 pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
182 {
183 }
184 # endif
185 #endif
186 
187 #ifdef CONFIG_MMU
188 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
189 #else
190 #define VMALLOC_TOTAL 0UL
191 #endif
192 
193 int register_vmap_purge_notifier(struct notifier_block *nb);
194 int unregister_vmap_purge_notifier(struct notifier_block *nb);
195 
196 #endif /* _LINUX_VMALLOC_H */
197