[linux-block.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;

	/*
	 * 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);
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_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 URS	55
	56	/*
	57	* Largest available free size in subtree.
	58	*/
	59	unsigned long subtree_max_size;
13ba3fcb AK	60	unsigned long flags;
	61	struct rb_node rb_node; /* address sorted rbtree */
	62	struct list_head list; /* address sorted list */
80c4bd7a	63	struct llist_node purge_list; /* "lazy purge" list */
13ba3fcb	64	struct vm_struct *vm;
13ba3fcb AK	65	};
13ba3fcb AK	66
1da177e4 LT	67	/*
	68	* Highlevel APIs for driver use
	69	*/
db64fe02 NP	70	extern void vm_unmap_ram(const void *mem, unsigned int count);
	71	extern void vm_map_ram(struct page *pages, unsigned int count,
	72	int node, pgprot_t prot);
	73	extern void vm_unmap_aliases(void);
	74
	75	#ifdef CONFIG_MMU
	76	extern void __init vmalloc_init(void);
97105f0a	77	extern unsigned long vmalloc_nr_pages(void);
db64fe02 NP	78	#else
	79	static inline void vmalloc_init(void)
	80	{
	81	}
97105f0a	82	static inline unsigned long vmalloc_nr_pages(void) { return 0; }
db64fe02 NP	83	#endif
db64fe02 NP	84
1da177e4	85	extern void *vmalloc(unsigned long size);
e1ca7788	86	extern void *vzalloc(unsigned long size);
83342314	87	extern void *vmalloc_user(unsigned long size);
930fc45a	88	extern void *vmalloc_node(unsigned long size, int node);
e1ca7788	89	extern void *vzalloc_node(unsigned long size, int node);
1da177e4 LT	90	extern void *vmalloc_exec(unsigned long size);
1da177e4 LT	91	extern void *vmalloc_32(unsigned long size);
83342314	92	extern void *vmalloc_32_user(unsigned long size);
dd0fc66f	93	extern void *__vmalloc(unsigned long size, gfp_t gfp_mask, pgprot_t prot);
d0a21265 DR	94	extern void *__vmalloc_node_range(unsigned long size, unsigned long align,
d0a21265 DR	95	unsigned long start, unsigned long end, gfp_t gfp_mask,
cb9e3c29 AR	96	pgprot_t prot, unsigned long vm_flags, int node,
cb9e3c29 AR	97	const void *caller);
1f5307b1	98	#ifndef CONFIG_MMU
a7c3e901	99	extern void *__vmalloc_node_flags(unsigned long size, int node, gfp_t flags);
8594a21c MH	100	static inline void *__vmalloc_node_flags_caller(unsigned long size, int node,
8594a21c MH	101	gfp_t flags, void *caller)
1f5307b1	102	{
8594a21c	103	return __vmalloc_node_flags(size, node, flags);
1f5307b1	104	}
8594a21c MH	105	#else
	106	extern void *__vmalloc_node_flags_caller(unsigned long size,
	107	int node, gfp_t flags, void *caller);
1f5307b1	108	#endif
cb9e3c29	109
b3bdda02	110	extern void vfree(const void *addr);
bf22e37a	111	extern void vfree_atomic(const void *addr);
1da177e4 LT	112
	113	extern void vmap(struct page *pages, unsigned int count,
	114	unsigned long flags, pgprot_t prot);
b3bdda02	115	extern void vunmap(const void *addr);
83342314	116
e69e9d4a HD	117	extern int remap_vmalloc_range_partial(struct vm_area_struct *vma,
	118	unsigned long uaddr, void *kaddr,
	119	unsigned long size);
	120
83342314 NP	121	extern int remap_vmalloc_range(struct vm_area_struct vma, void addr,
83342314 NP	122	unsigned long pgoff);
1eeb66a1	123	void vmalloc_sync_all(void);
1da177e4 LT	124
	125	/*
	126	* Lowlevel-APIs (not for driver use!)
	127	*/
9585116b JF	128
	129	static inline size_t get_vm_area_size(const struct vm_struct *area)
	130	{
71394fe5 AR	131	if (!(area->flags & VM_NO_GUARD))
	132	/* return actual size without guard page */
	133	return area->size - PAGE_SIZE;
	134	else
	135	return area->size;
	136
9585116b JF	137	}
9585116b JF	138
1da177e4	139	extern struct vm_struct *get_vm_area(unsigned long size, unsigned long flags);
23016969	140	extern struct vm_struct *get_vm_area_caller(unsigned long size,
5e6cafc8	141	unsigned long flags, const void *caller);
1da177e4 LT	142	extern struct vm_struct *__get_vm_area(unsigned long size, unsigned long flags,
1da177e4 LT	143	unsigned long start, unsigned long end);
c2968612 BH	144	extern struct vm_struct *__get_vm_area_caller(unsigned long size,
	145	unsigned long flags,
	146	unsigned long start, unsigned long end,
5e6cafc8	147	const void *caller);
b3bdda02	148	extern struct vm_struct remove_vm_area(const void addr);
e9da6e99	149	extern struct vm_struct find_vm_area(const void addr);
c19c03fc	150
1da177e4	151	extern int map_vm_area(struct vm_struct *area, pgprot_t prot,
f6f8ed47	152	struct page **pages);
b554cb42	153	#ifdef CONFIG_MMU
8fc48985 TH	154	extern int map_kernel_range_noflush(unsigned long start, unsigned long size,
	155	pgprot_t prot, struct page **pages);
	156	extern void unmap_kernel_range_noflush(unsigned long addr, unsigned long size);
c19c03fc	157	extern void unmap_kernel_range(unsigned long addr, unsigned long size);
868b104d RE	158	static inline void set_vm_flush_reset_perms(void *addr)
	159	{
	160	struct vm_struct *vm = find_vm_area(addr);
	161
	162	if (vm)
	163	vm->flags \|= VM_FLUSH_RESET_PERMS;
	164	}
b554cb42 GY	165	#else
	166	static inline int
	167	map_kernel_range_noflush(unsigned long start, unsigned long size,
	168	pgprot_t prot, struct page **pages)
	169	{
	170	return size >> PAGE_SHIFT;
	171	}
	172	static inline void
	173	unmap_kernel_range_noflush(unsigned long addr, unsigned long size)
	174	{
	175	}
	176	static inline void
	177	unmap_kernel_range(unsigned long addr, unsigned long size)
	178	{
	179	}
868b104d RE	180	static inline void set_vm_flush_reset_perms(void *addr)
	181	{
	182	}
b554cb42	183	#endif
1da177e4	184
5f4352fb	185	/* Allocate/destroy a 'vmalloc' VM area. */
cd12909c	186	extern struct vm_struct alloc_vm_area(size_t size, pte_t *ptes);
5f4352fb JF	187	extern void free_vm_area(struct vm_struct *area);
5f4352fb JF	188
69beeb1d KM	189	/* for /dev/kmem */
	190	extern long vread(char buf, char addr, unsigned long count);
	191	extern long vwrite(char buf, char addr, unsigned long count);
	192
1da177e4 LT	193	/*
	194	* Internals. Dont't use..
	195	*/
f1c4069e	196	extern struct list_head vmap_area_list;
be9b7335	197	extern __init void vm_area_add_early(struct vm_struct *vm);
c0c0a293	198	extern __init void vm_area_register_early(struct vm_struct *vm, size_t align);
1da177e4	199
4f8b02b4	200	#ifdef CONFIG_SMP
b554cb42	201	# ifdef CONFIG_MMU
ca23e405 TH	202	struct vm_struct *pcpu_get_vm_areas(const unsigned long offsets,
ca23e405 TH	203	const size_t *sizes, int nr_vms,
ec3f64fc	204	size_t align);
ca23e405 TH	205
ca23e405 TH	206	void pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms);
b554cb42 GY	207	# else
	208	static inline struct vm_struct **
	209	pcpu_get_vm_areas(const unsigned long *offsets,
	210	const size_t *sizes, int nr_vms,
	211	size_t align)
	212	{
	213	return NULL;
	214	}
	215
	216	static inline void
	217	pcpu_free_vm_areas(struct vm_struct **vms, int nr_vms)
	218	{
	219	}
	220	# endif
4f8b02b4	221	#endif
ca23e405	222
db3808c1 JK	223	#ifdef CONFIG_MMU
db3808c1 JK	224	#define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
db3808c1	225	#else
db3808c1	226	#define VMALLOC_TOTAL 0UL
db3808c1 JK	227	#endif
db3808c1 JK	228
4da56b99 CW	229	int register_vmap_purge_notifier(struct notifier_block *nb);
	230	int unregister_vmap_purge_notifier(struct notifier_block *nb);
	231
1da177e4	232	#endif /* _LINUX_VMALLOC_H */