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

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