[mirror_ubuntu-bionic-kernel.git] / include / linux / pageblock-flags.h

/*
 * Macros for manipulating and testing flags related to a
 * pageblock_nr_pages number of pages.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * 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>

/* Bit indices that affect a whole block of pages */
enum pageblock_bits {
	PB_migrate,
	PB_migrate_end = PB_migrate + 3 - 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
835c134e MG	1	/*
835c134e MG	2	* Macros for manipulating and testing flags related to a
d9c23400	3	* pageblock_nr_pages number of pages.
835c134e MG	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation version 2 of the License
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*
	18	* Copyright (C) IBM Corporation, 2006
	19	*
	20	* Original author, Mel Gorman
	21	* Major cleanups and reduction of bit operations, Andy Whitcroft
	22	*/
	23	#ifndef PAGEBLOCK_FLAGS_H
	24	#define PAGEBLOCK_FLAGS_H
	25
	26	#include <linux/types.h>
	27
835c134e MG	28	/* Bit indices that affect a whole block of pages */
835c134e MG	29	enum pageblock_bits {
c801ed38 PJ	30	PB_migrate,
	31	PB_migrate_end = PB_migrate + 3 - 1,
	32	/* 3 bits required for migrate types */
bb13ffeb	33	PB_migrate_skip,/* If set the block is skipped by compaction */
e58469ba MG	34
	35	/*
	36	* Assume the bits will always align on a word. If this assumption
	37	* changes then get/set pageblock needs updating.
	38	*/
835c134e MG	39	NR_PAGEBLOCK_BITS
	40	};
	41
d9c23400 MG	42	#ifdef CONFIG_HUGETLB_PAGE
	43
	44	#ifdef CONFIG_HUGETLB_PAGE_SIZE_VARIABLE
	45
	46	/* Huge page sizes are variable */
d00181b9	47	extern unsigned int pageblock_order;
d9c23400 MG	48
	49	#else /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */
	50
	51	/* Huge pages are a constant size */
	52	#define pageblock_order HUGETLB_PAGE_ORDER
	53
	54	#endif /* CONFIG_HUGETLB_PAGE_SIZE_VARIABLE */
	55
	56	#else /* CONFIG_HUGETLB_PAGE */
	57
	58	/* If huge pages are not used, group by MAX_ORDER_NR_PAGES */
	59	#define pageblock_order (MAX_ORDER-1)
	60
	61	#endif /* CONFIG_HUGETLB_PAGE */
	62
	63	#define pageblock_nr_pages (1UL << pageblock_order)
	64
835c134e MG	65	/* Forward declaration */
	66	struct page;
	67
dc4b0caf MG	68	unsigned long get_pfnblock_flags_mask(struct page *page,
dc4b0caf MG	69	unsigned long pfn,
e58469ba MG	70	unsigned long end_bitidx,
e58469ba MG	71	unsigned long mask);
dc4b0caf MG	72
dc4b0caf MG	73	void set_pfnblock_flags_mask(struct page *page,
e58469ba	74	unsigned long flags,
dc4b0caf	75	unsigned long pfn,
e58469ba MG	76	unsigned long end_bitidx,
	77	unsigned long mask);
	78
835c134e	79	/* Declarations for getting and setting flags. See mm/page_alloc.c */
dc4b0caf MG	80	#define get_pageblock_flags_group(page, start_bitidx, end_bitidx) \
	81	get_pfnblock_flags_mask(page, page_to_pfn(page), \
	82	end_bitidx, \
	83	(1 << (end_bitidx - start_bitidx + 1)) - 1)
	84	#define set_pageblock_flags_group(page, flags, start_bitidx, end_bitidx) \
	85	set_pfnblock_flags_mask(page, flags, page_to_pfn(page), \
	86	end_bitidx, \
	87	(1 << (end_bitidx - start_bitidx + 1)) - 1)
835c134e	88
bb13ffeb MG	89	#ifdef CONFIG_COMPACTION
	90	#define get_pageblock_skip(page) \
	91	get_pageblock_flags_group(page, PB_migrate_skip, \
62726059	92	PB_migrate_skip)
bb13ffeb MG	93	#define clear_pageblock_skip(page) \
bb13ffeb MG	94	set_pageblock_flags_group(page, 0, PB_migrate_skip, \
62726059	95	PB_migrate_skip)
bb13ffeb MG	96	#define set_pageblock_skip(page) \
bb13ffeb MG	97	set_pageblock_flags_group(page, 1, PB_migrate_skip, \
62726059	98	PB_migrate_skip)
21dc7e02 DR	99	#else
	100	static inline bool get_pageblock_skip(struct page *page)
	101	{
	102	return false;
	103	}
	104	static inline void clear_pageblock_skip(struct page *page)
	105	{
	106	}
	107	static inline void set_pageblock_skip(struct page *page)
	108	{
	109	}
bb13ffeb MG	110	#endif /* CONFIG_COMPACTION */
bb13ffeb MG	111
835c134e	112	#endif /* PAGEBLOCK_FLAGS_H */