[deliverable/linux.git] / include / linux / gfp.h

#ifndef __LINUX_GFP_H
#define __LINUX_GFP_H

#include <linux/mmzone.h>
#include <linux/stddef.h>
#include <linux/linkage.h>

struct vm_area_struct;

/*
 * GFP bitmasks..
 *
 * Zone modifiers (see linux/mmzone.h - low three bits)
 *
 * Do not put any conditional on these. If necessary modify the definitions
 * without the underscores and use the consistently. The definitions here may
 * be used in bit comparisons.
 */
#define __GFP_DMA	((__force gfp_t)0x01u)
#define __GFP_HIGHMEM	((__force gfp_t)0x02u)
#define __GFP_DMA32	((__force gfp_t)0x04u)

/*
 * Action modifiers - doesn't change the zoning
 *
 * __GFP_REPEAT: Try hard to allocate the memory, but the allocation attempt
 * _might_ fail.  This depends upon the particular VM implementation.
 *
 * __GFP_NOFAIL: The VM implementation _must_ retry infinitely: the caller
 * cannot handle allocation failures.
 *
 * __GFP_NORETRY: The VM implementation must not retry indefinitely.
 */
#define __GFP_WAIT	((__force gfp_t)0x10u)	/* Can wait and reschedule? */
#define __GFP_HIGH	((__force gfp_t)0x20u)	/* Should access emergency pools? */
#define __GFP_IO	((__force gfp_t)0x40u)	/* Can start physical IO? */
#define __GFP_FS	((__force gfp_t)0x80u)	/* Can call down to low-level FS? */
#define __GFP_COLD	((__force gfp_t)0x100u)	/* Cache-cold page required */
#define __GFP_NOWARN	((__force gfp_t)0x200u)	/* Suppress page allocation failure warning */
#define __GFP_REPEAT	((__force gfp_t)0x400u)	/* Retry the allocation.  Might fail */
#define __GFP_NOFAIL	((__force gfp_t)0x800u)	/* Retry for ever.  Cannot fail */
#define __GFP_NORETRY	((__force gfp_t)0x1000u)/* Do not retry.  Might fail */
#define __GFP_NO_GROW	((__force gfp_t)0x2000u)/* Slab internal usage */
#define __GFP_COMP	((__force gfp_t)0x4000u)/* Add compound page metadata */
#define __GFP_ZERO	((__force gfp_t)0x8000u)/* Return zeroed page on success */
#define __GFP_NOMEMALLOC ((__force gfp_t)0x10000u) /* Don't use emergency reserves */
#define __GFP_HARDWALL   ((__force gfp_t)0x20000u) /* Enforce hardwall cpuset memory allocs */
#define __GFP_THISNODE	((__force gfp_t)0x40000u)/* No fallback, no policies */

#define __GFP_BITS_SHIFT 20	/* Room for 20 __GFP_FOO bits */
#define __GFP_BITS_MASK ((__force gfp_t)((1 << __GFP_BITS_SHIFT) - 1))

/* if you forget to add the bitmask here kernel will crash, period */
#define GFP_LEVEL_MASK (__GFP_WAIT|__GFP_HIGH|__GFP_IO|__GFP_FS| \
			__GFP_COLD|__GFP_NOWARN|__GFP_REPEAT| \
			__GFP_NOFAIL|__GFP_NORETRY|__GFP_NO_GROW|__GFP_COMP| \
			__GFP_NOMEMALLOC|__GFP_HARDWALL|__GFP_THISNODE)

/* This equals 0, but use constants in case they ever change */
#define GFP_NOWAIT	(GFP_ATOMIC & ~__GFP_HIGH)
/* GFP_ATOMIC means both !wait (__GFP_WAIT not set) and use emergency pool */
#define GFP_ATOMIC	(__GFP_HIGH)
#define GFP_NOIO	(__GFP_WAIT)
#define GFP_NOFS	(__GFP_WAIT | __GFP_IO)
#define GFP_KERNEL	(__GFP_WAIT | __GFP_IO | __GFP_FS)
#define GFP_USER	(__GFP_WAIT | __GFP_IO | __GFP_FS | __GFP_HARDWALL)
#define GFP_HIGHUSER	(__GFP_WAIT | __GFP_IO | __GFP_FS | __GFP_HARDWALL | \
			 __GFP_HIGHMEM)

#ifdef CONFIG_NUMA
#define GFP_THISNODE	(__GFP_THISNODE | __GFP_NOWARN | __GFP_NORETRY)
#else
#define GFP_THISNODE	((__force gfp_t)0)
#endif


/* Flag - indicates that the buffer will be suitable for DMA.  Ignored on some
   platforms, used as appropriate on others */

#define GFP_DMA		__GFP_DMA

/* 4GB DMA on some platforms */
#define GFP_DMA32	__GFP_DMA32


static inline enum zone_type gfp_zone(gfp_t flags)
{
#ifdef CONFIG_ZONE_DMA
	if (flags & __GFP_DMA)
		return ZONE_DMA;
#endif
#ifdef CONFIG_ZONE_DMA32
	if (flags & __GFP_DMA32)
		return ZONE_DMA32;
#endif
#ifdef CONFIG_HIGHMEM
	if (flags & __GFP_HIGHMEM)
		return ZONE_HIGHMEM;
#endif
	return ZONE_NORMAL;
}

/*
 * There is only one page-allocator function, and two main namespaces to
 * it. The alloc_page*() variants return 'struct page *' and as such
 * can allocate highmem pages, the *get*page*() variants return
 * virtual kernel addresses to the allocated page(s).
 */

/*
 * We get the zone list from the current node and the gfp_mask.
 * This zone list contains a maximum of MAXNODES*MAX_NR_ZONES zones.
 *
 * For the normal case of non-DISCONTIGMEM systems the NODE_DATA() gets
 * optimized to &contig_page_data at compile-time.
 */

#ifndef HAVE_ARCH_FREE_PAGE
static inline void arch_free_page(struct page *page, int order) { }
#endif
#ifndef HAVE_ARCH_ALLOC_PAGE
static inline void arch_alloc_page(struct page *page, int order) { }
#endif

extern struct page *
FASTCALL(__alloc_pages(gfp_t, unsigned int, struct zonelist *));

static inline struct page *alloc_pages_node(int nid, gfp_t gfp_mask,
						unsigned int order)
{
	if (unlikely(order >= MAX_ORDER))
		return NULL;

	/* Unknown node is current node */
	if (nid < 0)
		nid = numa_node_id();

	return __alloc_pages(gfp_mask, order,
		NODE_DATA(nid)->node_zonelists + gfp_zone(gfp_mask));
}

#ifdef CONFIG_NUMA
extern struct page *alloc_pages_current(gfp_t gfp_mask, unsigned order);

static inline struct page *
alloc_pages(gfp_t gfp_mask, unsigned int order)
{
	if (unlikely(order >= MAX_ORDER))
		return NULL;

	return alloc_pages_current(gfp_mask, order);
}
extern struct page *alloc_page_vma(gfp_t gfp_mask,
			struct vm_area_struct *vma, unsigned long addr);
#else
#define alloc_pages(gfp_mask, order) \
		alloc_pages_node(numa_node_id(), gfp_mask, order)
#define alloc_page_vma(gfp_mask, vma, addr) alloc_pages(gfp_mask, 0)
#endif
#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)

extern unsigned long FASTCALL(__get_free_pages(gfp_t gfp_mask, unsigned int order));
extern unsigned long FASTCALL(get_zeroed_page(gfp_t gfp_mask));

#define __get_free_page(gfp_mask) \
		__get_free_pages((gfp_mask),0)

#define __get_dma_pages(gfp_mask, order) \
		__get_free_pages((gfp_mask) | GFP_DMA,(order))

extern void FASTCALL(__free_pages(struct page *page, unsigned int order));
extern void FASTCALL(free_pages(unsigned long addr, unsigned int order));
extern void FASTCALL(free_hot_page(struct page *page));
extern void FASTCALL(free_cold_page(struct page *page));

#define __free_page(page) __free_pages((page), 0)
#define free_page(addr) free_pages((addr),0)

void page_alloc_init(void);
#ifdef CONFIG_NUMA
void drain_node_pages(int node);
#else
static inline void drain_node_pages(int node) { };
#endif

#endif /* __LINUX_GFP_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __LINUX_GFP_H
	2	#define __LINUX_GFP_H
	3
	4	#include <linux/mmzone.h>
	5	#include <linux/stddef.h>
	6	#include <linux/linkage.h>
1da177e4 LT	7
	8	struct vm_area_struct;
	9
	10	/*
	11	* GFP bitmasks..
e53ef38d CL	12	*
	13	* Zone modifiers (see linux/mmzone.h - low three bits)
	14	*
e53ef38d CL	15	* Do not put any conditional on these. If necessary modify the definitions
	16	* without the underscores and use the consistently. The definitions here may
	17	* be used in bit comparisons.
1da177e4	18	*/
af4ca457 AV	19	#define __GFP_DMA ((__force gfp_t)0x01u)
af4ca457 AV	20	#define __GFP_HIGHMEM ((__force gfp_t)0x02u)
e53ef38d	21	#define __GFP_DMA32 ((__force gfp_t)0x04u)
1da177e4 LT	22
	23	/*
	24	* Action modifiers - doesn't change the zoning
	25	*
	26	* __GFP_REPEAT: Try hard to allocate the memory, but the allocation attempt
	27	* _might_ fail. This depends upon the particular VM implementation.
	28	*
	29	* __GFP_NOFAIL: The VM implementation _must_ retry infinitely: the caller
	30	* cannot handle allocation failures.
	31	*
	32	* __GFP_NORETRY: The VM implementation must not retry indefinitely.
	33	*/
af4ca457 AV	34	#define __GFP_WAIT ((__force gfp_t)0x10u) /* Can wait and reschedule? */
	35	#define __GFP_HIGH ((__force gfp_t)0x20u) /* Should access emergency pools? */
	36	#define __GFP_IO ((__force gfp_t)0x40u) /* Can start physical IO? */
	37	#define __GFP_FS ((__force gfp_t)0x80u) /* Can call down to low-level FS? */
	38	#define __GFP_COLD ((__force gfp_t)0x100u) /* Cache-cold page required */
	39	#define __GFP_NOWARN ((__force gfp_t)0x200u) /* Suppress page allocation failure warning */
	40	#define __GFP_REPEAT ((__force gfp_t)0x400u) /* Retry the allocation. Might fail */
	41	#define __GFP_NOFAIL ((__force gfp_t)0x800u) /* Retry for ever. Cannot fail */
	42	#define __GFP_NORETRY ((__force gfp_t)0x1000u)/* Do not retry. Might fail */
	43	#define __GFP_NO_GROW ((__force gfp_t)0x2000u)/* Slab internal usage */
	44	#define __GFP_COMP ((__force gfp_t)0x4000u)/* Add compound page metadata */
	45	#define __GFP_ZERO ((__force gfp_t)0x8000u)/* Return zeroed page on success */
	46	#define __GFP_NOMEMALLOC ((__force gfp_t)0x10000u) /* Don't use emergency reserves */
2d6c666e	47	#define __GFP_HARDWALL ((__force gfp_t)0x20000u) /* Enforce hardwall cpuset memory allocs */
9b819d20	48	#define __GFP_THISNODE ((__force gfp_t)0x40000u)/* No fallback, no policies */
1da177e4	49
b84a35be	50	#define __GFP_BITS_SHIFT 20 /* Room for 20 __GFP_FOO bits */
af4ca457	51	#define __GFP_BITS_MASK ((__force gfp_t)((1 << __GFP_BITS_SHIFT) - 1))
1da177e4 LT	52
	53	/* if you forget to add the bitmask here kernel will crash, period */
	54	#define GFP_LEVEL_MASK (__GFP_WAIT\|__GFP_HIGH\|__GFP_IO\|__GFP_FS\| \
	55	__GFP_COLD\|__GFP_NOWARN\|__GFP_REPEAT\| \
b84a35be	56	__GFP_NOFAIL\|__GFP_NORETRY\|__GFP_NO_GROW\|__GFP_COMP\| \
9b819d20	57	__GFP_NOMEMALLOC\|__GFP_HARDWALL\|__GFP_THISNODE)
1da177e4	58
7b04d717 JD	59	/* This equals 0, but use constants in case they ever change */
7b04d717 JD	60	#define GFP_NOWAIT (GFP_ATOMIC & ~__GFP_HIGH)
4eac915d	61	/* GFP_ATOMIC means both !wait (__GFP_WAIT not set) and use emergency pool */
1da177e4 LT	62	#define GFP_ATOMIC (__GFP_HIGH)
	63	#define GFP_NOIO (__GFP_WAIT)
	64	#define GFP_NOFS (__GFP_WAIT \| __GFP_IO)
	65	#define GFP_KERNEL (__GFP_WAIT \| __GFP_IO \| __GFP_FS)
f90b1d2f PJ	66	#define GFP_USER (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| __GFP_HARDWALL)
	67	#define GFP_HIGHUSER (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| __GFP_HARDWALL \| \
	68	__GFP_HIGHMEM)
1da177e4	69
77f700da	70	#ifdef CONFIG_NUMA
980128f2	71	#define GFP_THISNODE (__GFP_THISNODE \| __GFP_NOWARN \| __GFP_NORETRY)
77f700da	72	#else
f2e97df6	73	#define GFP_THISNODE ((__force gfp_t)0)
77f700da CL	74	#endif
77f700da CL	75
980128f2	76
1da177e4 LT	77	/* Flag - indicates that the buffer will be suitable for DMA. Ignored on some
	78	platforms, used as appropriate on others */
	79
	80	#define GFP_DMA __GFP_DMA
	81
a2f1b424 AK	82	/* 4GB DMA on some platforms */
	83	#define GFP_DMA32 __GFP_DMA32
	84
	85
19655d34	86	static inline enum zone_type gfp_zone(gfp_t flags)
4e4785bc	87	{
4b51d669	88	#ifdef CONFIG_ZONE_DMA
4e4785bc CL	89	if (flags & __GFP_DMA)
4e4785bc CL	90	return ZONE_DMA;
4b51d669	91	#endif
4e4785bc CL	92	#ifdef CONFIG_ZONE_DMA32
	93	if (flags & __GFP_DMA32)
	94	return ZONE_DMA32;
	95	#endif
	96	#ifdef CONFIG_HIGHMEM
	97	if (flags & __GFP_HIGHMEM)
	98	return ZONE_HIGHMEM;
	99	#endif
	100	return ZONE_NORMAL;
	101	}
	102
1da177e4 LT	103	/*
	104	* There is only one page-allocator function, and two main namespaces to
	105	* it. The alloc_page() variants return 'struct page ' and as such
	106	* can allocate highmem pages, the getpage*() variants return
	107	* virtual kernel addresses to the allocated page(s).
	108	*/
	109
	110	/*
	111	* We get the zone list from the current node and the gfp_mask.
	112	* This zone list contains a maximum of MAXNODES*MAX_NR_ZONES zones.
	113	*
	114	* For the normal case of non-DISCONTIGMEM systems the NODE_DATA() gets
	115	* optimized to &contig_page_data at compile-time.
	116	*/
	117
	118	#ifndef HAVE_ARCH_FREE_PAGE
	119	static inline void arch_free_page(struct page *page, int order) { }
	120	#endif
cc102509 NP	121	#ifndef HAVE_ARCH_ALLOC_PAGE
	122	static inline void arch_alloc_page(struct page *page, int order) { }
	123	#endif
1da177e4 LT	124
1da177e4 LT	125	extern struct page *
dd0fc66f	126	FASTCALL(__alloc_pages(gfp_t, unsigned int, struct zonelist *));
1da177e4	127
dd0fc66f	128	static inline struct page *alloc_pages_node(int nid, gfp_t gfp_mask,
1da177e4 LT	129	unsigned int order)
	130	{
	131	if (unlikely(order >= MAX_ORDER))
	132	return NULL;
	133
819a6928 AK	134	/* Unknown node is current node */
	135	if (nid < 0)
	136	nid = numa_node_id();
	137
1da177e4	138	return __alloc_pages(gfp_mask, order,
af4ca457	139	NODE_DATA(nid)->node_zonelists + gfp_zone(gfp_mask));
1da177e4 LT	140	}
	141
	142	#ifdef CONFIG_NUMA
dd0fc66f	143	extern struct page *alloc_pages_current(gfp_t gfp_mask, unsigned order);
1da177e4 LT	144
1da177e4 LT	145	static inline struct page *
dd0fc66f	146	alloc_pages(gfp_t gfp_mask, unsigned int order)
1da177e4 LT	147	{
	148	if (unlikely(order >= MAX_ORDER))
	149	return NULL;
	150
	151	return alloc_pages_current(gfp_mask, order);
	152	}
dd0fc66f	153	extern struct page *alloc_page_vma(gfp_t gfp_mask,
1da177e4 LT	154	struct vm_area_struct *vma, unsigned long addr);
	155	#else
	156	#define alloc_pages(gfp_mask, order) \
	157	alloc_pages_node(numa_node_id(), gfp_mask, order)
	158	#define alloc_page_vma(gfp_mask, vma, addr) alloc_pages(gfp_mask, 0)
	159	#endif
	160	#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)
	161
dd0fc66f AV	162	extern unsigned long FASTCALL(__get_free_pages(gfp_t gfp_mask, unsigned int order));
dd0fc66f AV	163	extern unsigned long FASTCALL(get_zeroed_page(gfp_t gfp_mask));
1da177e4 LT	164
	165	#define __get_free_page(gfp_mask) \
	166	__get_free_pages((gfp_mask),0)
	167
	168	#define __get_dma_pages(gfp_mask, order) \
	169	__get_free_pages((gfp_mask) \| GFP_DMA,(order))
	170
	171	extern void FASTCALL(__free_pages(struct page *page, unsigned int order));
	172	extern void FASTCALL(free_pages(unsigned long addr, unsigned int order));
	173	extern void FASTCALL(free_hot_page(struct page *page));
	174	extern void FASTCALL(free_cold_page(struct page *page));
	175
	176	#define __free_page(page) __free_pages((page), 0)
	177	#define free_page(addr) free_pages((addr),0)
	178
	179	void page_alloc_init(void);
4ae7c039	180	#ifdef CONFIG_NUMA
8fce4d8e	181	void drain_node_pages(int node);
4ae7c039	182	#else
8fce4d8e	183	static inline void drain_node_pages(int node) { };
4ae7c039	184	#endif
1da177e4 LT	185
1da177e4 LT	186	#endif /* __LINUX_GFP_H */