[mirror_ubuntu-jammy-kernel.git] / include / linux / vmalloc.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_VMALLOC_H
#define _LINUX_VMALLOC_H

#include <linux/spinlock.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/llist.h>
#include <asm/page.h>		/* pgprot_t */
#include <linux/rbtree.h>
#include <linux/overflow.h>

struct vm_area_struct;		/* vma defining user mapping in mm_types.h */
struct notifier_block;		/* in notifier.h */

/* bits in flags of vmalloc's vm_struct below */
#define VM_IOREMAP		0x00000001	/* ioremap() and friends */
#define VM_ALLOC		0x00000002	/* vmalloc() */
#define VM_MAP			0x00000004	/* vmap()ed pages */
#define VM_USERMAP		0x00000008	/* suitable for remap_vmalloc_range */
#define VM_DMA_COHERENT		0x00000010	/* dma_alloc_coherent */
#define VM_UNINITIALIZED	0x00000020	/* vm_struct is not fully initialized */
#define VM_NO_GUARD		0x00000040      /* don't add guard page */
#define VM_KASAN		0x00000080      /* has allocated kasan shadow memory */
/*
 * Memory with VM_FLUSH_RESET_PERMS cannot be freed in an interrupt or with
 * vfree_atomic().
 */
#define VM_FLUSH_RESET_PERMS	0x00000100      /* Reset direct map and flush TLB on unmap */

/* bits [20..32] reserved for arch specific ioremap internals */

/*
 * Maximum alignment for ioremap() regions.
 * Can be overriden by arch-specific value.
 */
#ifndef IOREMAP_MAX_ORDER
#define IOREMAP_MAX_ORDER	(7 + PAGE_SHIFT)	/* 128 pages */
#endif

struct vm_struct {
	struct vm_struct	*next;
	void			*addr;
	unsigned long		size;
	unsigned long		flags;
	struct page		**pages;
	unsigned int		nr_pages;
	phys_addr_t		phys_addr;
	const void		*caller;
};

struct vmap_area {
	unsigned long va_start;
	unsigned long va_end;

	struct rb_node rb_node;         /* address sorted rbtree */
	struct list_head list;          /* address sorted list */

	/*
	 * The following three variables can be packed, because
	 * a vmap_area object is always one of the three states:
	 *    1) in "free" tree (root is vmap_area_root)
	 *    2) in "busy" tree (root is free_vmap_area_root)
	 *    3) in purge list  (head is vmap_purge_list)
	 */
	union {
		unsigned long subtree_max_size; /* in "free" tree */
		struct vm_struct *vm;           /* in "busy" tree */
		struct llist_node purge_list;   /* in purge list */
	};
};

/*
 *	Highlevel APIs for driver use
 */
extern void vm_unmap_ram(const void *mem, unsigned int count);
extern void *vm_map_ram(struct page **pages, unsigned int count,
				int node, pgprot_t prot);
extern void vm_unmap_aliases(void);

#ifdef CONFIG_MMU
extern void __init vmalloc_init(void);
extern unsigned long vmalloc_nr_pages(void);
#else
static inline void vmalloc_init(void)
{
}
static inline unsigned long vmalloc_nr_pages(void) { return 0; }
#endif

extern void *vmalloc(unsigned long size);
extern void *vzalloc(unsigned long size);
extern void *vmalloc_user(unsigned long size);
extern void *vmalloc_node(unsigned long size, int node);
extern void *vzalloc_node(unsigned long size, int node);
extern void *vmalloc_user_node_flags(unsigned long size, int node, gfp_t flags);
extern void *vmalloc_exec(unsigned long size);
extern void *vmalloc_32(unsigned long size);
extern void *vmalloc_32_user(unsigned long size);
extern void *__vmalloc(unsigned long size, gfp_t gfp_mask, pgprot_t prot);
extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
			unsigned long start, unsigned long end, gfp_t gfp_mask,
			pgprot_t prot, unsigned long vm_flags, int node,
			const void *caller);
#ifndef CONFIG_MMU
extern void *__vmalloc_node_flags(unsigned long size, int node, gfp_t flags);
static inline void *__vmalloc_node_flags_caller(unsigned long size, int node,
						gfp_t flags, void *caller)
{
	return __vmalloc_node_flags(size, node, flags);
}
#else
extern void *__vmalloc_node_flags_caller(unsigned long size,
					 int node, gfp_t flags, void *caller);
#endif

extern void vfree(const void *addr);
extern void vfree_atomic(const void *addr);

extern void *vmap(struct page **pages, unsigned int count,
			unsigned long flags, pgprot_t prot);
extern void vunmap(const void *addr);

extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
				       unsigned long uaddr, void *kaddr,
				       unsigned long size);

extern int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
							unsigned long pgoff);
void vmalloc_sync_all(void);
 
/*
 *	Lowlevel-APIs (not for driver use!)
 */

static inline size_t get_vm_area_size(const struct vm_struct *area)
{
	if (!(area->flags & VM_NO_GUARD))
		/* return actual size without guard page */
		return area->size - PAGE_SIZE;
	else
		return area->size;

}

extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
extern struct vm_struct *get_vm_area_caller(unsigned long size,
					unsigned long flags, const void *caller);
extern struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags,
					unsigned long start, unsigned long end);
extern struct vm_struct *__get_vm_area_caller(unsigned long size,
					unsigned long flags,
					unsigned long start, unsigned long end,
					const void *caller);
extern struct vm_struct *remove_vm_area(const void *addr);
extern struct vm_struct *find_vm_area(const void *addr);

extern int map_vm_area(struct vm_struct *area, pgprot_t prot,
			struct page **pages);
#ifdef CONFIG_MMU
extern int map_kernel_range_noflush(unsigned long start, unsigned long size,
				    pgprot_t prot, struct page **pages);
extern void unmap_kernel_range_noflush(unsigned long addr, unsigned long size);
extern void unmap_kernel_range(unsigned long addr, unsigned long size);
static inline void set_vm_flush_reset_perms(void *addr)
{
	struct vm_struct *vm = find_vm_area(addr);

	if (vm)
		vm->flags |= VM_FLUSH_RESET_PERMS;
}
#else
static inline int
map_kernel_range_noflush(unsigned long start, unsigned long size,
			pgprot_t prot, struct page **pages)
{
	return size >> PAGE_SHIFT;
}
static inline void
unmap_kernel_range_noflush(unsigned long addr, unsigned long size)
{
}
static inline void
unmap_kernel_range(unsigned long addr, unsigned long size)
{
}
static inline void set_vm_flush_reset_perms(void *addr)
{
}
#endif

/* Allocate/destroy a 'vmalloc' VM area. */
extern struct vm_struct *alloc_vm_area(size_t size, pte_t **ptes);
extern void free_vm_area(struct vm_struct *area);

/* for /dev/kmem */
extern long vread(char *buf, char *addr, unsigned long count);
extern long vwrite(char *buf, char *addr, unsigned long count);

/*
 *	Internals.  Dont't use..
 */
extern struct list_head vmap_area_list;
extern __init void vm_area_add_early(struct vm_struct *vm);
extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);

#ifdef CONFIG_SMP
# ifdef CONFIG_MMU
struct vm_struct **pcpu_get_vm_areas(const unsigned long *offsets,
				     const size_t *sizes, int nr_vms,
				     size_t align);

void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
# else
static inline struct vm_struct **
pcpu_get_vm_areas(const unsigned long *offsets,
		const size_t *sizes, int nr_vms,
		size_t align)
{
	return NULL;
}

static inline void
pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
{
}
# endif
#endif

#ifdef CONFIG_MMU
#define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
#else
#define VMALLOC_TOTAL 0UL
#endif

int register_vmap_purge_notifier(struct notifier_block *nb);
int unregister_vmap_purge_notifier(struct notifier_block *nb);

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