[linux-block.git] / include / linux / pageblock-flags.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Macros for manipulating and testing flags related to a
 * pageblock_nr_pages number of pages.
 *
 * Copyright (C) IBM Corporation, 2006
 *
 * Original author, Mel Gorman
 * Major cleanups and reduction of bit operations, Andy Whitcroft
 */
#ifndef PAGEBLOCK_FLAGS_H
#define PAGEBLOCK_FLAGS_H

#include <linux/types.h>

#define PB_migratetype_bits 3
/* Bit indices that affect a whole block of pages */
enum pageblock_bits {
	PB_migrate,
	PB_migrate_end = PB_migrate + PB_migratetype_bits - 1,
			/* 3 bits required for migrate types */
	PB_migrate_skip,/* If set the block is skipped by compaction */

	/*
	 * Assume the bits will always align on a word. If this assumption
	 * changes then get/set pageblock needs updating.
	 */
	NR_PAGEBLOCK_BITS
};

#ifdef CONFIG_HUGETLB_PAGE

#ifdef CONFIG_HUGETLB_PAGE_SIZE_VARIABLE

/* Huge page sizes are variable */
extern unsigned int pageblock_order;

#else /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */

/*
 * Huge pages are a constant size, but don't exceed the maximum allocation
 * granularity.
 */
#define pageblock_order		min_t(unsigned int, HUGETLB_PAGE_ORDER, MAX_ORDER)

#endif /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */

#else /* CONFIG_HUGETLB_PAGE */

/* If huge pages are not used, group by MAX_ORDER_NR_PAGES */
#define pageblock_order		MAX_ORDER

#endif /* CONFIG_HUGETLB_PAGE */

#define pageblock_nr_pages	(1UL << pageblock_order)
#define pageblock_align(pfn)	ALIGN((pfn), pageblock_nr_pages)
#define pageblock_aligned(pfn)	IS_ALIGNED((pfn), pageblock_nr_pages)
#define pageblock_start_pfn(pfn)	ALIGN_DOWN((pfn), pageblock_nr_pages)
#define pageblock_end_pfn(pfn)		ALIGN((pfn) + 1, pageblock_nr_pages)

/* Forward declaration */
struct page;

unsigned long get_pfnblock_flags_mask(const struct page *page,
				unsigned long pfn,
				unsigned long mask);

void set_pfnblock_flags_mask(struct page *page,
				unsigned long flags,
				unsigned long pfn,
				unsigned long mask);

/* Declarations for getting and setting flags. See mm/page_alloc.c */
#ifdef CONFIG_COMPACTION
#define get_pageblock_skip(page) \
	get_pfnblock_flags_mask(page, page_to_pfn(page),	\
			(1 << (PB_migrate_skip)))
#define clear_pageblock_skip(page) \
	set_pfnblock_flags_mask(page, 0, page_to_pfn(page),	\
			(1 << PB_migrate_skip))
#define set_pageblock_skip(page) \
	set_pfnblock_flags_mask(page, (1 << PB_migrate_skip),	\
			page_to_pfn(page),			\
			(1 << PB_migrate_skip))
#else
static inline bool get_pageblock_skip(struct page *page)
{
	return false;
}
static inline void clear_pageblock_skip(struct page *page)
{
}
static inline void set_pageblock_skip(struct page *page)
{
}
#endif /* CONFIG_COMPACTION */

#endif	/* PAGEBLOCK_FLAGS_H */
Commit	Line	Data
873e65bc	1	/* SPDX-License-Identifier: GPL-2.0-only */
835c134e MG	2	/*
835c134e MG	3	* Macros for manipulating and testing flags related to a
d9c23400	4	* pageblock_nr_pages number of pages.
835c134e	5	*
835c134e MG	6	* Copyright (C) IBM Corporation, 2006
	7	*
	8	* Original author, Mel Gorman
	9	* Major cleanups and reduction of bit operations, Andy Whitcroft
	10	*/
	11	#ifndef PAGEBLOCK_FLAGS_H
	12	#define PAGEBLOCK_FLAGS_H
	13
	14	#include <linux/types.h>
	15
125b860b	16	#define PB_migratetype_bits 3
835c134e MG	17	/* Bit indices that affect a whole block of pages */
835c134e MG	18	enum pageblock_bits {
c801ed38	19	PB_migrate,
125b860b	20	PB_migrate_end = PB_migrate + PB_migratetype_bits - 1,
c801ed38	21	/* 3 bits required for migrate types */
bb13ffeb	22	PB_migrate_skip,/* If set the block is skipped by compaction */
e58469ba MG	23
	24	/*
	25	* Assume the bits will always align on a word. If this assumption
	26	* changes then get/set pageblock needs updating.
	27	*/
835c134e MG	28	NR_PAGEBLOCK_BITS
	29	};
	30
d9c23400 MG	31	#ifdef CONFIG_HUGETLB_PAGE
	32
	33	#ifdef CONFIG_HUGETLB_PAGE_SIZE_VARIABLE
	34
	35	/* Huge page sizes are variable */
d00181b9	36	extern unsigned int pageblock_order;
d9c23400 MG	37
	38	#else /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */
	39
b3d40a2b DH	40	/*
	41	* Huge pages are a constant size, but don't exceed the maximum allocation
	42	* granularity.
	43	*/
23baf831	44	#define pageblock_order min_t(unsigned int, HUGETLB_PAGE_ORDER, MAX_ORDER)
d9c23400 MG	45
	46	#endif /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */
	47
	48	#else /* CONFIG_HUGETLB_PAGE */
	49
	50	/* If huge pages are not used, group by MAX_ORDER_NR_PAGES */
23baf831	51	#define pageblock_order MAX_ORDER
d9c23400 MG	52
	53	#endif /* CONFIG_HUGETLB_PAGE */
	54
	55	#define pageblock_nr_pages (1UL << pageblock_order)
5f7fa13f	56	#define pageblock_align(pfn) ALIGN((pfn), pageblock_nr_pages)
ee0913c4	57	#define pageblock_aligned(pfn) IS_ALIGNED((pfn), pageblock_nr_pages)
4f9bc69a KW	58	#define pageblock_start_pfn(pfn) ALIGN_DOWN((pfn), pageblock_nr_pages)
4f9bc69a KW	59	#define pageblock_end_pfn(pfn) ALIGN((pfn) + 1, pageblock_nr_pages)
d9c23400	60
835c134e MG	61	/* Forward declaration */
	62	struct page;
	63
ca891f41	64	unsigned long get_pfnblock_flags_mask(const struct page *page,
dc4b0caf	65	unsigned long pfn,
e58469ba	66	unsigned long mask);
dc4b0caf MG	67
dc4b0caf MG	68	void set_pfnblock_flags_mask(struct page *page,
e58469ba	69	unsigned long flags,
dc4b0caf	70	unsigned long pfn,
e58469ba MG	71	unsigned long mask);
e58469ba MG	72
835c134e	73	/* Declarations for getting and setting flags. See mm/page_alloc.c */
bb13ffeb MG	74	#ifdef CONFIG_COMPACTION
bb13ffeb MG	75	#define get_pageblock_skip(page) \
d93d5ab9	76	get_pfnblock_flags_mask(page, page_to_pfn(page), \
535b81e2	77	(1 << (PB_migrate_skip)))
bb13ffeb	78	#define clear_pageblock_skip(page) \
d93d5ab9	79	set_pfnblock_flags_mask(page, 0, page_to_pfn(page), \
535b81e2	80	(1 << PB_migrate_skip))
bb13ffeb	81	#define set_pageblock_skip(page) \
d93d5ab9 WY	82	set_pfnblock_flags_mask(page, (1 << PB_migrate_skip), \
d93d5ab9 WY	83	page_to_pfn(page), \
535b81e2	84	(1 << PB_migrate_skip))
21dc7e02 DR	85	#else
	86	static inline bool get_pageblock_skip(struct page *page)
	87	{
	88	return false;
	89	}
	90	static inline void clear_pageblock_skip(struct page *page)
	91	{
	92	}
	93	static inline void set_pageblock_skip(struct page *page)
	94	{
	95	}
bb13ffeb MG	96	#endif /* CONFIG_COMPACTION */
bb13ffeb MG	97
835c134e	98	#endif /* PAGEBLOCK_FLAGS_H */