[mirror_ubuntu-eoan-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_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;

	/*
	 * Largest available free size in subtree.
	 */
	unsigned long subtree_max_size;
	unsigned long flags;
	struct rb_node rb_node;         /* address sorted rbtree */
	struct list_head list;          /* address sorted list */
	struct llist_node purge_list;    /* "lazy purge" list */
	struct vm_struct *vm;
};

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