include/linux/vmalloc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_VMALLOC_H
   3 #define _LINUX_VMALLOC_H
   4
   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>
  12
  13 #include <asm/vmalloc.h>
  14
  15 struct vm_area_struct;          /* vma defining user mapping in mm_types.h */
  16 struct notifier_block;          /* in notifier.h */
  17
  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 */
  27 #define VM_FLUSH_RESET_PERMS    0x00000100      /* reset direct map and flush TLB on unmap, can't be freed in atomic context */
  28 #define VM_MAP_PUT_PAGES        0x00000200      /* put pages and free array in vfree */
  29
  30 /*
  31  * VM_KASAN is used slighly differently depending on CONFIG_KASAN_VMALLOC.
  32  *
  33  * If IS_ENABLED(CONFIG_KASAN_VMALLOC), VM_KASAN is set on a vm_struct after
  34  * shadow memory has been mapped. It's used to handle allocation errors so that
  35  * we don't try to poision shadow on free if it was never allocated.
  36  *
  37  * Otherwise, VM_KASAN is set for kasan_module_alloc() allocations and used to
  38  * determine which allocations need the module shadow freed.
  39  */
  40
  41 /* bits [20..32] reserved for arch specific ioremap internals */
  42
  43 /*
  44  * Maximum alignment for ioremap() regions.
  45  * Can be overriden by arch-specific value.
  46  */
  47 #ifndef IOREMAP_MAX_ORDER
  48 #define IOREMAP_MAX_ORDER       (7 + PAGE_SHIFT)        /* 128 pages */
  49 #endif
  50
  51 struct vm_struct {
  52         struct vm_struct        *next;
  53         void                    *addr;
  54         unsigned long           size;
  55         unsigned long           flags;
  56         struct page             **pages;
  57         unsigned int            nr_pages;
  58         phys_addr_t             phys_addr;
  59         const void              *caller;
  60 };
  61
  62 struct vmap_area {
  63         unsigned long va_start;
  64         unsigned long va_end;
  65
  66         struct rb_node rb_node;         /* address sorted rbtree */
  67         struct list_head list;          /* address sorted list */
  68
  69         /*
  70          * The following two variables can be packed, because
  71          * a vmap_area object can be either:
  72          *    1) in "free" tree (root is vmap_area_root)
  73          *    2) or "busy" tree (root is free_vmap_area_root)
  74          */
  75         union {
  76                 unsigned long subtree_max_size; /* in "free" tree */
  77                 struct vm_struct *vm;           /* in "busy" tree */
  78         };
  79 };
  80
  81 /* archs that select HAVE_ARCH_HUGE_VMAP should override one or more of these */
  82 #ifndef arch_vmap_p4d_supported
  83 static inline bool arch_vmap_p4d_supported(pgprot_t prot)
  84 {
  85         return false;
  86 }
  87 #endif
  88
  89 #ifndef arch_vmap_pud_supported
  90 static inline bool arch_vmap_pud_supported(pgprot_t prot)
  91 {
  92         return false;
  93 }
  94 #endif
  95
  96 #ifndef arch_vmap_pmd_supported
  97 static inline bool arch_vmap_pmd_supported(pgprot_t prot)
  98 {
  99         return false;
 100 }
 101 #endif
 102
 103 /*
 104  *      Highlevel APIs for driver use
 105  */
 106 extern void vm_unmap_ram(const void *mem, unsigned int count);
 107 extern void *vm_map_ram(struct page **pages, unsigned int count, int node);
 108 extern void vm_unmap_aliases(void);
 109
 110 #ifdef CONFIG_MMU
 111 extern void __init vmalloc_init(void);
 112 extern unsigned long vmalloc_nr_pages(void);
 113 #else
 114 static inline void vmalloc_init(void)
 115 {
 116 }
 117 static inline unsigned long vmalloc_nr_pages(void) { return 0; }
 118 #endif
 119
 120 extern void *vmalloc(unsigned long size);
 121 extern void *vzalloc(unsigned long size);
 122 extern void *vmalloc_user(unsigned long size);
 123 extern void *vmalloc_node(unsigned long size, int node);
 124 extern void *vzalloc_node(unsigned long size, int node);
 125 extern void *vmalloc_32(unsigned long size);
 126 extern void *vmalloc_32_user(unsigned long size);
 127 extern void *__vmalloc(unsigned long size, gfp_t gfp_mask);
 128 extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
 129                         unsigned long start, unsigned long end, gfp_t gfp_mask,
 130                         pgprot_t prot, unsigned long vm_flags, int node,
 131                         const void *caller);
 132 void *__vmalloc_node(unsigned long size, unsigned long align, gfp_t gfp_mask,
 133                 int node, const void *caller);
 134
 135 extern void vfree(const void *addr);
 136 extern void vfree_atomic(const void *addr);
 137
 138 extern void *vmap(struct page **pages, unsigned int count,
 139                         unsigned long flags, pgprot_t prot);
 140 void *vmap_pfn(unsigned long *pfns, unsigned int count, pgprot_t prot);
 141 extern void vunmap(const void *addr);
 142
 143 extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
 144                                        unsigned long uaddr, void *kaddr,
 145                                        unsigned long pgoff, unsigned long size);
 146
 147 extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
 148                                                         unsigned long pgoff);
 149
 150 /*
 151  * Architectures can set this mask to a combination of PGTBL_P?D_MODIFIED values
 152  * and let generic vmalloc and ioremap code know when arch_sync_kernel_mappings()
 153  * needs to be called.
 154  */
 155 #ifndef ARCH_PAGE_TABLE_SYNC_MASK
 156 #define ARCH_PAGE_TABLE_SYNC_MASK 0
 157 #endif
 158
 159 /*
 160  * There is no default implementation for arch_sync_kernel_mappings(). It is
 161  * relied upon the compiler to optimize calls out if ARCH_PAGE_TABLE_SYNC_MASK
 162  * is 0.
 163  */
 164 void arch_sync_kernel_mappings(unsigned long start, unsigned long end);
 165
 166 /*
 167  *      Lowlevel-APIs (not for driver use!)
 168  */
 169
 170 static inline size_t get_vm_area_size(const struct vm_struct *area)
 171 {
 172         if (!(area->flags & VM_NO_GUARD))
 173                 /* return actual size without guard page */
 174                 return area->size - PAGE_SIZE;
 175         else
 176                 return area->size;
 177
 178 }
 179
 180 extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
 181 extern struct vm_struct *get_vm_area_caller(unsigned long size,
 182                                         unsigned long flags, const void *caller);
 183 extern struct vm_struct *__get_vm_area_caller(unsigned long size,
 184                                         unsigned long flags,
 185                                         unsigned long start, unsigned long end,
 186                                         const void *caller);
 187 void free_vm_area(struct vm_struct *area);
 188 extern struct vm_struct *remove_vm_area(const void *addr);
 189 extern struct vm_struct *find_vm_area(const void *addr);
 190
 191 #ifdef CONFIG_MMU
 192 int vmap_range(unsigned long addr, unsigned long end,
 193                         phys_addr_t phys_addr, pgprot_t prot,
 194                         unsigned int max_page_shift);
 195 extern int map_kernel_range_noflush(unsigned long start, unsigned long size,
 196                                     pgprot_t prot, struct page **pages);
 197 int map_kernel_range(unsigned long start, unsigned long size, pgprot_t prot,
 198                 struct page **pages);
 199 extern void unmap_kernel_range_noflush(unsigned long addr, unsigned long size);
 200 extern void unmap_kernel_range(unsigned long addr, unsigned long size);
 201 static inline void set_vm_flush_reset_perms(void *addr)
 202 {
 203         struct vm_struct *vm = find_vm_area(addr);
 204
 205         if (vm)
 206                 vm->flags |= VM_FLUSH_RESET_PERMS;
 207 }
 208 #else
 209 static inline int
 210 map_kernel_range_noflush(unsigned long start, unsigned long size,
 211                         pgprot_t prot, struct page **pages)
 212 {
 213         return size >> PAGE_SHIFT;
 214 }
 215 #define map_kernel_range map_kernel_range_noflush
 216 static inline void
 217 unmap_kernel_range_noflush(unsigned long addr, unsigned long size)
 218 {
 219 }
 220 #define unmap_kernel_range unmap_kernel_range_noflush
 221 static inline void set_vm_flush_reset_perms(void *addr)
 222 {
 223 }
 224 #endif
 225
 226 /* for /dev/kmem */
 227 extern long vread(char *buf, char *addr, unsigned long count);
 228 extern long vwrite(char *buf, char *addr, unsigned long count);
 229
 230 /*
 231  *      Internals.  Dont't use..
 232  */
 233 extern struct list_head vmap_area_list;
 234 extern __init void vm_area_add_early(struct vm_struct *vm);
 235 extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);
 236
 237 #ifdef CONFIG_SMP
 238 # ifdef CONFIG_MMU
 239 struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets,
 240                                      const size_t *sizes, int nr_vms,
 241                                      size_t align);
 242
 243 void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
 244 # else
 245 static inline struct vm_struct **
 246 pcpu_get_vm_areas(const unsigned long *offsets,
 247                 const size_t *sizes, int nr_vms,
 248                 size_t align)
 249 {
 250         return NULL;
 251 }
 252
 253 static inline void
 254 pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
 255 {
 256 }
 257 # endif
 258 #endif
 259
 260 #ifdef CONFIG_MMU
 261 #define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
 262 #else
 263 #define VMALLOC_TOTAL 0UL
 264 #endif
 265
 266 int register_vmap_purge_notifier(struct notifier_block *nb);
 267 int unregister_vmap_purge_notifier(struct notifier_block *nb);
 268
 269 #if defined(CONFIG_MMU) && defined(CONFIG_PRINTK)
 270 bool vmalloc_dump_obj(void *object);
 271 #else
 272 static inline bool vmalloc_dump_obj(void *object) { return false; }
 273 #endif
 274
 275 #endif /* _LINUX_VMALLOC_H */