[mirror_ubuntu-bionic-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>

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 */
/* 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;
	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;
	struct rcu_head rcu_head;
};

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