[linux-2.6-block.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 <asm/page.h>		/* pgprot_t */
#include <linux/rbtree.h>

struct vm_area_struct;		/* vma defining user mapping in mm_types.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_VPAGES		0x00000010	/* buffer for pages was vmalloc'ed */
#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 list_head 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);

extern void vfree(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

struct vmalloc_info {
	unsigned long   used;
	unsigned long   largest_chunk;
};

#ifdef CONFIG_MMU
#define VMALLOC_TOTAL (VMALLOC_END - VMALLOC_START)
extern void get_vmalloc_info(struct vmalloc_info *vmi);
#else

#define VMALLOC_TOTAL 0UL
#define get_vmalloc_info(vmi)			\
do {						\
	(vmi)->used = 0;			\
	(vmi)->largest_chunk = 0;		\
} while (0)
#endif

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