[thirdparty/kernel/linux.git] / include / linux / gfp.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __LINUX_GFP_H
#define __LINUX_GFP_H

#include <linux/gfp_types.h>

#include <linux/mmzone.h>
#include <linux/topology.h>
#include <linux/alloc_tag.h>
#include <linux/cleanup.h>
#include <linux/sched.h>

struct vm_area_struct;
struct mempolicy;

/* Helper macro to avoid gfp flags if they are the default one */
#define __default_gfp(a,b,...) b
#define default_gfp(...) __default_gfp(,##__VA_ARGS__,GFP_KERNEL)

/* Convert GFP flags to their corresponding migrate type */
#define GFP_MOVABLE_MASK (__GFP_RECLAIMABLE|__GFP_MOVABLE)
#define GFP_MOVABLE_SHIFT 3

static inline int gfp_migratetype(const gfp_t gfp_flags)
{
	VM_WARN_ON((gfp_flags & GFP_MOVABLE_MASK) == GFP_MOVABLE_MASK);
	BUILD_BUG_ON((1UL << GFP_MOVABLE_SHIFT) != ___GFP_MOVABLE);
	BUILD_BUG_ON((___GFP_MOVABLE >> GFP_MOVABLE_SHIFT) != MIGRATE_MOVABLE);
	BUILD_BUG_ON((___GFP_RECLAIMABLE >> GFP_MOVABLE_SHIFT) != MIGRATE_RECLAIMABLE);
	BUILD_BUG_ON(((___GFP_MOVABLE | ___GFP_RECLAIMABLE) >>
		      GFP_MOVABLE_SHIFT) != MIGRATE_HIGHATOMIC);

	if (unlikely(page_group_by_mobility_disabled))
		return MIGRATE_UNMOVABLE;

	/* Group based on mobility */
	return (__force unsigned long)(gfp_flags & GFP_MOVABLE_MASK) >> GFP_MOVABLE_SHIFT;
}
#undef GFP_MOVABLE_MASK
#undef GFP_MOVABLE_SHIFT

static inline bool gfpflags_allow_blocking(const gfp_t gfp_flags)
{
	return !!(gfp_flags & __GFP_DIRECT_RECLAIM);
}

static inline bool gfpflags_allow_spinning(const gfp_t gfp_flags)
{
	/*
	 * !__GFP_DIRECT_RECLAIM -> direct claim is not allowed.
	 * !__GFP_KSWAPD_RECLAIM -> it's not safe to wake up kswapd.
	 * All GFP_* flags including GFP_NOWAIT use one or both flags.
	 * alloc_pages_nolock() is the only API that doesn't specify either flag.
	 *
	 * This is stronger than GFP_NOWAIT or GFP_ATOMIC because
	 * those are guaranteed to never block on a sleeping lock.
	 * Here we are enforcing that the allocation doesn't ever spin
	 * on any locks (i.e. only trylocks). There is no high level
	 * GFP_$FOO flag for this use in alloc_pages_nolock() as the
	 * regular page allocator doesn't fully support this
	 * allocation mode.
	 */
	return !!(gfp_flags & __GFP_RECLAIM);
}

#ifdef CONFIG_HIGHMEM
#define OPT_ZONE_HIGHMEM ZONE_HIGHMEM
#else
#define OPT_ZONE_HIGHMEM ZONE_NORMAL
#endif

#ifdef CONFIG_ZONE_DMA
#define OPT_ZONE_DMA ZONE_DMA
#else
#define OPT_ZONE_DMA ZONE_NORMAL
#endif

#ifdef CONFIG_ZONE_DMA32
#define OPT_ZONE_DMA32 ZONE_DMA32
#else
#define OPT_ZONE_DMA32 ZONE_NORMAL
#endif

/*
 * GFP_ZONE_TABLE is a word size bitstring that is used for looking up the
 * zone to use given the lowest 4 bits of gfp_t. Entries are GFP_ZONES_SHIFT
 * bits long and there are 16 of them to cover all possible combinations of
 * __GFP_DMA, __GFP_DMA32, __GFP_MOVABLE and __GFP_HIGHMEM.
 *
 * The zone fallback order is MOVABLE=>HIGHMEM=>NORMAL=>DMA32=>DMA.
 * But GFP_MOVABLE is not only a zone specifier but also an allocation
 * policy. Therefore __GFP_MOVABLE plus another zone selector is valid.
 * Only 1 bit of the lowest 3 bits (DMA,DMA32,HIGHMEM) can be set to "1".
 *
 *       bit       result
 *       =================
 *       0x0    => NORMAL
 *       0x1    => DMA or NORMAL
 *       0x2    => HIGHMEM or NORMAL
 *       0x3    => BAD (DMA+HIGHMEM)
 *       0x4    => DMA32 or NORMAL
 *       0x5    => BAD (DMA+DMA32)
 *       0x6    => BAD (HIGHMEM+DMA32)
 *       0x7    => BAD (HIGHMEM+DMA32+DMA)
 *       0x8    => NORMAL (MOVABLE+0)
 *       0x9    => DMA or NORMAL (MOVABLE+DMA)
 *       0xa    => MOVABLE (Movable is valid only if HIGHMEM is set too)
 *       0xb    => BAD (MOVABLE+HIGHMEM+DMA)
 *       0xc    => DMA32 or NORMAL (MOVABLE+DMA32)
 *       0xd    => BAD (MOVABLE+DMA32+DMA)
 *       0xe    => BAD (MOVABLE+DMA32+HIGHMEM)
 *       0xf    => BAD (MOVABLE+DMA32+HIGHMEM+DMA)
 *
 * GFP_ZONES_SHIFT must be <= 2 on 32 bit platforms.
 */

#if defined(CONFIG_ZONE_DEVICE) && (MAX_NR_ZONES-1) <= 4
/* ZONE_DEVICE is not a valid GFP zone specifier */
#define GFP_ZONES_SHIFT 2
#else
#define GFP_ZONES_SHIFT ZONES_SHIFT
#endif

#if 16 * GFP_ZONES_SHIFT > BITS_PER_LONG
#error GFP_ZONES_SHIFT too large to create GFP_ZONE_TABLE integer
#endif

#define GFP_ZONE_TABLE ( \
	(ZONE_NORMAL << 0 * GFP_ZONES_SHIFT)				       \
	| (OPT_ZONE_DMA << ___GFP_DMA * GFP_ZONES_SHIFT)		       \
	| (OPT_ZONE_HIGHMEM << ___GFP_HIGHMEM * GFP_ZONES_SHIFT)	       \
	| (OPT_ZONE_DMA32 << ___GFP_DMA32 * GFP_ZONES_SHIFT)		       \
	| (ZONE_NORMAL << ___GFP_MOVABLE * GFP_ZONES_SHIFT)		       \
	| (OPT_ZONE_DMA << (___GFP_MOVABLE | ___GFP_DMA) * GFP_ZONES_SHIFT)    \
	| (ZONE_MOVABLE << (___GFP_MOVABLE | ___GFP_HIGHMEM) * GFP_ZONES_SHIFT)\
	| (OPT_ZONE_DMA32 << (___GFP_MOVABLE | ___GFP_DMA32) * GFP_ZONES_SHIFT)\
)

/*
 * GFP_ZONE_BAD is a bitmap for all combinations of __GFP_DMA, __GFP_DMA32
 * __GFP_HIGHMEM and __GFP_MOVABLE that are not permitted. One flag per
 * entry starting with bit 0. Bit is set if the combination is not
 * allowed.
 */
#define GFP_ZONE_BAD ( \
	1 << (___GFP_DMA | ___GFP_HIGHMEM)				      \
	| 1 << (___GFP_DMA | ___GFP_DMA32)				      \
	| 1 << (___GFP_DMA32 | ___GFP_HIGHMEM)				      \
	| 1 << (___GFP_DMA | ___GFP_DMA32 | ___GFP_HIGHMEM)		      \
	| 1 << (___GFP_MOVABLE | ___GFP_HIGHMEM | ___GFP_DMA)		      \
	| 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_DMA)		      \
	| 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_HIGHMEM)		      \
	| 1 << (___GFP_MOVABLE | ___GFP_DMA32 | ___GFP_DMA | ___GFP_HIGHMEM)  \
)

static inline enum zone_type gfp_zone(gfp_t flags)
{
	enum zone_type z;
	int bit = (__force int) (flags & GFP_ZONEMASK);

	z = (GFP_ZONE_TABLE >> (bit * GFP_ZONES_SHIFT)) &
					 ((1 << GFP_ZONES_SHIFT) - 1);
	VM_BUG_ON((GFP_ZONE_BAD >> bit) & 1);
	return z;
}

/*
 * 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).
 */

static inline int gfp_zonelist(gfp_t flags)
{
#ifdef CONFIG_NUMA
	if (unlikely(flags & __GFP_THISNODE))
		return ZONELIST_NOFALLBACK;
#endif
	return ZONELIST_FALLBACK;
}

/*
 * gfp flag masking for nested internal allocations.
 *
 * For code that needs to do allocations inside the public allocation API (e.g.
 * memory allocation tracking code) the allocations need to obey the caller
 * allocation context constrains to prevent allocation context mismatches (e.g.
 * GFP_KERNEL allocations in GFP_NOFS contexts) from potential deadlock
 * situations.
 *
 * It is also assumed that these nested allocations are for internal kernel
 * object storage purposes only and are not going to be used for DMA, etc. Hence
 * we strip out all the zone information and leave just the context information
 * intact.
 *
 * Further, internal allocations must fail before the higher level allocation
 * can fail, so we must make them fail faster and fail silently. We also don't
 * want them to deplete emergency reserves.  Hence nested allocations must be
 * prepared for these allocations to fail.
 */
static inline gfp_t gfp_nested_mask(gfp_t flags)
{
	return ((flags & (GFP_KERNEL | GFP_ATOMIC | __GFP_NOLOCKDEP)) |
		(__GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN));
}

/*
 * We get the zone list from the current node and the gfp_mask.
 * This zone list contains a maximum of MAX_NUMNODES*MAX_NR_ZONES zones.
 * There are two zonelists per node, one for all zones with memory and
 * one containing just zones from the node the zonelist belongs to.
 *
 * For the case of non-NUMA systems the NODE_DATA() gets optimized to
 * &contig_page_data at compile-time.
 */
static inline struct zonelist *node_zonelist(int nid, gfp_t flags)
{
	return NODE_DATA(nid)->node_zonelists + gfp_zonelist(flags);
}

#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

struct page *__alloc_pages_noprof(gfp_t gfp, unsigned int order, int preferred_nid,
		nodemask_t *nodemask);
#define __alloc_pages(...)			alloc_hooks(__alloc_pages_noprof(__VA_ARGS__))

struct folio *__folio_alloc_noprof(gfp_t gfp, unsigned int order, int preferred_nid,
		nodemask_t *nodemask);
#define __folio_alloc(...)			alloc_hooks(__folio_alloc_noprof(__VA_ARGS__))

unsigned long alloc_pages_bulk_noprof(gfp_t gfp, int preferred_nid,
				nodemask_t *nodemask, int nr_pages,
				struct page **page_array);
#define __alloc_pages_bulk(...)			alloc_hooks(alloc_pages_bulk_noprof(__VA_ARGS__))

void free_pages_bulk(struct page **page_array, unsigned long nr_pages);

unsigned long alloc_pages_bulk_mempolicy_noprof(gfp_t gfp,
				unsigned long nr_pages,
				struct page **page_array);
#define  alloc_pages_bulk_mempolicy(...)				\
	alloc_hooks(alloc_pages_bulk_mempolicy_noprof(__VA_ARGS__))

/* Bulk allocate order-0 pages */
#define alloc_pages_bulk(_gfp, _nr_pages, _page_array)		\
	__alloc_pages_bulk(_gfp, numa_mem_id(), NULL, _nr_pages, _page_array)

static inline unsigned long
alloc_pages_bulk_node_noprof(gfp_t gfp, int nid, unsigned long nr_pages,
				   struct page **page_array)
{
	if (nid == NUMA_NO_NODE)
		nid = numa_mem_id();

	return alloc_pages_bulk_noprof(gfp, nid, NULL, nr_pages, page_array);
}

#define alloc_pages_bulk_node(...)				\
	alloc_hooks(alloc_pages_bulk_node_noprof(__VA_ARGS__))

static inline void warn_if_node_offline(int this_node, gfp_t gfp_mask)
{
	gfp_t warn_gfp = gfp_mask & (__GFP_THISNODE|__GFP_NOWARN);

	if (warn_gfp != (__GFP_THISNODE|__GFP_NOWARN))
		return;

	if (node_online(this_node))
		return;

	pr_warn("%pGg allocation from offline node %d\n", &gfp_mask, this_node);
	dump_stack();
}

/*
 * Allocate pages, preferring the node given as nid. The node must be valid and
 * online. For more general interface, see alloc_pages_node().
 */
static inline struct page *
__alloc_pages_node_noprof(int nid, gfp_t gfp_mask, unsigned int order)
{
	VM_BUG_ON(nid < 0 || nid >= MAX_NUMNODES);
	warn_if_node_offline(nid, gfp_mask);

	return __alloc_pages_noprof(gfp_mask, order, nid, NULL);
}

#define  __alloc_pages_node(...)		alloc_hooks(__alloc_pages_node_noprof(__VA_ARGS__))

static inline
struct folio *__folio_alloc_node_noprof(gfp_t gfp, unsigned int order, int nid)
{
	VM_BUG_ON(nid < 0 || nid >= MAX_NUMNODES);
	warn_if_node_offline(nid, gfp);

	return __folio_alloc_noprof(gfp, order, nid, NULL);
}

#define  __folio_alloc_node(...)		alloc_hooks(__folio_alloc_node_noprof(__VA_ARGS__))

/*
 * Allocate pages, preferring the node given as nid. When nid == NUMA_NO_NODE,
 * prefer the current CPU's closest node. Otherwise node must be valid and
 * online.
 */
static inline struct page *alloc_pages_node_noprof(int nid, gfp_t gfp_mask,
						   unsigned int order)
{
	if (nid == NUMA_NO_NODE)
		nid = numa_mem_id();

	return __alloc_pages_node_noprof(nid, gfp_mask, order);
}

#define  alloc_pages_node(...)			alloc_hooks(alloc_pages_node_noprof(__VA_ARGS__))

#ifdef CONFIG_NUMA
struct page *alloc_pages_noprof(gfp_t gfp, unsigned int order);
struct folio *folio_alloc_noprof(gfp_t gfp, unsigned int order);
struct folio *folio_alloc_mpol_noprof(gfp_t gfp, unsigned int order,
		struct mempolicy *mpol, pgoff_t ilx, int nid);
struct folio *vma_alloc_folio_noprof(gfp_t gfp, int order, struct vm_area_struct *vma,
		unsigned long addr);
#else
static inline struct page *alloc_pages_noprof(gfp_t gfp_mask, unsigned int order)
{
	return alloc_pages_node_noprof(numa_node_id(), gfp_mask, order);
}
static inline struct folio *folio_alloc_noprof(gfp_t gfp, unsigned int order)
{
	return __folio_alloc_node_noprof(gfp, order, numa_node_id());
}
static inline struct folio *folio_alloc_mpol_noprof(gfp_t gfp, unsigned int order,
		struct mempolicy *mpol, pgoff_t ilx, int nid)
{
	return folio_alloc_noprof(gfp, order);
}
static inline struct folio *vma_alloc_folio_noprof(gfp_t gfp, int order,
		struct vm_area_struct *vma, unsigned long addr)
{
	return folio_alloc_noprof(gfp, order);
}
#endif

#define alloc_pages(...)			alloc_hooks(alloc_pages_noprof(__VA_ARGS__))
#define folio_alloc(...)			alloc_hooks(folio_alloc_noprof(__VA_ARGS__))
#define folio_alloc_mpol(...)			alloc_hooks(folio_alloc_mpol_noprof(__VA_ARGS__))
#define vma_alloc_folio(...)			alloc_hooks(vma_alloc_folio_noprof(__VA_ARGS__))

#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)

static inline struct page *alloc_page_vma_noprof(gfp_t gfp,
		struct vm_area_struct *vma, unsigned long addr)
{
	struct folio *folio = vma_alloc_folio_noprof(gfp, 0, vma, addr);

	return &folio->page;
}
#define alloc_page_vma(...)			alloc_hooks(alloc_page_vma_noprof(__VA_ARGS__))

struct page *alloc_pages_nolock_noprof(gfp_t gfp_flags, int nid, unsigned int order);
#define alloc_pages_nolock(...)			alloc_hooks(alloc_pages_nolock_noprof(__VA_ARGS__))

extern unsigned long get_free_pages_noprof(gfp_t gfp_mask, unsigned int order);
#define __get_free_pages(...)			alloc_hooks(get_free_pages_noprof(__VA_ARGS__))

extern unsigned long get_zeroed_page_noprof(gfp_t gfp_mask);
#define get_zeroed_page(...)			alloc_hooks(get_zeroed_page_noprof(__VA_ARGS__))

void *alloc_pages_exact_noprof(size_t size, gfp_t gfp_mask) __alloc_size(1);
#define alloc_pages_exact(...)			alloc_hooks(alloc_pages_exact_noprof(__VA_ARGS__))

void free_pages_exact(void *virt, size_t size);

__meminit void *alloc_pages_exact_nid_noprof(int nid, size_t size, gfp_t gfp_mask) __alloc_size(2);
#define alloc_pages_exact_nid(...)					\
	alloc_hooks(alloc_pages_exact_nid_noprof(__VA_ARGS__))

#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 __free_pages(struct page *page, unsigned int order);
extern void free_pages_nolock(struct page *page, unsigned int order);
extern void free_pages(unsigned long addr, unsigned int order);

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

void page_alloc_init_cpuhp(void);
bool decay_pcp_high(struct zone *zone, struct per_cpu_pages *pcp);
void drain_zone_pages(struct zone *zone, struct per_cpu_pages *pcp);
void drain_all_pages(struct zone *zone);
void drain_local_pages(struct zone *zone);

void page_alloc_init_late(void);
void setup_pcp_cacheinfo(unsigned int cpu);

/*
 * gfp_allowed_mask is set to GFP_BOOT_MASK during early boot to restrict what
 * GFP flags are used before interrupts are enabled. Once interrupts are
 * enabled, it is set to __GFP_BITS_MASK while the system is running. During
 * hibernation, it is used by PM to avoid I/O during memory allocation while
 * devices are suspended.
 */
extern gfp_t gfp_allowed_mask;

/* Returns true if the gfp_mask allows use of ALLOC_NO_WATERMARK */
bool gfp_pfmemalloc_allowed(gfp_t gfp_mask);

/* A helper for checking if gfp includes all the specified flags */
static inline bool gfp_has_flags(gfp_t gfp, gfp_t flags)
{
	return (gfp & flags) == flags;
}

static inline bool gfp_has_io_fs(gfp_t gfp)
{
	return gfp_has_flags(gfp, __GFP_IO | __GFP_FS);
}

/*
 * Check if the gfp flags allow compaction - GFP_NOIO is a really
 * tricky context because the migration might require IO.
 */
static inline bool gfp_compaction_allowed(gfp_t gfp_mask)
{
	return IS_ENABLED(CONFIG_COMPACTION) && (gfp_mask & __GFP_IO);
}

extern gfp_t vma_thp_gfp_mask(struct vm_area_struct *vma);

#ifdef CONFIG_CONTIG_ALLOC

typedef unsigned int __bitwise acr_flags_t;
#define ACR_FLAGS_NONE ((__force acr_flags_t)0) // ordinary allocation request
#define ACR_FLAGS_CMA ((__force acr_flags_t)BIT(0)) // allocate for CMA

/* The below functions must be run on a range from a single zone. */
int alloc_contig_frozen_range_noprof(unsigned long start, unsigned long end,
		acr_flags_t alloc_flags, gfp_t gfp_mask);
#define alloc_contig_frozen_range(...)	\
	alloc_hooks(alloc_contig_frozen_range_noprof(__VA_ARGS__))

int alloc_contig_range_noprof(unsigned long start, unsigned long end,
		acr_flags_t alloc_flags, gfp_t gfp_mask);
#define alloc_contig_range(...)	\
	alloc_hooks(alloc_contig_range_noprof(__VA_ARGS__))

struct page *alloc_contig_frozen_pages_noprof(unsigned long nr_pages,
		gfp_t gfp_mask, int nid, nodemask_t *nodemask);
#define alloc_contig_frozen_pages(...) \
	alloc_hooks(alloc_contig_frozen_pages_noprof(__VA_ARGS__))

struct page *alloc_contig_pages_noprof(unsigned long nr_pages, gfp_t gfp_mask,
		int nid, nodemask_t *nodemask);
#define alloc_contig_pages(...)	\
	alloc_hooks(alloc_contig_pages_noprof(__VA_ARGS__))

void free_contig_frozen_range(unsigned long pfn, unsigned long nr_pages);
void free_contig_range(unsigned long pfn, unsigned long nr_pages);
#endif

void __free_contig_range(unsigned long pfn, unsigned long nr_pages);

DEFINE_FREE(free_page, void *, free_page((unsigned long)_T))

#endif /* __LINUX_GFP_H */
Commit	Line	Data
	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef __LINUX_GFP_H
	3	#define __LINUX_GFP_H
	4
	5	#include <linux/gfp_types.h>
	6
	7	#include <linux/mmzone.h>
	8	#include <linux/topology.h>
	9	#include <linux/alloc_tag.h>
	10	#include <linux/cleanup.h>
	11	#include <linux/sched.h>
	12
	13	struct vm_area_struct;
	14	struct mempolicy;
	15
	16	/* Helper macro to avoid gfp flags if they are the default one */
	17	#define __default_gfp(a,b,...) b
	18	#define default_gfp(...) __default_gfp(,##__VA_ARGS__,GFP_KERNEL)
	19
	20	/* Convert GFP flags to their corresponding migrate type */
	21	#define GFP_MOVABLE_MASK (__GFP_RECLAIMABLE\|__GFP_MOVABLE)
	22	#define GFP_MOVABLE_SHIFT 3
	23
	24	static inline int gfp_migratetype(const gfp_t gfp_flags)
	25	{
	26	VM_WARN_ON((gfp_flags & GFP_MOVABLE_MASK) == GFP_MOVABLE_MASK);
	27	BUILD_BUG_ON((1UL << GFP_MOVABLE_SHIFT) != ___GFP_MOVABLE);
	28	BUILD_BUG_ON((___GFP_MOVABLE >> GFP_MOVABLE_SHIFT) != MIGRATE_MOVABLE);
	29	BUILD_BUG_ON((___GFP_RECLAIMABLE >> GFP_MOVABLE_SHIFT) != MIGRATE_RECLAIMABLE);
	30	BUILD_BUG_ON(((___GFP_MOVABLE \| ___GFP_RECLAIMABLE) >>
	31	GFP_MOVABLE_SHIFT) != MIGRATE_HIGHATOMIC);
	32
	33	if (unlikely(page_group_by_mobility_disabled))
	34	return MIGRATE_UNMOVABLE;
	35
	36	/* Group based on mobility */
	37	return (__force unsigned long)(gfp_flags & GFP_MOVABLE_MASK) >> GFP_MOVABLE_SHIFT;
	38	}
	39	#undef GFP_MOVABLE_MASK
	40	#undef GFP_MOVABLE_SHIFT
	41
	42	static inline bool gfpflags_allow_blocking(const gfp_t gfp_flags)
	43	{
	44	return !!(gfp_flags & __GFP_DIRECT_RECLAIM);
	45	}
	46
	47	static inline bool gfpflags_allow_spinning(const gfp_t gfp_flags)
	48	{
	49	/*
	50	* !__GFP_DIRECT_RECLAIM -> direct claim is not allowed.
	51	* !__GFP_KSWAPD_RECLAIM -> it's not safe to wake up kswapd.
	52	* All GFP_* flags including GFP_NOWAIT use one or both flags.
	53	* alloc_pages_nolock() is the only API that doesn't specify either flag.
	54	*
	55	* This is stronger than GFP_NOWAIT or GFP_ATOMIC because
	56	* those are guaranteed to never block on a sleeping lock.
	57	* Here we are enforcing that the allocation doesn't ever spin
	58	* on any locks (i.e. only trylocks). There is no high level
	59	* GFP_$FOO flag for this use in alloc_pages_nolock() as the
	60	* regular page allocator doesn't fully support this
	61	* allocation mode.
	62	*/
	63	return !!(gfp_flags & __GFP_RECLAIM);
	64	}
	65
	66	#ifdef CONFIG_HIGHMEM
	67	#define OPT_ZONE_HIGHMEM ZONE_HIGHMEM
	68	#else
	69	#define OPT_ZONE_HIGHMEM ZONE_NORMAL
	70	#endif
	71
	72	#ifdef CONFIG_ZONE_DMA
	73	#define OPT_ZONE_DMA ZONE_DMA
	74	#else
	75	#define OPT_ZONE_DMA ZONE_NORMAL
	76	#endif
	77
	78	#ifdef CONFIG_ZONE_DMA32
	79	#define OPT_ZONE_DMA32 ZONE_DMA32
	80	#else
	81	#define OPT_ZONE_DMA32 ZONE_NORMAL
	82	#endif
	83
	84	/*
	85	* GFP_ZONE_TABLE is a word size bitstring that is used for looking up the
	86	* zone to use given the lowest 4 bits of gfp_t. Entries are GFP_ZONES_SHIFT
	87	* bits long and there are 16 of them to cover all possible combinations of
	88	* __GFP_DMA, __GFP_DMA32, __GFP_MOVABLE and __GFP_HIGHMEM.
	89	*
	90	* The zone fallback order is MOVABLE=>HIGHMEM=>NORMAL=>DMA32=>DMA.
	91	* But GFP_MOVABLE is not only a zone specifier but also an allocation
	92	* policy. Therefore __GFP_MOVABLE plus another zone selector is valid.
	93	* Only 1 bit of the lowest 3 bits (DMA,DMA32,HIGHMEM) can be set to "1".
	94	*
	95	* bit result
	96	* =================
	97	* 0x0 => NORMAL
	98	* 0x1 => DMA or NORMAL
	99	* 0x2 => HIGHMEM or NORMAL
	100	* 0x3 => BAD (DMA+HIGHMEM)
	101	* 0x4 => DMA32 or NORMAL
	102	* 0x5 => BAD (DMA+DMA32)
	103	* 0x6 => BAD (HIGHMEM+DMA32)
	104	* 0x7 => BAD (HIGHMEM+DMA32+DMA)
	105	* 0x8 => NORMAL (MOVABLE+0)
	106	* 0x9 => DMA or NORMAL (MOVABLE+DMA)
	107	* 0xa => MOVABLE (Movable is valid only if HIGHMEM is set too)
	108	* 0xb => BAD (MOVABLE+HIGHMEM+DMA)
	109	* 0xc => DMA32 or NORMAL (MOVABLE+DMA32)
	110	* 0xd => BAD (MOVABLE+DMA32+DMA)
	111	* 0xe => BAD (MOVABLE+DMA32+HIGHMEM)
	112	* 0xf => BAD (MOVABLE+DMA32+HIGHMEM+DMA)
	113	*
	114	* GFP_ZONES_SHIFT must be <= 2 on 32 bit platforms.
	115	*/
	116
	117	#if defined(CONFIG_ZONE_DEVICE) && (MAX_NR_ZONES-1) <= 4
	118	/* ZONE_DEVICE is not a valid GFP zone specifier */
	119	#define GFP_ZONES_SHIFT 2
	120	#else
	121	#define GFP_ZONES_SHIFT ZONES_SHIFT
	122	#endif
	123
	124	#if 16 * GFP_ZONES_SHIFT > BITS_PER_LONG
	125	#error GFP_ZONES_SHIFT too large to create GFP_ZONE_TABLE integer
	126	#endif
	127
	128	#define GFP_ZONE_TABLE ( \
	129	(ZONE_NORMAL << 0 * GFP_ZONES_SHIFT) \
	130	\| (OPT_ZONE_DMA << ___GFP_DMA * GFP_ZONES_SHIFT) \
	131	\| (OPT_ZONE_HIGHMEM << ___GFP_HIGHMEM * GFP_ZONES_SHIFT) \
	132	\| (OPT_ZONE_DMA32 << ___GFP_DMA32 * GFP_ZONES_SHIFT) \
	133	\| (ZONE_NORMAL << ___GFP_MOVABLE * GFP_ZONES_SHIFT) \
	134	\| (OPT_ZONE_DMA << (___GFP_MOVABLE \| ___GFP_DMA) * GFP_ZONES_SHIFT) \
	135	\| (ZONE_MOVABLE << (___GFP_MOVABLE \| ___GFP_HIGHMEM) * GFP_ZONES_SHIFT)\
	136	\| (OPT_ZONE_DMA32 << (___GFP_MOVABLE \| ___GFP_DMA32) * GFP_ZONES_SHIFT)\
	137	)
	138
	139	/*
	140	* GFP_ZONE_BAD is a bitmap for all combinations of __GFP_DMA, __GFP_DMA32
	141	* __GFP_HIGHMEM and __GFP_MOVABLE that are not permitted. One flag per
	142	* entry starting with bit 0. Bit is set if the combination is not
	143	* allowed.
	144	*/
	145	#define GFP_ZONE_BAD ( \
	146	1 << (___GFP_DMA \| ___GFP_HIGHMEM) \
	147	\| 1 << (___GFP_DMA \| ___GFP_DMA32) \
	148	\| 1 << (___GFP_DMA32 \| ___GFP_HIGHMEM) \
	149	\| 1 << (___GFP_DMA \| ___GFP_DMA32 \| ___GFP_HIGHMEM) \
	150	\| 1 << (___GFP_MOVABLE \| ___GFP_HIGHMEM \| ___GFP_DMA) \
	151	\| 1 << (___GFP_MOVABLE \| ___GFP_DMA32 \| ___GFP_DMA) \
	152	\| 1 << (___GFP_MOVABLE \| ___GFP_DMA32 \| ___GFP_HIGHMEM) \
	153	\| 1 << (___GFP_MOVABLE \| ___GFP_DMA32 \| ___GFP_DMA \| ___GFP_HIGHMEM) \
	154	)
	155
	156	static inline enum zone_type gfp_zone(gfp_t flags)
	157	{
	158	enum zone_type z;
	159	int bit = (__force int) (flags & GFP_ZONEMASK);
	160
	161	z = (GFP_ZONE_TABLE >> (bit * GFP_ZONES_SHIFT)) &
	162	((1 << GFP_ZONES_SHIFT) - 1);
	163	VM_BUG_ON((GFP_ZONE_BAD >> bit) & 1);
	164	return z;
	165	}
	166
	167	/*
	168	* There is only one page-allocator function, and two main namespaces to
	169	* it. The alloc_page() variants return 'struct page ' and as such
	170	* can allocate highmem pages, the getpage*() variants return
	171	* virtual kernel addresses to the allocated page(s).
	172	*/
	173
	174	static inline int gfp_zonelist(gfp_t flags)
	175	{
	176	#ifdef CONFIG_NUMA
	177	if (unlikely(flags & __GFP_THISNODE))
	178	return ZONELIST_NOFALLBACK;
	179	#endif
	180	return ZONELIST_FALLBACK;
	181	}
	182
	183	/*
	184	* gfp flag masking for nested internal allocations.
	185	*
	186	* For code that needs to do allocations inside the public allocation API (e.g.
	187	* memory allocation tracking code) the allocations need to obey the caller
	188	* allocation context constrains to prevent allocation context mismatches (e.g.
	189	* GFP_KERNEL allocations in GFP_NOFS contexts) from potential deadlock
	190	* situations.
	191	*
	192	* It is also assumed that these nested allocations are for internal kernel
	193	* object storage purposes only and are not going to be used for DMA, etc. Hence
	194	* we strip out all the zone information and leave just the context information
	195	* intact.
	196	*
	197	* Further, internal allocations must fail before the higher level allocation
	198	* can fail, so we must make them fail faster and fail silently. We also don't
	199	* want them to deplete emergency reserves. Hence nested allocations must be
	200	* prepared for these allocations to fail.
	201	*/
	202	static inline gfp_t gfp_nested_mask(gfp_t flags)
	203	{
	204	return ((flags & (GFP_KERNEL \| GFP_ATOMIC \| __GFP_NOLOCKDEP)) \|
	205	(__GFP_NORETRY \| __GFP_NOMEMALLOC \| __GFP_NOWARN));
	206	}
	207
	208	/*
	209	* We get the zone list from the current node and the gfp_mask.
	210	* This zone list contains a maximum of MAX_NUMNODES*MAX_NR_ZONES zones.
	211	* There are two zonelists per node, one for all zones with memory and
	212	* one containing just zones from the node the zonelist belongs to.
	213	*
	214	* For the case of non-NUMA systems the NODE_DATA() gets optimized to
	215	* &contig_page_data at compile-time.
	216	*/
	217	static inline struct zonelist *node_zonelist(int nid, gfp_t flags)
	218	{
	219	return NODE_DATA(nid)->node_zonelists + gfp_zonelist(flags);
	220	}
	221
	222	#ifndef HAVE_ARCH_FREE_PAGE
	223	static inline void arch_free_page(struct page *page, int order) { }
	224	#endif
	225	#ifndef HAVE_ARCH_ALLOC_PAGE
	226	static inline void arch_alloc_page(struct page *page, int order) { }
	227	#endif
	228
	229	struct page *__alloc_pages_noprof(gfp_t gfp, unsigned int order, int preferred_nid,
	230	nodemask_t *nodemask);
	231	#define __alloc_pages(...) alloc_hooks(__alloc_pages_noprof(__VA_ARGS__))
	232
	233	struct folio *__folio_alloc_noprof(gfp_t gfp, unsigned int order, int preferred_nid,
	234	nodemask_t *nodemask);
	235	#define __folio_alloc(...) alloc_hooks(__folio_alloc_noprof(__VA_ARGS__))
	236
	237	unsigned long alloc_pages_bulk_noprof(gfp_t gfp, int preferred_nid,
	238	nodemask_t *nodemask, int nr_pages,
	239	struct page **page_array);
	240	#define __alloc_pages_bulk(...) alloc_hooks(alloc_pages_bulk_noprof(__VA_ARGS__))
	241
	242	void free_pages_bulk(struct page **page_array, unsigned long nr_pages);
	243
	244	unsigned long alloc_pages_bulk_mempolicy_noprof(gfp_t gfp,
	245	unsigned long nr_pages,
	246	struct page **page_array);
	247	#define alloc_pages_bulk_mempolicy(...) \
	248	alloc_hooks(alloc_pages_bulk_mempolicy_noprof(__VA_ARGS__))
	249
	250	/* Bulk allocate order-0 pages */
	251	#define alloc_pages_bulk(_gfp, _nr_pages, _page_array) \
	252	__alloc_pages_bulk(_gfp, numa_mem_id(), NULL, _nr_pages, _page_array)
	253
	254	static inline unsigned long
	255	alloc_pages_bulk_node_noprof(gfp_t gfp, int nid, unsigned long nr_pages,
	256	struct page **page_array)
	257	{
	258	if (nid == NUMA_NO_NODE)
	259	nid = numa_mem_id();
	260
	261	return alloc_pages_bulk_noprof(gfp, nid, NULL, nr_pages, page_array);
	262	}
	263
	264	#define alloc_pages_bulk_node(...) \
	265	alloc_hooks(alloc_pages_bulk_node_noprof(__VA_ARGS__))
	266
	267	static inline void warn_if_node_offline(int this_node, gfp_t gfp_mask)
	268	{
	269	gfp_t warn_gfp = gfp_mask & (__GFP_THISNODE\|__GFP_NOWARN);
	270
	271	if (warn_gfp != (__GFP_THISNODE\|__GFP_NOWARN))
	272	return;
	273
	274	if (node_online(this_node))
	275	return;
	276
	277	pr_warn("%pGg allocation from offline node %d\n", &gfp_mask, this_node);
	278	dump_stack();
	279	}
	280
	281	/*
	282	* Allocate pages, preferring the node given as nid. The node must be valid and
	283	* online. For more general interface, see alloc_pages_node().
	284	*/
	285	static inline struct page *
	286	__alloc_pages_node_noprof(int nid, gfp_t gfp_mask, unsigned int order)
	287	{
	288	VM_BUG_ON(nid < 0 \|\| nid >= MAX_NUMNODES);
	289	warn_if_node_offline(nid, gfp_mask);
	290
	291	return __alloc_pages_noprof(gfp_mask, order, nid, NULL);
	292	}
	293
	294	#define __alloc_pages_node(...) alloc_hooks(__alloc_pages_node_noprof(__VA_ARGS__))
	295
	296	static inline
	297	struct folio *__folio_alloc_node_noprof(gfp_t gfp, unsigned int order, int nid)
	298	{
	299	VM_BUG_ON(nid < 0 \|\| nid >= MAX_NUMNODES);
	300	warn_if_node_offline(nid, gfp);
	301
	302	return __folio_alloc_noprof(gfp, order, nid, NULL);
	303	}
	304
	305	#define __folio_alloc_node(...) alloc_hooks(__folio_alloc_node_noprof(__VA_ARGS__))
	306
	307	/*
	308	* Allocate pages, preferring the node given as nid. When nid == NUMA_NO_NODE,
	309	* prefer the current CPU's closest node. Otherwise node must be valid and
	310	* online.
	311	*/
	312	static inline struct page *alloc_pages_node_noprof(int nid, gfp_t gfp_mask,
	313	unsigned int order)
	314	{
	315	if (nid == NUMA_NO_NODE)
	316	nid = numa_mem_id();
	317
	318	return __alloc_pages_node_noprof(nid, gfp_mask, order);
	319	}
	320
	321	#define alloc_pages_node(...) alloc_hooks(alloc_pages_node_noprof(__VA_ARGS__))
	322
	323	#ifdef CONFIG_NUMA
	324	struct page *alloc_pages_noprof(gfp_t gfp, unsigned int order);
	325	struct folio *folio_alloc_noprof(gfp_t gfp, unsigned int order);
	326	struct folio *folio_alloc_mpol_noprof(gfp_t gfp, unsigned int order,
	327	struct mempolicy *mpol, pgoff_t ilx, int nid);
	328	struct folio vma_alloc_folio_noprof(gfp_t gfp, int order, struct vm_area_struct vma,
	329	unsigned long addr);
	330	#else
	331	static inline struct page *alloc_pages_noprof(gfp_t gfp_mask, unsigned int order)
	332	{
	333	return alloc_pages_node_noprof(numa_node_id(), gfp_mask, order);
	334	}
	335	static inline struct folio *folio_alloc_noprof(gfp_t gfp, unsigned int order)
	336	{
	337	return __folio_alloc_node_noprof(gfp, order, numa_node_id());
	338	}
	339	static inline struct folio *folio_alloc_mpol_noprof(gfp_t gfp, unsigned int order,
	340	struct mempolicy *mpol, pgoff_t ilx, int nid)
	341	{
	342	return folio_alloc_noprof(gfp, order);
	343	}
	344	static inline struct folio *vma_alloc_folio_noprof(gfp_t gfp, int order,
	345	struct vm_area_struct *vma, unsigned long addr)
	346	{
	347	return folio_alloc_noprof(gfp, order);
	348	}
	349	#endif
	350
	351	#define alloc_pages(...) alloc_hooks(alloc_pages_noprof(__VA_ARGS__))
	352	#define folio_alloc(...) alloc_hooks(folio_alloc_noprof(__VA_ARGS__))
	353	#define folio_alloc_mpol(...) alloc_hooks(folio_alloc_mpol_noprof(__VA_ARGS__))
	354	#define vma_alloc_folio(...) alloc_hooks(vma_alloc_folio_noprof(__VA_ARGS__))
	355
	356	#define alloc_page(gfp_mask) alloc_pages(gfp_mask, 0)
	357
	358	static inline struct page *alloc_page_vma_noprof(gfp_t gfp,
	359	struct vm_area_struct *vma, unsigned long addr)
	360	{
	361	struct folio *folio = vma_alloc_folio_noprof(gfp, 0, vma, addr);
	362
	363	return &folio->page;
	364	}
	365	#define alloc_page_vma(...) alloc_hooks(alloc_page_vma_noprof(__VA_ARGS__))
	366
	367	struct page *alloc_pages_nolock_noprof(gfp_t gfp_flags, int nid, unsigned int order);
	368	#define alloc_pages_nolock(...) alloc_hooks(alloc_pages_nolock_noprof(__VA_ARGS__))
	369
	370	extern unsigned long get_free_pages_noprof(gfp_t gfp_mask, unsigned int order);
	371	#define __get_free_pages(...) alloc_hooks(get_free_pages_noprof(__VA_ARGS__))
	372
	373	extern unsigned long get_zeroed_page_noprof(gfp_t gfp_mask);
	374	#define get_zeroed_page(...) alloc_hooks(get_zeroed_page_noprof(__VA_ARGS__))
	375
	376	void *alloc_pages_exact_noprof(size_t size, gfp_t gfp_mask) __alloc_size(1);
	377	#define alloc_pages_exact(...) alloc_hooks(alloc_pages_exact_noprof(__VA_ARGS__))
	378
	379	void free_pages_exact(void *virt, size_t size);
	380
	381	__meminit void *alloc_pages_exact_nid_noprof(int nid, size_t size, gfp_t gfp_mask) __alloc_size(2);
	382	#define alloc_pages_exact_nid(...) \
	383	alloc_hooks(alloc_pages_exact_nid_noprof(__VA_ARGS__))
	384
	385	#define __get_free_page(gfp_mask) \
	386	__get_free_pages((gfp_mask), 0)
	387
	388	#define __get_dma_pages(gfp_mask, order) \
	389	__get_free_pages((gfp_mask) \| GFP_DMA, (order))
	390
	391	extern void __free_pages(struct page *page, unsigned int order);
	392	extern void free_pages_nolock(struct page *page, unsigned int order);
	393	extern void free_pages(unsigned long addr, unsigned int order);
	394
	395	#define __free_page(page) __free_pages((page), 0)
	396	#define free_page(addr) free_pages((addr), 0)
	397
	398	void page_alloc_init_cpuhp(void);
	399	bool decay_pcp_high(struct zone zone, struct per_cpu_pages pcp);
	400	void drain_zone_pages(struct zone zone, struct per_cpu_pages pcp);
	401	void drain_all_pages(struct zone *zone);
	402	void drain_local_pages(struct zone *zone);
	403
	404	void page_alloc_init_late(void);
	405	void setup_pcp_cacheinfo(unsigned int cpu);
	406
	407	/*
	408	* gfp_allowed_mask is set to GFP_BOOT_MASK during early boot to restrict what
	409	* GFP flags are used before interrupts are enabled. Once interrupts are
	410	* enabled, it is set to __GFP_BITS_MASK while the system is running. During
	411	* hibernation, it is used by PM to avoid I/O during memory allocation while
	412	* devices are suspended.
	413	*/
	414	extern gfp_t gfp_allowed_mask;
	415
	416	/* Returns true if the gfp_mask allows use of ALLOC_NO_WATERMARK */
	417	bool gfp_pfmemalloc_allowed(gfp_t gfp_mask);
	418
	419	/* A helper for checking if gfp includes all the specified flags */
	420	static inline bool gfp_has_flags(gfp_t gfp, gfp_t flags)
	421	{
	422	return (gfp & flags) == flags;
	423	}
	424
	425	static inline bool gfp_has_io_fs(gfp_t gfp)
	426	{
	427	return gfp_has_flags(gfp, __GFP_IO \| __GFP_FS);
	428	}
	429
	430	/*
	431	* Check if the gfp flags allow compaction - GFP_NOIO is a really
	432	* tricky context because the migration might require IO.
	433	*/
	434	static inline bool gfp_compaction_allowed(gfp_t gfp_mask)
	435	{
	436	return IS_ENABLED(CONFIG_COMPACTION) && (gfp_mask & __GFP_IO);
	437	}
	438
	439	extern gfp_t vma_thp_gfp_mask(struct vm_area_struct *vma);
	440
	441	#ifdef CONFIG_CONTIG_ALLOC
	442
	443	typedef unsigned int __bitwise acr_flags_t;
	444	#define ACR_FLAGS_NONE ((__force acr_flags_t)0) // ordinary allocation request
	445	#define ACR_FLAGS_CMA ((__force acr_flags_t)BIT(0)) // allocate for CMA
	446
	447	/* The below functions must be run on a range from a single zone. */
	448	int alloc_contig_frozen_range_noprof(unsigned long start, unsigned long end,
	449	acr_flags_t alloc_flags, gfp_t gfp_mask);
	450	#define alloc_contig_frozen_range(...) \
	451	alloc_hooks(alloc_contig_frozen_range_noprof(__VA_ARGS__))
	452
	453	int alloc_contig_range_noprof(unsigned long start, unsigned long end,
	454	acr_flags_t alloc_flags, gfp_t gfp_mask);
	455	#define alloc_contig_range(...) \
	456	alloc_hooks(alloc_contig_range_noprof(__VA_ARGS__))
	457
	458	struct page *alloc_contig_frozen_pages_noprof(unsigned long nr_pages,
	459	gfp_t gfp_mask, int nid, nodemask_t *nodemask);
	460	#define alloc_contig_frozen_pages(...) \
	461	alloc_hooks(alloc_contig_frozen_pages_noprof(__VA_ARGS__))
	462
	463	struct page *alloc_contig_pages_noprof(unsigned long nr_pages, gfp_t gfp_mask,
	464	int nid, nodemask_t *nodemask);
	465	#define alloc_contig_pages(...) \
	466	alloc_hooks(alloc_contig_pages_noprof(__VA_ARGS__))
	467
	468	void free_contig_frozen_range(unsigned long pfn, unsigned long nr_pages);
	469	void free_contig_range(unsigned long pfn, unsigned long nr_pages);
	470	#endif
	471
	472	void __free_contig_range(unsigned long pfn, unsigned long nr_pages);
	473
	474	DEFINE_FREE(free_page, void *, free_page((unsigned long)_T))
	475
	476	#endif /* __LINUX_GFP_H */