[linux.git] / include / linux / page-flags.h

/*
 * Macros for manipulating and testing page->flags
 */

#ifndef PAGE_FLAGS_H
#define PAGE_FLAGS_H

#include <linux/types.h>
#include <linux/bug.h>
#ifndef __GENERATING_BOUNDS_H
#include <linux/mm_types.h>
#include <generated/bounds.h>
#endif /* !__GENERATING_BOUNDS_H */

/*
 * Various page->flags bits:
 *
 * PG_reserved is set for special pages, which can never be swapped out. Some
 * of them might not even exist (eg empty_bad_page)...
 *
 * The PG_private bitflag is set on pagecache pages if they contain filesystem
 * specific data (which is normally at page->private). It can be used by
 * private allocations for its own usage.
 *
 * During initiation of disk I/O, PG_locked is set. This bit is set before I/O
 * and cleared when writeback _starts_ or when read _completes_. PG_writeback
 * is set before writeback starts and cleared when it finishes.
 *
 * PG_locked also pins a page in pagecache, and blocks truncation of the file
 * while it is held.
 *
 * page_waitqueue(page) is a wait queue of all tasks waiting for the page
 * to become unlocked.
 *
 * PG_uptodate tells whether the page's contents is valid.  When a read
 * completes, the page becomes uptodate, unless a disk I/O error happened.
 *
 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
 * file-backed pagecache (see mm/vmscan.c).
 *
 * PG_error is set to indicate that an I/O error occurred on this page.
 *
 * PG_arch_1 is an architecture specific page state bit.  The generic code
 * guarantees that this bit is cleared for a page when it first is entered into
 * the page cache.
 *
 * PG_highmem pages are not permanently mapped into the kernel virtual address
 * space, they need to be kmapped separately for doing IO on the pages.  The
 * struct page (these bits with information) are always mapped into kernel
 * address space...
 *
 * PG_hwpoison indicates that a page got corrupted in hardware and contains
 * data with incorrect ECC bits that triggered a machine check. Accessing is
 * not safe since it may cause another machine check. Don't touch!
 */

/*
 * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
 * locked- and dirty-page accounting.
 *
 * The page flags field is split into two parts, the main flags area
 * which extends from the low bits upwards, and the fields area which
 * extends from the high bits downwards.
 *
 *  | FIELD | ... | FLAGS |
 *  N-1           ^       0
 *               (NR_PAGEFLAGS)
 *
 * The fields area is reserved for fields mapping zone, node (for NUMA) and
 * SPARSEMEM section (for variants of SPARSEMEM that require section ids like
 * SPARSEMEM_EXTREME with !SPARSEMEM_VMEMMAP).
 */
enum pageflags {
	PG_locked,		/* Page is locked. Don't touch. */
	PG_error,
	PG_referenced,
	PG_uptodate,
	PG_dirty,
	PG_lru,
	PG_active,
	PG_slab,
	PG_owner_priv_1,	/* Owner use. If pagecache, fs may use*/
	PG_arch_1,
	PG_reserved,
	PG_private,		/* If pagecache, has fs-private data */
	PG_private_2,		/* If pagecache, has fs aux data */
	PG_writeback,		/* Page is under writeback */
#ifdef CONFIG_PAGEFLAGS_EXTENDED
	PG_head,		/* A head page */
	PG_tail,		/* A tail page */
#else
	PG_compound,		/* A compound page */
#endif
	PG_swapcache,		/* Swap page: swp_entry_t in private */
	PG_mappedtodisk,	/* Has blocks allocated on-disk */
	PG_reclaim,		/* To be reclaimed asap */
	PG_swapbacked,		/* Page is backed by RAM/swap */
	PG_unevictable,		/* Page is "unevictable"  */
#ifdef CONFIG_MMU
	PG_mlocked,		/* Page is vma mlocked */
#endif
#ifdef CONFIG_ARCH_USES_PG_UNCACHED
	PG_uncached,		/* Page has been mapped as uncached */
#endif
#ifdef CONFIG_MEMORY_FAILURE
	PG_hwpoison,		/* hardware poisoned page. Don't touch */
#endif
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	PG_compound_lock,
#endif
	__NR_PAGEFLAGS,

	/* Filesystems */
	PG_checked = PG_owner_priv_1,

	/* Two page bits are conscripted by FS-Cache to maintain local caching
	 * state.  These bits are set on pages belonging to the netfs's inodes
	 * when those inodes are being locally cached.
	 */
	PG_fscache = PG_private_2,	/* page backed by cache */

	/* XEN */
	PG_pinned = PG_owner_priv_1,
	PG_savepinned = PG_dirty,

	/* SLOB */
	PG_slob_free = PG_private,
};

#ifndef __GENERATING_BOUNDS_H

/*
 * Macros to create function definitions for page flags
 */
#define TESTPAGEFLAG(uname, lname)					\
static inline int Page##uname(const struct page *page)			\
			{ return test_bit(PG_##lname, &page->flags); }

#define SETPAGEFLAG(uname, lname)					\
static inline void SetPage##uname(struct page *page)			\
			{ set_bit(PG_##lname, &page->flags); }

#define CLEARPAGEFLAG(uname, lname)					\
static inline void ClearPage##uname(struct page *page)			\
			{ clear_bit(PG_##lname, &page->flags); }

#define __SETPAGEFLAG(uname, lname)					\
static inline void __SetPage##uname(struct page *page)			\
			{ __set_bit(PG_##lname, &page->flags); }

#define __CLEARPAGEFLAG(uname, lname)					\
static inline void __ClearPage##uname(struct page *page)		\
			{ __clear_bit(PG_##lname, &page->flags); }

#define TESTSETFLAG(uname, lname)					\
static inline int TestSetPage##uname(struct page *page)			\
		{ return test_and_set_bit(PG_##lname, &page->flags); }

#define TESTCLEARFLAG(uname, lname)					\
static inline int TestClearPage##uname(struct page *page)		\
		{ return test_and_clear_bit(PG_##lname, &page->flags); }

#define __TESTCLEARFLAG(uname, lname)					\
static inline int __TestClearPage##uname(struct page *page)		\
		{ return __test_and_clear_bit(PG_##lname, &page->flags); }

#define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)		\
	SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)

#define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)		\
	__SETPAGEFLAG(uname, lname)  __CLEARPAGEFLAG(uname, lname)

#define PAGEFLAG_FALSE(uname) 						\
static inline int Page##uname(const struct page *page)			\
			{ return 0; }

#define TESTSCFLAG(uname, lname)					\
	TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)

#define SETPAGEFLAG_NOOP(uname)						\
static inline void SetPage##uname(struct page *page) {  }

#define CLEARPAGEFLAG_NOOP(uname)					\
static inline void ClearPage##uname(struct page *page) {  }

#define __CLEARPAGEFLAG_NOOP(uname)					\
static inline void __ClearPage##uname(struct page *page) {  }

#define TESTCLEARFLAG_FALSE(uname)					\
static inline int TestClearPage##uname(struct page *page) { return 0; }

#define __TESTCLEARFLAG_FALSE(uname)					\
static inline int __TestClearPage##uname(struct page *page) { return 0; }

struct page;	/* forward declaration */

TESTPAGEFLAG(Locked, locked)
PAGEFLAG(Error, error) TESTCLEARFLAG(Error, error)
PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
	TESTCLEARFLAG(Active, active)
__PAGEFLAG(Slab, slab)
PAGEFLAG(Checked, checked)		/* Used by some filesystems */
PAGEFLAG(Pinned, pinned) TESTSCFLAG(Pinned, pinned)	/* Xen */
PAGEFLAG(SavePinned, savepinned);			/* Xen */
PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
PAGEFLAG(SwapBacked, swapbacked) __CLEARPAGEFLAG(SwapBacked, swapbacked)

__PAGEFLAG(SlobFree, slob_free)

/*
 * Private page markings that may be used by the filesystem that owns the page
 * for its own purposes.
 * - PG_private and PG_private_2 cause releasepage() and co to be invoked
 */
PAGEFLAG(Private, private) __SETPAGEFLAG(Private, private)
	__CLEARPAGEFLAG(Private, private)
PAGEFLAG(Private2, private_2) TESTSCFLAG(Private2, private_2)
PAGEFLAG(OwnerPriv1, owner_priv_1) TESTCLEARFLAG(OwnerPriv1, owner_priv_1)

/*
 * Only test-and-set exist for PG_writeback.  The unconditional operators are
 * risky: they bypass page accounting.
 */
TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
PAGEFLAG(MappedToDisk, mappedtodisk)

/* PG_readahead is only used for file reads; PG_reclaim is only for writes */
PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
PAGEFLAG(Readahead, reclaim)		/* Reminder to do async read-ahead */

#ifdef CONFIG_HIGHMEM
/*
 * Must use a macro here due to header dependency issues. page_zone() is not
 * available at this point.
 */
#define PageHighMem(__p) is_highmem(page_zone(__p))
#else
PAGEFLAG_FALSE(HighMem)
#endif

#ifdef CONFIG_SWAP
PAGEFLAG(SwapCache, swapcache)
#else
PAGEFLAG_FALSE(SwapCache)
	SETPAGEFLAG_NOOP(SwapCache) CLEARPAGEFLAG_NOOP(SwapCache)
#endif

PAGEFLAG(Unevictable, unevictable) __CLEARPAGEFLAG(Unevictable, unevictable)
	TESTCLEARFLAG(Unevictable, unevictable)

#ifdef CONFIG_MMU
PAGEFLAG(Mlocked, mlocked) __CLEARPAGEFLAG(Mlocked, mlocked)
	TESTSCFLAG(Mlocked, mlocked) __TESTCLEARFLAG(Mlocked, mlocked)
#else
PAGEFLAG_FALSE(Mlocked) SETPAGEFLAG_NOOP(Mlocked)
	TESTCLEARFLAG_FALSE(Mlocked) __TESTCLEARFLAG_FALSE(Mlocked)
#endif

#ifdef CONFIG_ARCH_USES_PG_UNCACHED
PAGEFLAG(Uncached, uncached)
#else
PAGEFLAG_FALSE(Uncached)
#endif

#ifdef CONFIG_MEMORY_FAILURE
PAGEFLAG(HWPoison, hwpoison)
TESTSCFLAG(HWPoison, hwpoison)
#define __PG_HWPOISON (1UL << PG_hwpoison)
#else
PAGEFLAG_FALSE(HWPoison)
#define __PG_HWPOISON 0
#endif

u64 stable_page_flags(struct page *page);

static inline int PageUptodate(struct page *page)
{
	int ret = test_bit(PG_uptodate, &(page)->flags);

	/*
	 * Must ensure that the data we read out of the page is loaded
	 * _after_ we've loaded page->flags to check for PageUptodate.
	 * We can skip the barrier if the page is not uptodate, because
	 * we wouldn't be reading anything from it.
	 *
	 * See SetPageUptodate() for the other side of the story.
	 */
	if (ret)
		smp_rmb();

	return ret;
}

static inline void __SetPageUptodate(struct page *page)
{
	smp_wmb();
	__set_bit(PG_uptodate, &(page)->flags);
}

static inline void SetPageUptodate(struct page *page)
{
#ifdef CONFIG_S390
	if (!test_and_set_bit(PG_uptodate, &page->flags))
		page_set_storage_key(page_to_phys(page), PAGE_DEFAULT_KEY, 0);
#else
	/*
	 * Memory barrier must be issued before setting the PG_uptodate bit,
	 * so that all previous stores issued in order to bring the page
	 * uptodate are actually visible before PageUptodate becomes true.
	 *
	 * s390 doesn't need an explicit smp_wmb here because the test and
	 * set bit already provides full barriers.
	 */
	smp_wmb();
	set_bit(PG_uptodate, &(page)->flags);
#endif
}

CLEARPAGEFLAG(Uptodate, uptodate)

extern void cancel_dirty_page(struct page *page, unsigned int account_size);

int test_clear_page_writeback(struct page *page);
int test_set_page_writeback(struct page *page);

static inline void set_page_writeback(struct page *page)
{
	test_set_page_writeback(page);
}

#ifdef CONFIG_PAGEFLAGS_EXTENDED
/*
 * System with lots of page flags available. This allows separate
 * flags for PageHead() and PageTail() checks of compound pages so that bit
 * tests can be used in performance sensitive paths. PageCompound is
 * generally not used in hot code paths.
 */
__PAGEFLAG(Head, head) CLEARPAGEFLAG(Head, head)
__PAGEFLAG(Tail, tail)

static inline int PageCompound(struct page *page)
{
	return page->flags & ((1L << PG_head) | (1L << PG_tail));

}
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
static inline void ClearPageCompound(struct page *page)
{
	BUG_ON(!PageHead(page));
	ClearPageHead(page);
}
#endif
#else
/*
 * Reduce page flag use as much as possible by overlapping
 * compound page flags with the flags used for page cache pages. Possible
 * because PageCompound is always set for compound pages and not for
 * pages on the LRU and/or pagecache.
 */
TESTPAGEFLAG(Compound, compound)
__PAGEFLAG(Head, compound)

/*
 * PG_reclaim is used in combination with PG_compound to mark the
 * head and tail of a compound page. This saves one page flag
 * but makes it impossible to use compound pages for the page cache.
 * The PG_reclaim bit would have to be used for reclaim or readahead
 * if compound pages enter the page cache.
 *
 * PG_compound & PG_reclaim	=> Tail page
 * PG_compound & ~PG_reclaim	=> Head page
 */
#define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))

static inline int PageTail(struct page *page)
{
	return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
}

static inline void __SetPageTail(struct page *page)
{
	page->flags |= PG_head_tail_mask;
}

static inline void __ClearPageTail(struct page *page)
{
	page->flags &= ~PG_head_tail_mask;
}

#ifdef CONFIG_TRANSPARENT_HUGEPAGE
static inline void ClearPageCompound(struct page *page)
{
	BUG_ON((page->flags & PG_head_tail_mask) != (1 << PG_compound));
	clear_bit(PG_compound, &page->flags);
}
#endif

#endif /* !PAGEFLAGS_EXTENDED */

#ifdef CONFIG_TRANSPARENT_HUGEPAGE
/*
 * PageHuge() only returns true for hugetlbfs pages, but not for
 * normal or transparent huge pages.
 *
 * PageTransHuge() returns true for both transparent huge and
 * hugetlbfs pages, but not normal pages. PageTransHuge() can only be
 * called only in the core VM paths where hugetlbfs pages can't exist.
 */
static inline int PageTransHuge(struct page *page)
{
	VM_BUG_ON(PageTail(page));
	return PageHead(page);
}

static inline int PageTransCompound(struct page *page)
{
	return PageCompound(page);
}

#else

static inline int PageTransHuge(struct page *page)
{
	return 0;
}

static inline int PageTransCompound(struct page *page)
{
	return 0;
}
#endif

#ifdef CONFIG_MMU
#define __PG_MLOCKED		(1 << PG_mlocked)
#else
#define __PG_MLOCKED		0
#endif

#ifdef CONFIG_TRANSPARENT_HUGEPAGE
#define __PG_COMPOUND_LOCK		(1 << PG_compound_lock)
#else
#define __PG_COMPOUND_LOCK		0
#endif

/*
 * Flags checked when a page is freed.  Pages being freed should not have
 * these flags set.  It they are, there is a problem.
 */
#define PAGE_FLAGS_CHECK_AT_FREE \
	(1 << PG_lru	 | 1 << PG_locked    | \
	 1 << PG_private | 1 << PG_private_2 | \
	 1 << PG_writeback | 1 << PG_reserved | \
	 1 << PG_slab	 | 1 << PG_swapcache | 1 << PG_active | \
	 1 << PG_unevictable | __PG_MLOCKED | __PG_HWPOISON | \
	 __PG_COMPOUND_LOCK)

/*
 * Flags checked when a page is prepped for return by the page allocator.
 * Pages being prepped should not have any flags set.  It they are set,
 * there has been a kernel bug or struct page corruption.
 */
#define PAGE_FLAGS_CHECK_AT_PREP	((1 << NR_PAGEFLAGS) - 1)

#define PAGE_FLAGS_PRIVATE				\
	(1 << PG_private | 1 << PG_private_2)
/**
 * page_has_private - Determine if page has private stuff
 * @page: The page to be checked
 *
 * Determine if a page has private stuff, indicating that release routines
 * should be invoked upon it.
 */
static inline int page_has_private(struct page *page)
{
	return !!(page->flags & PAGE_FLAGS_PRIVATE);
}

#endif /* !__GENERATING_BOUNDS_H */

#endif	/* PAGE_FLAGS_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Macros for manipulating and testing page->flags
	3	*/
	4
	5	#ifndef PAGE_FLAGS_H
	6	#define PAGE_FLAGS_H
	7
f886ed44	8	#include <linux/types.h>
187f1882	9	#include <linux/bug.h>
9223b419	10	#ifndef __GENERATING_BOUNDS_H
6d777953	11	#include <linux/mm_types.h>
01fc0ac1	12	#include <generated/bounds.h>
9223b419	13	#endif /* !__GENERATING_BOUNDS_H */
f886ed44	14
1da177e4 LT	15	/*
	16	* Various page->flags bits:
	17	*
	18	* PG_reserved is set for special pages, which can never be swapped out. Some
	19	* of them might not even exist (eg empty_bad_page)...
	20	*
da6052f7 NP	21	* The PG_private bitflag is set on pagecache pages if they contain filesystem
	22	* specific data (which is normally at page->private). It can be used by
	23	* private allocations for its own usage.
1da177e4	24	*
da6052f7 NP	25	* During initiation of disk I/O, PG_locked is set. This bit is set before I/O
	26	* and cleared when writeback _starts_ or when read _completes_. PG_writeback
	27	* is set before writeback starts and cleared when it finishes.
	28	*
	29	* PG_locked also pins a page in pagecache, and blocks truncation of the file
	30	* while it is held.
	31	*
	32	* page_waitqueue(page) is a wait queue of all tasks waiting for the page
	33	* to become unlocked.
1da177e4 LT	34	*
	35	* PG_uptodate tells whether the page's contents is valid. When a read
	36	* completes, the page becomes uptodate, unless a disk I/O error happened.
	37	*
da6052f7 NP	38	* PG_referenced, PG_reclaim are used for page reclaim for anonymous and
da6052f7 NP	39	* file-backed pagecache (see mm/vmscan.c).
1da177e4 LT	40	*
	41	* PG_error is set to indicate that an I/O error occurred on this page.
	42	*
	43	* PG_arch_1 is an architecture specific page state bit. The generic code
	44	* guarantees that this bit is cleared for a page when it first is entered into
	45	* the page cache.
	46	*
	47	* PG_highmem pages are not permanently mapped into the kernel virtual address
	48	* space, they need to be kmapped separately for doing IO on the pages. The
	49	* struct page (these bits with information) are always mapped into kernel
	50	* address space...
da6052f7	51	*
d466f2fc AK	52	* PG_hwpoison indicates that a page got corrupted in hardware and contains
	53	* data with incorrect ECC bits that triggered a machine check. Accessing is
	54	* not safe since it may cause another machine check. Don't touch!
1da177e4 LT	55	*/
	56
	57	/*
	58	* Don't use the *_dontuse flags. Use the macros. Otherwise you'll break
91fc8ab3 AW	59	* locked- and dirty-page accounting.
	60	*
	61	* The page flags field is split into two parts, the main flags area
	62	* which extends from the low bits upwards, and the fields area which
	63	* extends from the high bits downwards.
	64	*
	65	* \| FIELD \| ... \| FLAGS \|
9223b419 CL	66	* N-1 ^ 0
9223b419 CL	67	* (NR_PAGEFLAGS)
91fc8ab3	68	*
9223b419 CL	69	* The fields area is reserved for fields mapping zone, node (for NUMA) and
	70	* SPARSEMEM section (for variants of SPARSEMEM that require section ids like
	71	* SPARSEMEM_EXTREME with !SPARSEMEM_VMEMMAP).
1da177e4	72	*/
e2683181 CL	73	enum pageflags {
	74	PG_locked, /* Page is locked. Don't touch. */
	75	PG_error,
	76	PG_referenced,
	77	PG_uptodate,
	78	PG_dirty,
	79	PG_lru,
	80	PG_active,
	81	PG_slab,
	82	PG_owner_priv_1, /* Owner use. If pagecache, fs may use*/
e2683181 CL	83	PG_arch_1,
	84	PG_reserved,
	85	PG_private, /* If pagecache, has fs-private data */
266cf658	86	PG_private_2, /* If pagecache, has fs aux data */
e2683181	87	PG_writeback, /* Page is under writeback */
e20b8cca CL	88	#ifdef CONFIG_PAGEFLAGS_EXTENDED
	89	PG_head, /* A head page */
	90	PG_tail, /* A tail page */
	91	#else
e2683181	92	PG_compound, /* A compound page */
e20b8cca	93	#endif
e2683181 CL	94	PG_swapcache, /* Swap page: swp_entry_t in private */
	95	PG_mappedtodisk, /* Has blocks allocated on-disk */
	96	PG_reclaim, /* To be reclaimed asap */
b2e18538	97	PG_swapbacked, /* Page is backed by RAM/swap */
894bc310	98	PG_unevictable, /* Page is "unevictable" */
af8e3354	99	#ifdef CONFIG_MMU
b291f000	100	PG_mlocked, /* Page is vma mlocked */
894bc310	101	#endif
46cf98cd	102	#ifdef CONFIG_ARCH_USES_PG_UNCACHED
602c4d11	103	PG_uncached, /* Page has been mapped as uncached */
d466f2fc AK	104	#endif
	105	#ifdef CONFIG_MEMORY_FAILURE
	106	PG_hwpoison, /* hardware poisoned page. Don't touch */
e9da73d6 AA	107	#endif
	108	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	109	PG_compound_lock,
f886ed44	110	#endif
0cad47cf AW	111	__NR_PAGEFLAGS,
	112
	113	/* Filesystems */
	114	PG_checked = PG_owner_priv_1,
	115
266cf658 DH	116	/* Two page bits are conscripted by FS-Cache to maintain local caching
	117	* state. These bits are set on pages belonging to the netfs's inodes
	118	* when those inodes are being locally cached.
	119	*/
	120	PG_fscache = PG_private_2, /* page backed by cache */
	121
0cad47cf AW	122	/* XEN */
	123	PG_pinned = PG_owner_priv_1,
	124	PG_savepinned = PG_dirty,
8a38082d	125
9023cb7e	126	/* SLOB */
9023cb7e	127	PG_slob_free = PG_private,
e2683181	128	};
1da177e4	129
9223b419 CL	130	#ifndef __GENERATING_BOUNDS_H
9223b419 CL	131
f94a62e9 CL	132	/*
	133	* Macros to create function definitions for page flags
	134	*/
	135	#define TESTPAGEFLAG(uname, lname) \
67db392d	136	static inline int Page##uname(const struct page *page) \
f94a62e9 CL	137	{ return test_bit(PG_##lname, &page->flags); }
	138
	139	#define SETPAGEFLAG(uname, lname) \
	140	static inline void SetPage##uname(struct page *page) \
	141	{ set_bit(PG_##lname, &page->flags); }
	142
	143	#define CLEARPAGEFLAG(uname, lname) \
	144	static inline void ClearPage##uname(struct page *page) \
	145	{ clear_bit(PG_##lname, &page->flags); }
	146
	147	#define __SETPAGEFLAG(uname, lname) \
	148	static inline void __SetPage##uname(struct page *page) \
	149	{ __set_bit(PG_##lname, &page->flags); }
	150
	151	#define __CLEARPAGEFLAG(uname, lname) \
	152	static inline void __ClearPage##uname(struct page *page) \
	153	{ __clear_bit(PG_##lname, &page->flags); }
	154
	155	#define TESTSETFLAG(uname, lname) \
	156	static inline int TestSetPage##uname(struct page *page) \
	157	{ return test_and_set_bit(PG_##lname, &page->flags); }
	158
	159	#define TESTCLEARFLAG(uname, lname) \
	160	static inline int TestClearPage##uname(struct page *page) \
	161	{ return test_and_clear_bit(PG_##lname, &page->flags); }
	162
451ea25d JW	163	#define __TESTCLEARFLAG(uname, lname) \
	164	static inline int __TestClearPage##uname(struct page *page) \
	165	{ return __test_and_clear_bit(PG_##lname, &page->flags); }
f94a62e9 CL	166
	167	#define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
	168	SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
	169
	170	#define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
	171	__SETPAGEFLAG(uname, lname) __CLEARPAGEFLAG(uname, lname)
	172
ec7cade8	173	#define PAGEFLAG_FALSE(uname) \
67db392d	174	static inline int Page##uname(const struct page *page) \
ec7cade8 CL	175	{ return 0; }
ec7cade8 CL	176
f94a62e9 CL	177	#define TESTSCFLAG(uname, lname) \
	178	TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
	179
8a7a8544 LS	180	#define SETPAGEFLAG_NOOP(uname) \
	181	static inline void SetPage##uname(struct page *page) { }
	182
	183	#define CLEARPAGEFLAG_NOOP(uname) \
	184	static inline void ClearPage##uname(struct page *page) { }
	185
	186	#define __CLEARPAGEFLAG_NOOP(uname) \
	187	static inline void __ClearPage##uname(struct page *page) { }
	188
	189	#define TESTCLEARFLAG_FALSE(uname) \
	190	static inline int TestClearPage##uname(struct page *page) { return 0; }
	191
451ea25d JW	192	#define __TESTCLEARFLAG_FALSE(uname) \
	193	static inline int __TestClearPage##uname(struct page *page) { return 0; }
	194
6a1e7f77 CL	195	struct page; /* forward declaration */
6a1e7f77 CL	196
cb240452	197	TESTPAGEFLAG(Locked, locked)
212260aa	198	PAGEFLAG(Error, error) TESTCLEARFLAG(Error, error)
6a1e7f77 CL	199	PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
	200	PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
	201	PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
	202	PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
894bc310	203	TESTCLEARFLAG(Active, active)
6a1e7f77	204	__PAGEFLAG(Slab, slab)
0cad47cf AW	205	PAGEFLAG(Checked, checked) /* Used by some filesystems */
	206	PAGEFLAG(Pinned, pinned) TESTSCFLAG(Pinned, pinned) /* Xen */
	207	PAGEFLAG(SavePinned, savepinned); /* Xen */
6a1e7f77	208	PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
b2e18538	209	PAGEFLAG(SwapBacked, swapbacked) __CLEARPAGEFLAG(SwapBacked, swapbacked)
6a1e7f77	210
9023cb7e AW	211	__PAGEFLAG(SlobFree, slob_free)
9023cb7e AW	212
266cf658 DH	213	/*
	214	* Private page markings that may be used by the filesystem that owns the page
	215	* for its own purposes.
	216	* - PG_private and PG_private_2 cause releasepage() and co to be invoked
	217	*/
	218	PAGEFLAG(Private, private) __SETPAGEFLAG(Private, private)
	219	__CLEARPAGEFLAG(Private, private)
	220	PAGEFLAG(Private2, private_2) TESTSCFLAG(Private2, private_2)
	221	PAGEFLAG(OwnerPriv1, owner_priv_1) TESTCLEARFLAG(OwnerPriv1, owner_priv_1)
	222
6a1e7f77 CL	223	/*
	224	* Only test-and-set exist for PG_writeback. The unconditional operators are
	225	* risky: they bypass page accounting.
	226	*/
	227	TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
6a1e7f77 CL	228	PAGEFLAG(MappedToDisk, mappedtodisk)
	229
	230	/* PG_readahead is only used for file reads; PG_reclaim is only for writes */
	231	PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
0a128b2b	232	PAGEFLAG(Readahead, reclaim) /* Reminder to do async read-ahead */
6a1e7f77 CL	233
6a1e7f77 CL	234	#ifdef CONFIG_HIGHMEM
1da177e4	235	/*
6a1e7f77 CL	236	* Must use a macro here due to header dependency issues. page_zone() is not
6a1e7f77 CL	237	* available at this point.
1da177e4	238	*/
0a128b2b	239	#define PageHighMem(__p) is_highmem(page_zone(__p))
6a1e7f77	240	#else
ec7cade8	241	PAGEFLAG_FALSE(HighMem)
6a1e7f77 CL	242	#endif
	243
	244	#ifdef CONFIG_SWAP
	245	PAGEFLAG(SwapCache, swapcache)
	246	#else
ec7cade8	247	PAGEFLAG_FALSE(SwapCache)
6d91add0	248	SETPAGEFLAG_NOOP(SwapCache) CLEARPAGEFLAG_NOOP(SwapCache)
6a1e7f77 CL	249	#endif
6a1e7f77 CL	250
894bc310 LS	251	PAGEFLAG(Unevictable, unevictable) __CLEARPAGEFLAG(Unevictable, unevictable)
894bc310 LS	252	TESTCLEARFLAG(Unevictable, unevictable)
b291f000	253
af8e3354	254	#ifdef CONFIG_MMU
b291f000	255	PAGEFLAG(Mlocked, mlocked) __CLEARPAGEFLAG(Mlocked, mlocked)
451ea25d	256	TESTSCFLAG(Mlocked, mlocked) __TESTCLEARFLAG(Mlocked, mlocked)
894bc310	257	#else
451ea25d JW	258	PAGEFLAG_FALSE(Mlocked) SETPAGEFLAG_NOOP(Mlocked)
451ea25d JW	259	TESTCLEARFLAG_FALSE(Mlocked) __TESTCLEARFLAG_FALSE(Mlocked)
894bc310 LS	260	#endif
894bc310 LS	261
46cf98cd	262	#ifdef CONFIG_ARCH_USES_PG_UNCACHED
6a1e7f77	263	PAGEFLAG(Uncached, uncached)
602c4d11	264	#else
ec7cade8	265	PAGEFLAG_FALSE(Uncached)
6a1e7f77	266	#endif
1da177e4	267
d466f2fc AK	268	#ifdef CONFIG_MEMORY_FAILURE
d466f2fc AK	269	PAGEFLAG(HWPoison, hwpoison)
847ce401	270	TESTSCFLAG(HWPoison, hwpoison)
d466f2fc AK	271	#define __PG_HWPOISON (1UL << PG_hwpoison)
	272	#else
	273	PAGEFLAG_FALSE(HWPoison)
	274	#define __PG_HWPOISON 0
	275	#endif
	276
1a9b5b7f WF	277	u64 stable_page_flags(struct page *page);
1a9b5b7f WF	278
0ed361de NP	279	static inline int PageUptodate(struct page *page)
	280	{
	281	int ret = test_bit(PG_uptodate, &(page)->flags);
	282
	283	/*
	284	* Must ensure that the data we read out of the page is loaded
	285	* _after_ we've loaded page->flags to check for PageUptodate.
	286	* We can skip the barrier if the page is not uptodate, because
	287	* we wouldn't be reading anything from it.
	288	*
	289	* See SetPageUptodate() for the other side of the story.
	290	*/
	291	if (ret)
	292	smp_rmb();
	293
	294	return ret;
	295	}
	296
	297	static inline void __SetPageUptodate(struct page *page)
	298	{
	299	smp_wmb();
	300	__set_bit(PG_uptodate, &(page)->flags);
0ed361de NP	301	}
0ed361de NP	302
2dcea57a HC	303	static inline void SetPageUptodate(struct page *page)
2dcea57a HC	304	{
0ed361de	305	#ifdef CONFIG_S390
2dcea57a	306	if (!test_and_set_bit(PG_uptodate, &page->flags))
a43a9d93	307	page_set_storage_key(page_to_phys(page), PAGE_DEFAULT_KEY, 0);
f6ac2354	308	#else
0ed361de NP	309	/*
	310	* Memory barrier must be issued before setting the PG_uptodate bit,
	311	* so that all previous stores issued in order to bring the page
	312	* uptodate are actually visible before PageUptodate becomes true.
	313	*
	314	* s390 doesn't need an explicit smp_wmb here because the test and
	315	* set bit already provides full barriers.
	316	*/
	317	smp_wmb();
	318	set_bit(PG_uptodate, &(page)->flags);
1da177e4	319	#endif
0ed361de NP	320	}
0ed361de NP	321
6a1e7f77	322	CLEARPAGEFLAG(Uptodate, uptodate)
1da177e4	323
6a1e7f77	324	extern void cancel_dirty_page(struct page *page, unsigned int account_size);
d77c2d7c	325
6a1e7f77 CL	326	int test_clear_page_writeback(struct page *page);
6a1e7f77 CL	327	int test_set_page_writeback(struct page *page);
1da177e4	328
6a1e7f77 CL	329	static inline void set_page_writeback(struct page *page)
	330	{
	331	test_set_page_writeback(page);
	332	}
1da177e4	333
e20b8cca CL	334	#ifdef CONFIG_PAGEFLAGS_EXTENDED
	335	/*
	336	* System with lots of page flags available. This allows separate
	337	* flags for PageHead() and PageTail() checks of compound pages so that bit
	338	* tests can be used in performance sensitive paths. PageCompound is
	339	* generally not used in hot code paths.
	340	*/
4e6af67e	341	__PAGEFLAG(Head, head) CLEARPAGEFLAG(Head, head)
e20b8cca CL	342	__PAGEFLAG(Tail, tail)
	343
	344	static inline int PageCompound(struct page *page)
	345	{
	346	return page->flags & ((1L << PG_head) \| (1L << PG_tail));
	347
	348	}
4e6af67e AA	349	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	350	static inline void ClearPageCompound(struct page *page)
	351	{
	352	BUG_ON(!PageHead(page));
	353	ClearPageHead(page);
	354	}
	355	#endif
e20b8cca CL	356	#else
	357	/*
	358	* Reduce page flag use as much as possible by overlapping
	359	* compound page flags with the flags used for page cache pages. Possible
	360	* because PageCompound is always set for compound pages and not for
	361	* pages on the LRU and/or pagecache.
	362	*/
6a1e7f77 CL	363	TESTPAGEFLAG(Compound, compound)
6a1e7f77 CL	364	__PAGEFLAG(Head, compound)
1da177e4	365
d85f3385	366	/*
6d777953	367	* PG_reclaim is used in combination with PG_compound to mark the
6a1e7f77 CL	368	* head and tail of a compound page. This saves one page flag
	369	* but makes it impossible to use compound pages for the page cache.
	370	* The PG_reclaim bit would have to be used for reclaim or readahead
	371	* if compound pages enter the page cache.
6d777953 CL	372	*
	373	* PG_compound & PG_reclaim => Tail page
	374	* PG_compound & ~PG_reclaim => Head page
d85f3385	375	*/
6d777953 CL	376	#define PG_head_tail_mask ((1L << PG_compound) \| (1L << PG_reclaim))
6d777953 CL	377
6a1e7f77 CL	378	static inline int PageTail(struct page *page)
	379	{
	380	return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
	381	}
6d777953 CL	382
	383	static inline void __SetPageTail(struct page *page)
	384	{
	385	page->flags \|= PG_head_tail_mask;
	386	}
	387
	388	static inline void __ClearPageTail(struct page *page)
	389	{
	390	page->flags &= ~PG_head_tail_mask;
	391	}
	392
4e6af67e AA	393	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	394	static inline void ClearPageCompound(struct page *page)
	395	{
	396	BUG_ON((page->flags & PG_head_tail_mask) != (1 << PG_compound));
	397	clear_bit(PG_compound, &page->flags);
	398	}
	399	#endif
	400
e20b8cca	401	#endif /* !PAGEFLAGS_EXTENDED */
dfa7e20c	402
936a5fe6	403	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
71e3aac0 AA	404	/*
	405	* PageHuge() only returns true for hugetlbfs pages, but not for
	406	* normal or transparent huge pages.
	407	*
	408	* PageTransHuge() returns true for both transparent huge and
	409	* hugetlbfs pages, but not normal pages. PageTransHuge() can only be
	410	* called only in the core VM paths where hugetlbfs pages can't exist.
	411	*/
	412	static inline int PageTransHuge(struct page *page)
	413	{
	414	VM_BUG_ON(PageTail(page));
	415	return PageHead(page);
	416	}
	417
936a5fe6 AA	418	static inline int PageTransCompound(struct page *page)
	419	{
	420	return PageCompound(page);
	421	}
71e3aac0	422
936a5fe6	423	#else
71e3aac0 AA	424
	425	static inline int PageTransHuge(struct page *page)
	426	{
	427	return 0;
	428	}
	429
936a5fe6 AA	430	static inline int PageTransCompound(struct page *page)
	431	{
	432	return 0;
	433	}
	434	#endif
	435
af8e3354	436	#ifdef CONFIG_MMU
33925b25 DH	437	#define __PG_MLOCKED (1 << PG_mlocked)
33925b25 DH	438	#else
b291f000	439	#define __PG_MLOCKED 0
894bc310 LS	440	#endif
894bc310 LS	441
e9da73d6 AA	442	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	443	#define __PG_COMPOUND_LOCK (1 << PG_compound_lock)
	444	#else
	445	#define __PG_COMPOUND_LOCK 0
	446	#endif
	447
dfa7e20c RA	448	/*
	449	* Flags checked when a page is freed. Pages being freed should not have
	450	* these flags set. It they are, there is a problem.
	451	*/
79f4b7bf	452	#define PAGE_FLAGS_CHECK_AT_FREE \
266cf658 DH	453	(1 << PG_lru \| 1 << PG_locked \| \
266cf658 DH	454	1 << PG_private \| 1 << PG_private_2 \| \
5f24ce5f	455	1 << PG_writeback \| 1 << PG_reserved \| \
266cf658	456	1 << PG_slab \| 1 << PG_swapcache \| 1 << PG_active \| \
e9da73d6 AA	457	1 << PG_unevictable \| __PG_MLOCKED \| __PG_HWPOISON \| \
e9da73d6 AA	458	__PG_COMPOUND_LOCK)
dfa7e20c RA	459
	460	/*
	461	* Flags checked when a page is prepped for return by the page allocator.
79f4b7bf HD	462	* Pages being prepped should not have any flags set. It they are set,
79f4b7bf HD	463	* there has been a kernel bug or struct page corruption.
dfa7e20c	464	*/
79f4b7bf	465	#define PAGE_FLAGS_CHECK_AT_PREP ((1 << NR_PAGEFLAGS) - 1)
dfa7e20c	466
edcf4748 JW	467	#define PAGE_FLAGS_PRIVATE \
edcf4748 JW	468	(1 << PG_private \| 1 << PG_private_2)
266cf658 DH	469	/**
	470	* page_has_private - Determine if page has private stuff
	471	* @page: The page to be checked
	472	*
	473	* Determine if a page has private stuff, indicating that release routines
	474	* should be invoked upon it.
	475	*/
edcf4748 JW	476	static inline int page_has_private(struct page *page)
	477	{
	478	return !!(page->flags & PAGE_FLAGS_PRIVATE);
	479	}
	480
	481	#endif /* !__GENERATING_BOUNDS_H */
266cf658	482
1da177e4	483	#endif /* PAGE_FLAGS_H */