[mirror_ubuntu-eoan-kernel.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 */
#define pageblock_order		HUGETLB_PAGE_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-1)

#endif /* CONFIG_HUGETLB_PAGE */

#define pageblock_nr_pages	(1UL << pageblock_order)

/* Forward declaration */
struct page;

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

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

/* Declarations for getting and setting flags. See mm/page_alloc.c */
#define get_pageblock_flags_group(page, start_bitidx, end_bitidx) \
	get_pfnblock_flags_mask(page, page_to_pfn(page),		\
			end_bitidx,					\
			(1 << (end_bitidx - start_bitidx + 1)) - 1)
#define set_pageblock_flags_group(page, flags, start_bitidx, end_bitidx) \
	set_pfnblock_flags_mask(page, flags, page_to_pfn(page),		\
			end_bitidx,					\
			(1 << (end_bitidx - start_bitidx + 1)) - 1)

#ifdef CONFIG_COMPACTION
#define get_pageblock_skip(page) \
			get_pageblock_flags_group(page, PB_migrate_skip,     \
							PB_migrate_skip)
#define clear_pageblock_skip(page) \
			set_pageblock_flags_group(page, 0, PB_migrate_skip,  \
							PB_migrate_skip)
#define set_pageblock_skip(page) \
			set_pageblock_flags_group(page, 1, PB_migrate_skip,  \
							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
	40	/* Huge pages are a constant size */
	41	#define pageblock_order HUGETLB_PAGE_ORDER
	42
	43	#endif /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */
	44
	45	#else /* CONFIG_HUGETLB_PAGE */
	46
	47	/* If huge pages are not used, group by MAX_ORDER_NR_PAGES */
	48	#define pageblock_order (MAX_ORDER-1)
	49
	50	#endif /* CONFIG_HUGETLB_PAGE */
	51
	52	#define pageblock_nr_pages (1UL << pageblock_order)
	53
835c134e MG	54	/* Forward declaration */
	55	struct page;
	56
dc4b0caf MG	57	unsigned long get_pfnblock_flags_mask(struct page *page,
dc4b0caf MG	58	unsigned long pfn,
e58469ba MG	59	unsigned long end_bitidx,
e58469ba MG	60	unsigned long mask);
dc4b0caf MG	61
dc4b0caf MG	62	void set_pfnblock_flags_mask(struct page *page,
e58469ba	63	unsigned long flags,
dc4b0caf	64	unsigned long pfn,
e58469ba MG	65	unsigned long end_bitidx,
	66	unsigned long mask);
	67
835c134e	68	/* Declarations for getting and setting flags. See mm/page_alloc.c */
dc4b0caf MG	69	#define get_pageblock_flags_group(page, start_bitidx, end_bitidx) \
	70	get_pfnblock_flags_mask(page, page_to_pfn(page), \
	71	end_bitidx, \
	72	(1 << (end_bitidx - start_bitidx + 1)) - 1)
	73	#define set_pageblock_flags_group(page, flags, start_bitidx, end_bitidx) \
	74	set_pfnblock_flags_mask(page, flags, page_to_pfn(page), \
	75	end_bitidx, \
	76	(1 << (end_bitidx - start_bitidx + 1)) - 1)
835c134e	77
bb13ffeb MG	78	#ifdef CONFIG_COMPACTION
	79	#define get_pageblock_skip(page) \
	80	get_pageblock_flags_group(page, PB_migrate_skip, \
62726059	81	PB_migrate_skip)
bb13ffeb MG	82	#define clear_pageblock_skip(page) \
bb13ffeb MG	83	set_pageblock_flags_group(page, 0, PB_migrate_skip, \
62726059	84	PB_migrate_skip)
bb13ffeb MG	85	#define set_pageblock_skip(page) \
bb13ffeb MG	86	set_pageblock_flags_group(page, 1, PB_migrate_skip, \
62726059	87	PB_migrate_skip)
21dc7e02 DR	88	#else
	89	static inline bool get_pageblock_skip(struct page *page)
	90	{
	91	return false;
	92	}
	93	static inline void clear_pageblock_skip(struct page *page)
	94	{
	95	}
	96	static inline void set_pageblock_skip(struct page *page)
	97	{
	98	}
bb13ffeb MG	99	#endif /* CONFIG_COMPACTION */
bb13ffeb MG	100
835c134e	101	#endif /* PAGEBLOCK_FLAGS_H */