[mirror_ubuntu-bionic-kernel.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.
 *
 * __GFP_MOVABLE: Flag that this page will be movable by the page migration
 * mechanism or reclaimed
 */
#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_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_MOVABLE	((__force gfp_t)0x80000u) /* Page is movable */

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

/* 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)
#define GFP_HIGHUSER_MOVABLE	(__GFP_WAIT | __GFP_IO | __GFP_FS | \
				 __GFP_HARDWALL | __GFP_HIGHMEM | \
				 __GFP_MOVABLE)
#define GFP_NOFS_PAGECACHE	(__GFP_WAIT | __GFP_IO | __GFP_MOVABLE)
#define GFP_USER_PAGECACHE	(__GFP_WAIT | __GFP_IO | __GFP_FS | \
				 __GFP_HARDWALL | __GFP_MOVABLE)
#define GFP_HIGHUSER_PAGECACHE	(__GFP_WAIT | __GFP_IO | __GFP_FS | \
				 __GFP_HARDWALL | __GFP_HIGHMEM | \
				 __GFP_MOVABLE)

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

/* This mask makes up all the page movable related flags */
#define GFP_MOVABLE_MASK (__GFP_MOVABLE)

/* Control page allocator reclaim behavior */
#define GFP_RECLAIM_MASK (__GFP_WAIT|__GFP_HIGH|__GFP_IO|__GFP_FS|\
			__GFP_NOWARN|__GFP_REPEAT|__GFP_NOFAIL|\
			__GFP_NORETRY|__GFP_NOMEMALLOC)

/* Control allocation constraints */
#define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)

/* Do not use these with a slab allocator */
#define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)

/* 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)
{
	int base = 0;

#ifdef CONFIG_NUMA
	if (flags & __GFP_THISNODE)
		base = MAX_NR_ZONES;
#endif

#ifdef CONFIG_ZONE_DMA
	if (flags & __GFP_DMA)
		return base + ZONE_DMA;
#endif
#ifdef CONFIG_ZONE_DMA32
	if (flags & __GFP_DMA32)
		return base + ZONE_DMA32;
#endif
	if ((flags & (__GFP_HIGHMEM | __GFP_MOVABLE)) ==
			(__GFP_HIGHMEM | __GFP_MOVABLE))
		return base + ZONE_MOVABLE;
#ifdef CONFIG_HIGHMEM
	if (flags & __GFP_HIGHMEM)
		return base + ZONE_HIGHMEM;
#endif
	return base + 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);
void drain_zone_pages(struct zone *zone, struct per_cpu_pages *pcp);

#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.
769848c0 MG	33	*
	34	* __GFP_MOVABLE: Flag that this page will be movable by the page migration
	35	* mechanism or reclaimed
1da177e4	36	*/
af4ca457 AV	37	#define __GFP_WAIT ((__force gfp_t)0x10u) /* Can wait and reschedule? */
	38	#define __GFP_HIGH ((__force gfp_t)0x20u) /* Should access emergency pools? */
	39	#define __GFP_IO ((__force gfp_t)0x40u) /* Can start physical IO? */
	40	#define __GFP_FS ((__force gfp_t)0x80u) /* Can call down to low-level FS? */
	41	#define __GFP_COLD ((__force gfp_t)0x100u) /* Cache-cold page required */
	42	#define __GFP_NOWARN ((__force gfp_t)0x200u) /* Suppress page allocation failure warning */
	43	#define __GFP_REPEAT ((__force gfp_t)0x400u) /* Retry the allocation. Might fail */
	44	#define __GFP_NOFAIL ((__force gfp_t)0x800u) /* Retry for ever. Cannot fail */
	45	#define __GFP_NORETRY ((__force gfp_t)0x1000u)/* Do not retry. Might fail */
af4ca457 AV	46	#define __GFP_COMP ((__force gfp_t)0x4000u)/* Add compound page metadata */
	47	#define __GFP_ZERO ((__force gfp_t)0x8000u)/* Return zeroed page on success */
	48	#define __GFP_NOMEMALLOC ((__force gfp_t)0x10000u) /* Don't use emergency reserves */
2d6c666e	49	#define __GFP_HARDWALL ((__force gfp_t)0x20000u) /* Enforce hardwall cpuset memory allocs */
9b819d20	50	#define __GFP_THISNODE ((__force gfp_t)0x40000u)/* No fallback, no policies */
769848c0	51	#define __GFP_MOVABLE ((__force gfp_t)0x80000u) /* Page is movable */
1da177e4	52
b84a35be	53	#define __GFP_BITS_SHIFT 20 /* Room for 20 __GFP_FOO bits */
af4ca457	54	#define __GFP_BITS_MASK ((__force gfp_t)((1 << __GFP_BITS_SHIFT) - 1))
1da177e4	55
7b04d717 JD	56	/* This equals 0, but use constants in case they ever change */
7b04d717 JD	57	#define GFP_NOWAIT (GFP_ATOMIC & ~__GFP_HIGH)
4eac915d	58	/* GFP_ATOMIC means both !wait (__GFP_WAIT not set) and use emergency pool */
1da177e4 LT	59	#define GFP_ATOMIC (__GFP_HIGH)
	60	#define GFP_NOIO (__GFP_WAIT)
	61	#define GFP_NOFS (__GFP_WAIT \| __GFP_IO)
	62	#define GFP_KERNEL (__GFP_WAIT \| __GFP_IO \| __GFP_FS)
f90b1d2f PJ	63	#define GFP_USER (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| __GFP_HARDWALL)
	64	#define GFP_HIGHUSER (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| __GFP_HARDWALL \| \
	65	__GFP_HIGHMEM)
769848c0 MG	66	#define GFP_HIGHUSER_MOVABLE (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| \
	67	__GFP_HARDWALL \| __GFP_HIGHMEM \| \
	68	__GFP_MOVABLE)
	69	#define GFP_NOFS_PAGECACHE (__GFP_WAIT \| __GFP_IO \| __GFP_MOVABLE)
	70	#define GFP_USER_PAGECACHE (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| \
	71	__GFP_HARDWALL \| __GFP_MOVABLE)
	72	#define GFP_HIGHUSER_PAGECACHE (__GFP_WAIT \| __GFP_IO \| __GFP_FS \| \
	73	__GFP_HARDWALL \| __GFP_HIGHMEM \| \
	74	__GFP_MOVABLE)
1da177e4	75
77f700da	76	#ifdef CONFIG_NUMA
980128f2	77	#define GFP_THISNODE (__GFP_THISNODE \| __GFP_NOWARN \| __GFP_NORETRY)
77f700da	78	#else
f2e97df6	79	#define GFP_THISNODE ((__force gfp_t)0)
77f700da CL	80	#endif
77f700da CL	81
6cb06229 CL	82	/* This mask makes up all the page movable related flags */
	83	#define GFP_MOVABLE_MASK (__GFP_MOVABLE)
	84
	85	/* Control page allocator reclaim behavior */
	86	#define GFP_RECLAIM_MASK (__GFP_WAIT\|__GFP_HIGH\|__GFP_IO\|__GFP_FS\|\
	87	__GFP_NOWARN\|__GFP_REPEAT\|__GFP_NOFAIL\|\
	88	__GFP_NORETRY\|__GFP_NOMEMALLOC)
	89
	90	/* Control allocation constraints */
	91	#define GFP_CONSTRAINT_MASK (__GFP_HARDWALL\|__GFP_THISNODE)
	92
	93	/* Do not use these with a slab allocator */
	94	#define GFP_SLAB_BUG_MASK (__GFP_DMA32\|__GFP_HIGHMEM\|~__GFP_BITS_MASK)
980128f2	95
1da177e4 LT	96	/* Flag - indicates that the buffer will be suitable for DMA. Ignored on some
	97	platforms, used as appropriate on others */
	98
	99	#define GFP_DMA __GFP_DMA
	100
a2f1b424 AK	101	/* 4GB DMA on some platforms */
	102	#define GFP_DMA32 __GFP_DMA32
	103
	104
19655d34	105	static inline enum zone_type gfp_zone(gfp_t flags)
4e4785bc	106	{
523b9458 CL	107	int base = 0;
	108
	109	#ifdef CONFIG_NUMA
	110	if (flags & __GFP_THISNODE)
	111	base = MAX_NR_ZONES;
	112	#endif
	113
4b51d669	114	#ifdef CONFIG_ZONE_DMA
4e4785bc	115	if (flags & __GFP_DMA)
523b9458	116	return base + ZONE_DMA;
4b51d669	117	#endif
4e4785bc CL	118	#ifdef CONFIG_ZONE_DMA32
4e4785bc CL	119	if (flags & __GFP_DMA32)
523b9458	120	return base + ZONE_DMA32;
4e4785bc	121	#endif
2a1e274a MG	122	if ((flags & (__GFP_HIGHMEM \| __GFP_MOVABLE)) ==
2a1e274a MG	123	(__GFP_HIGHMEM \| __GFP_MOVABLE))
523b9458	124	return base + ZONE_MOVABLE;
4e4785bc CL	125	#ifdef CONFIG_HIGHMEM
4e4785bc CL	126	if (flags & __GFP_HIGHMEM)
523b9458	127	return base + ZONE_HIGHMEM;
4e4785bc	128	#endif
523b9458	129	return base + ZONE_NORMAL;
4e4785bc CL	130	}
4e4785bc CL	131
1da177e4 LT	132	/*
	133	* There is only one page-allocator function, and two main namespaces to
	134	* it. The alloc_page() variants return 'struct page ' and as such
	135	* can allocate highmem pages, the getpage*() variants return
	136	* virtual kernel addresses to the allocated page(s).
	137	*/
	138
	139	/*
	140	* We get the zone list from the current node and the gfp_mask.
	141	* This zone list contains a maximum of MAXNODES*MAX_NR_ZONES zones.
	142	*
	143	* For the normal case of non-DISCONTIGMEM systems the NODE_DATA() gets
	144	* optimized to &contig_page_data at compile-time.
	145	*/
	146
	147	#ifndef HAVE_ARCH_FREE_PAGE
	148	static inline void arch_free_page(struct page *page, int order) { }
	149	#endif
cc102509 NP	150	#ifndef HAVE_ARCH_ALLOC_PAGE
	151	static inline void arch_alloc_page(struct page *page, int order) { }
	152	#endif
1da177e4 LT	153
1da177e4 LT	154	extern struct page *
dd0fc66f	155	FASTCALL(__alloc_pages(gfp_t, unsigned int, struct zonelist *));
1da177e4	156
dd0fc66f	157	static inline struct page *alloc_pages_node(int nid, gfp_t gfp_mask,
1da177e4 LT	158	unsigned int order)
	159	{
	160	if (unlikely(order >= MAX_ORDER))
	161	return NULL;
	162
819a6928 AK	163	/* Unknown node is current node */
	164	if (nid < 0)
	165	nid = numa_node_id();
	166
1da177e4	167	return __alloc_pages(gfp_mask, order,
af4ca457	168	NODE_DATA(nid)->node_zonelists + gfp_zone(gfp_mask));
1da177e4 LT	169	}
	170
	171	#ifdef CONFIG_NUMA
dd0fc66f	172	extern struct page *alloc_pages_current(gfp_t gfp_mask, unsigned order);
1da177e4 LT	173
1da177e4 LT	174	static inline struct page *
dd0fc66f	175	alloc_pages(gfp_t gfp_mask, unsigned int order)
1da177e4 LT	176	{
	177	if (unlikely(order >= MAX_ORDER))
	178	return NULL;
	179
	180	return alloc_pages_current(gfp_mask, order);
	181	}
dd0fc66f	182	extern struct page *alloc_page_vma(gfp_t gfp_mask,
1da177e4 LT	183	struct vm_area_struct *vma, unsigned long addr);
	184	#else
	185	#define alloc_pages(gfp_mask, order) \
	186	alloc_pages_node(numa_node_id(), gfp_mask, order)
	187	#define alloc_page_vma(gfp_mask, vma, addr) alloc_pages(gfp_mask, 0)
	188	#endif
	189	#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)
	190
dd0fc66f AV	191	extern unsigned long FASTCALL(__get_free_pages(gfp_t gfp_mask, unsigned int order));
dd0fc66f AV	192	extern unsigned long FASTCALL(get_zeroed_page(gfp_t gfp_mask));
1da177e4 LT	193
	194	#define __get_free_page(gfp_mask) \
	195	__get_free_pages((gfp_mask),0)
	196
	197	#define __get_dma_pages(gfp_mask, order) \
	198	__get_free_pages((gfp_mask) \| GFP_DMA,(order))
	199
	200	extern void FASTCALL(__free_pages(struct page *page, unsigned int order));
	201	extern void FASTCALL(free_pages(unsigned long addr, unsigned int order));
	202	extern void FASTCALL(free_hot_page(struct page *page));
	203	extern void FASTCALL(free_cold_page(struct page *page));
	204
	205	#define __free_page(page) __free_pages((page), 0)
	206	#define free_page(addr) free_pages((addr),0)
	207
	208	void page_alloc_init(void);
4037d452	209	void drain_zone_pages(struct zone zone, struct per_cpu_pages pcp);
1da177e4 LT	210
1da177e4 LT	211	#endif /* __LINUX_GFP_H */