blob: 12ab023b67f284054056584938bc0c223cfffbaf [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Macros for manipulating and testing page->flags
3 */
4
5#ifndef PAGE_FLAGS_H
6#define PAGE_FLAGS_H
7
Andrew Mortonf886ed42006-06-23 02:03:06 -07008#include <linux/types.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -05009#include <linux/bug.h>
Mel Gorman072bb0a2012-07-31 16:43:58 -070010#include <linux/mmdebug.h>
Christoph Lameter9223b412008-04-28 02:12:48 -070011#ifndef __GENERATING_BOUNDS_H
Christoph Lameter6d777952007-05-06 14:49:40 -070012#include <linux/mm_types.h>
Sam Ravnborg01fc0ac2009-04-19 21:57:19 +020013#include <generated/bounds.h>
Christoph Lameter9223b412008-04-28 02:12:48 -070014#endif /* !__GENERATING_BOUNDS_H */
Andrew Mortonf886ed42006-06-23 02:03:06 -070015
Linus Torvalds1da177e2005-04-16 15:20:36 -070016/*
17 * Various page->flags bits:
18 *
19 * PG_reserved is set for special pages, which can never be swapped out. Some
20 * of them might not even exist (eg empty_bad_page)...
21 *
Nick Pigginda6052f2006-09-25 23:31:35 -070022 * The PG_private bitflag is set on pagecache pages if they contain filesystem
23 * specific data (which is normally at page->private). It can be used by
24 * private allocations for its own usage.
Linus Torvalds1da177e2005-04-16 15:20:36 -070025 *
Nick Pigginda6052f2006-09-25 23:31:35 -070026 * During initiation of disk I/O, PG_locked is set. This bit is set before I/O
27 * and cleared when writeback _starts_ or when read _completes_. PG_writeback
28 * is set before writeback starts and cleared when it finishes.
29 *
30 * PG_locked also pins a page in pagecache, and blocks truncation of the file
31 * while it is held.
32 *
33 * page_waitqueue(page) is a wait queue of all tasks waiting for the page
34 * to become unlocked.
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 *
36 * PG_uptodate tells whether the page's contents is valid. When a read
37 * completes, the page becomes uptodate, unless a disk I/O error happened.
38 *
Nick Pigginda6052f2006-09-25 23:31:35 -070039 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
40 * file-backed pagecache (see mm/vmscan.c).
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 *
42 * PG_error is set to indicate that an I/O error occurred on this page.
43 *
44 * PG_arch_1 is an architecture specific page state bit. The generic code
45 * guarantees that this bit is cleared for a page when it first is entered into
46 * the page cache.
47 *
48 * PG_highmem pages are not permanently mapped into the kernel virtual address
49 * space, they need to be kmapped separately for doing IO on the pages. The
50 * struct page (these bits with information) are always mapped into kernel
51 * address space...
Nick Pigginda6052f2006-09-25 23:31:35 -070052 *
Andi Kleend466f2f2009-09-16 11:50:03 +020053 * PG_hwpoison indicates that a page got corrupted in hardware and contains
54 * data with incorrect ECC bits that triggered a machine check. Accessing is
55 * not safe since it may cause another machine check. Don't touch!
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 */
57
58/*
59 * Don't use the *_dontuse flags. Use the macros. Otherwise you'll break
Andy Whitcroft91fc8ab2006-04-10 22:53:01 -070060 * locked- and dirty-page accounting.
61 *
62 * The page flags field is split into two parts, the main flags area
63 * which extends from the low bits upwards, and the fields area which
64 * extends from the high bits downwards.
65 *
66 * | FIELD | ... | FLAGS |
Christoph Lameter9223b412008-04-28 02:12:48 -070067 * N-1 ^ 0
68 * (NR_PAGEFLAGS)
Andy Whitcroft91fc8ab2006-04-10 22:53:01 -070069 *
Christoph Lameter9223b412008-04-28 02:12:48 -070070 * The fields area is reserved for fields mapping zone, node (for NUMA) and
71 * SPARSEMEM section (for variants of SPARSEMEM that require section ids like
72 * SPARSEMEM_EXTREME with !SPARSEMEM_VMEMMAP).
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 */
Christoph Lametere2683182008-04-28 02:12:47 -070074enum pageflags {
75 PG_locked, /* Page is locked. Don't touch. */
76 PG_error,
77 PG_referenced,
78 PG_uptodate,
79 PG_dirty,
80 PG_lru,
81 PG_active,
82 PG_slab,
83 PG_owner_priv_1, /* Owner use. If pagecache, fs may use*/
Christoph Lametere2683182008-04-28 02:12:47 -070084 PG_arch_1,
85 PG_reserved,
86 PG_private, /* If pagecache, has fs-private data */
David Howells266cf652009-04-03 16:42:36 +010087 PG_private_2, /* If pagecache, has fs aux data */
Christoph Lametere2683182008-04-28 02:12:47 -070088 PG_writeback, /* Page is under writeback */
Christoph Lametere20b8cc2008-04-28 02:12:55 -070089 PG_head, /* A head page */
Christoph Lametere2683182008-04-28 02:12:47 -070090 PG_swapcache, /* Swap page: swp_entry_t in private */
91 PG_mappedtodisk, /* Has blocks allocated on-disk */
92 PG_reclaim, /* To be reclaimed asap */
Rik van Rielb2e18532008-10-18 20:26:30 -070093 PG_swapbacked, /* Page is backed by RAM/swap */
Lee Schermerhorn894bc312008-10-18 20:26:39 -070094 PG_unevictable, /* Page is "unevictable" */
Hugh Dickinsaf8e3352009-12-14 17:58:59 -080095#ifdef CONFIG_MMU
Nick Pigginb291f002008-10-18 20:26:44 -070096 PG_mlocked, /* Page is vma mlocked */
Lee Schermerhorn894bc312008-10-18 20:26:39 -070097#endif
Venkatesh Pallipadi46cf98c2009-07-10 09:57:37 -070098#ifdef CONFIG_ARCH_USES_PG_UNCACHED
Christoph Lameter602c4d12008-04-28 02:12:52 -070099 PG_uncached, /* Page has been mapped as uncached */
Andrew Mortonf886ed42006-06-23 02:03:06 -0700100#endif
Andi Kleend466f2f2009-09-16 11:50:03 +0200101#ifdef CONFIG_MEMORY_FAILURE
102 PG_hwpoison, /* hardware poisoned page. Don't touch */
103#endif
Andrea Arcangelie9da73d2011-01-13 15:46:32 -0800104#ifdef CONFIG_TRANSPARENT_HUGEPAGE
105 PG_compound_lock,
106#endif
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700107#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
108 PG_young,
109 PG_idle,
110#endif
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700111 __NR_PAGEFLAGS,
112
113 /* Filesystems */
114 PG_checked = PG_owner_priv_1,
115
David Howells266cf652009-04-03 16:42:36 +0100116 /* 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
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700122 /* XEN */
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000123 /* Pinned in Xen as a read-only pagetable page. */
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700124 PG_pinned = PG_owner_priv_1,
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000125 /* Pinned as part of domain save (see xen_mm_pin_all()). */
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700126 PG_savepinned = PG_dirty,
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000127 /* Has a grant mapping of another (foreign) domain's page. */
128 PG_foreign = PG_owner_priv_1,
Andy Whitcroft8a380822008-07-23 21:27:18 -0700129
Andy Whitcroft9023cb72008-07-23 21:27:19 -0700130 /* SLOB */
Andy Whitcroft9023cb72008-07-23 21:27:19 -0700131 PG_slob_free = PG_private,
Christoph Lametere2683182008-04-28 02:12:47 -0700132};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Christoph Lameter9223b412008-04-28 02:12:48 -0700134#ifndef __GENERATING_BOUNDS_H
135
Kirill A. Shutemov0e6d31a2016-01-15 16:51:17 -0800136struct page; /* forward declaration */
137
138static inline struct page *compound_head(struct page *page)
139{
140 unsigned long head = READ_ONCE(page->compound_head);
141
142 if (unlikely(head & 1))
143 return (struct page *) (head - 1);
144 return page;
145}
146
147static inline int PageTail(struct page *page)
148{
149 return READ_ONCE(page->compound_head) & 1;
150}
151
152static inline int PageCompound(struct page *page)
153{
154 return test_bit(PG_head, &page->flags) || PageTail(page);
155}
156
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157/*
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800158 * Page flags policies wrt compound pages
159 *
160 * PF_ANY:
161 * the page flag is relevant for small, head and tail pages.
162 *
163 * PF_HEAD:
164 * for compound page all operations related to the page flag applied to
165 * head page.
166 *
167 * PF_NO_TAIL:
168 * modifications of the page flag must be done on small or head pages,
169 * checks can be done on tail pages too.
170 *
171 * PF_NO_COMPOUND:
172 * the page flag is not relevant for compound pages.
173 */
174#define PF_ANY(page, enforce) page
175#define PF_HEAD(page, enforce) compound_head(page)
176#define PF_NO_TAIL(page, enforce) ({ \
177 VM_BUG_ON_PGFLAGS(enforce && PageTail(page), page); \
178 compound_head(page);})
179#define PF_NO_COMPOUND(page, enforce) ({ \
180 VM_BUG_ON_PGFLAGS(enforce && PageCompound(page), page); \
181 page;})
182
183/*
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700184 * Macros to create function definitions for page flags
185 */
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800186#define TESTPAGEFLAG(uname, lname, policy) \
187static inline int Page##uname(struct page *page) \
188 { return test_bit(PG_##lname, &policy(page, 0)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700189
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800190#define SETPAGEFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700191static inline void SetPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800192 { set_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700193
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800194#define CLEARPAGEFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700195static inline void ClearPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800196 { clear_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700197
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800198#define __SETPAGEFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700199static inline void __SetPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800200 { __set_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700201
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800202#define __CLEARPAGEFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700203static inline void __ClearPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800204 { __clear_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700205
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800206#define TESTSETFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700207static inline int TestSetPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800208 { return test_and_set_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700209
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800210#define TESTCLEARFLAG(uname, lname, policy) \
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700211static inline int TestClearPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800212 { return test_and_clear_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700213
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800214#define __TESTCLEARFLAG(uname, lname, policy) \
Johannes Weiner451ea252009-09-21 17:01:48 -0700215static inline int __TestClearPage##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800216 { return __test_and_clear_bit(PG_##lname, &policy(page, 1)->flags); }
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700217
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800218#define PAGEFLAG(uname, lname, policy) \
219 TESTPAGEFLAG(uname, lname, policy) \
220 SETPAGEFLAG(uname, lname, policy) \
221 CLEARPAGEFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700222
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800223#define __PAGEFLAG(uname, lname, policy) \
224 TESTPAGEFLAG(uname, lname, policy) \
225 __SETPAGEFLAG(uname, lname, policy) \
226 __CLEARPAGEFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700227
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800228#define TESTSCFLAG(uname, lname, policy) \
229 TESTSETFLAG(uname, lname, policy) \
230 TESTCLEARFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700231
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700232#define TESTPAGEFLAG_FALSE(uname) \
233static inline int Page##uname(const struct page *page) { return 0; }
234
Lee Schermerhorn8a7a8542008-10-18 20:26:37 -0700235#define SETPAGEFLAG_NOOP(uname) \
236static inline void SetPage##uname(struct page *page) { }
237
238#define CLEARPAGEFLAG_NOOP(uname) \
239static inline void ClearPage##uname(struct page *page) { }
240
241#define __CLEARPAGEFLAG_NOOP(uname) \
242static inline void __ClearPage##uname(struct page *page) { }
243
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700244#define TESTSETFLAG_FALSE(uname) \
245static inline int TestSetPage##uname(struct page *page) { return 0; }
246
Lee Schermerhorn8a7a8542008-10-18 20:26:37 -0700247#define TESTCLEARFLAG_FALSE(uname) \
248static inline int TestClearPage##uname(struct page *page) { return 0; }
249
Johannes Weiner451ea252009-09-21 17:01:48 -0700250#define __TESTCLEARFLAG_FALSE(uname) \
251static inline int __TestClearPage##uname(struct page *page) { return 0; }
252
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700253#define PAGEFLAG_FALSE(uname) TESTPAGEFLAG_FALSE(uname) \
254 SETPAGEFLAG_NOOP(uname) CLEARPAGEFLAG_NOOP(uname)
255
256#define TESTSCFLAG_FALSE(uname) \
257 TESTSETFLAG_FALSE(uname) TESTCLEARFLAG_FALSE(uname)
258
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800259TESTPAGEFLAG(Locked, locked, PF_ANY)
260PAGEFLAG(Error, error, PF_ANY) TESTCLEARFLAG(Error, error, PF_ANY)
261PAGEFLAG(Referenced, referenced, PF_ANY) TESTCLEARFLAG(Referenced, referenced, PF_ANY)
262 __SETPAGEFLAG(Referenced, referenced, PF_ANY)
263PAGEFLAG(Dirty, dirty, PF_ANY) TESTSCFLAG(Dirty, dirty, PF_ANY)
264 __CLEARPAGEFLAG(Dirty, dirty, PF_ANY)
265PAGEFLAG(LRU, lru, PF_ANY) __CLEARPAGEFLAG(LRU, lru, PF_ANY)
266PAGEFLAG(Active, active, PF_ANY) __CLEARPAGEFLAG(Active, active, PF_ANY)
267 TESTCLEARFLAG(Active, active, PF_ANY)
268__PAGEFLAG(Slab, slab, PF_ANY)
269PAGEFLAG(Checked, checked, PF_ANY) /* Used by some filesystems */
270PAGEFLAG(Pinned, pinned, PF_ANY) TESTSCFLAG(Pinned, pinned, PF_ANY) /* Xen */
271PAGEFLAG(SavePinned, savepinned, PF_ANY); /* Xen */
272PAGEFLAG(Foreign, foreign, PF_ANY); /* Xen */
273PAGEFLAG(Reserved, reserved, PF_ANY) __CLEARPAGEFLAG(Reserved, reserved, PF_ANY)
274PAGEFLAG(SwapBacked, swapbacked, PF_ANY)
275 __CLEARPAGEFLAG(SwapBacked, swapbacked, PF_ANY)
276 __SETPAGEFLAG(SwapBacked, swapbacked, PF_ANY)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700277
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800278__PAGEFLAG(SlobFree, slob_free, PF_ANY)
Andy Whitcroft9023cb72008-07-23 21:27:19 -0700279
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700280/*
David Howells266cf652009-04-03 16:42:36 +0100281 * Private page markings that may be used by the filesystem that owns the page
282 * for its own purposes.
283 * - PG_private and PG_private_2 cause releasepage() and co to be invoked
284 */
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800285PAGEFLAG(Private, private, PF_ANY) __SETPAGEFLAG(Private, private, PF_ANY)
286 __CLEARPAGEFLAG(Private, private, PF_ANY)
287PAGEFLAG(Private2, private_2, PF_ANY) TESTSCFLAG(Private2, private_2, PF_ANY)
288PAGEFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
289 TESTCLEARFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
David Howells266cf652009-04-03 16:42:36 +0100290
291/*
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700292 * Only test-and-set exist for PG_writeback. The unconditional operators are
293 * risky: they bypass page accounting.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 */
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800295TESTPAGEFLAG(Writeback, writeback, PF_ANY) TESTSCFLAG(Writeback, writeback, PF_ANY)
296PAGEFLAG(MappedToDisk, mappedtodisk, PF_ANY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Shaohua Li579f8292014-02-06 12:04:21 -0800298/* PG_readahead is only used for reads; PG_reclaim is only for writes */
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800299PAGEFLAG(Reclaim, reclaim, PF_ANY) TESTCLEARFLAG(Reclaim, reclaim, PF_ANY)
300PAGEFLAG(Readahead, reclaim, PF_ANY) TESTCLEARFLAG(Readahead, reclaim, PF_ANY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700302#ifdef CONFIG_HIGHMEM
303/*
304 * Must use a macro here due to header dependency issues. page_zone() is not
305 * available at this point.
306 */
Vineet Gupta3ca65c12015-11-05 18:48:29 -0800307#define PageHighMem(__p) is_highmem_idx(page_zonenum(__p))
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700308#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700309PAGEFLAG_FALSE(HighMem)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700310#endif
311
312#ifdef CONFIG_SWAP
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800313PAGEFLAG(SwapCache, swapcache, PF_ANY)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700314#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700315PAGEFLAG_FALSE(SwapCache)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700316#endif
317
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800318PAGEFLAG(Unevictable, unevictable, PF_ANY)
319 __CLEARPAGEFLAG(Unevictable, unevictable, PF_ANY)
320 TESTCLEARFLAG(Unevictable, unevictable, PF_ANY)
Lee Schermerhorn894bc312008-10-18 20:26:39 -0700321
Hugh Dickinsaf8e3352009-12-14 17:58:59 -0800322#ifdef CONFIG_MMU
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800323PAGEFLAG(Mlocked, mlocked, PF_ANY) __CLEARPAGEFLAG(Mlocked, mlocked, PF_ANY)
324 TESTSCFLAG(Mlocked, mlocked, PF_ANY) __TESTCLEARFLAG(Mlocked, mlocked, PF_ANY)
David Howells33925b22009-03-31 15:23:26 -0700325#else
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700326PAGEFLAG_FALSE(Mlocked) __CLEARPAGEFLAG_NOOP(Mlocked)
327 TESTSCFLAG_FALSE(Mlocked) __TESTCLEARFLAG_FALSE(Mlocked)
David Howells33925b22009-03-31 15:23:26 -0700328#endif
329
Venkatesh Pallipadi46cf98c2009-07-10 09:57:37 -0700330#ifdef CONFIG_ARCH_USES_PG_UNCACHED
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800331PAGEFLAG(Uncached, uncached, PF_ANY)
Christoph Lameter602c4d12008-04-28 02:12:52 -0700332#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700333PAGEFLAG_FALSE(Uncached)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700334#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
Andi Kleend466f2f2009-09-16 11:50:03 +0200336#ifdef CONFIG_MEMORY_FAILURE
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800337PAGEFLAG(HWPoison, hwpoison, PF_ANY)
338TESTSCFLAG(HWPoison, hwpoison, PF_ANY)
Andi Kleend466f2f2009-09-16 11:50:03 +0200339#define __PG_HWPOISON (1UL << PG_hwpoison)
340#else
341PAGEFLAG_FALSE(HWPoison)
342#define __PG_HWPOISON 0
343#endif
344
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700345#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800346TESTPAGEFLAG(Young, young, PF_ANY)
347SETPAGEFLAG(Young, young, PF_ANY)
348TESTCLEARFLAG(Young, young, PF_ANY)
349PAGEFLAG(Idle, idle, PF_ANY)
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700350#endif
351
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700352/*
353 * On an anonymous page mapped into a user virtual memory area,
354 * page->mapping points to its anon_vma, not to a struct address_space;
355 * with the PAGE_MAPPING_ANON bit set to distinguish it. See rmap.h.
356 *
357 * On an anonymous page in a VM_MERGEABLE area, if CONFIG_KSM is enabled,
358 * the PAGE_MAPPING_KSM bit may be set along with the PAGE_MAPPING_ANON bit;
359 * and then page->mapping points, not to an anon_vma, but to a private
360 * structure which KSM associates with that merged page. See ksm.h.
361 *
362 * PAGE_MAPPING_KSM without PAGE_MAPPING_ANON is currently never used.
363 *
364 * Please note that, confusingly, "page_mapping" refers to the inode
365 * address_space which maps the page from disk; whereas "page_mapped"
366 * refers to user virtual address space into which the page is mapped.
367 */
368#define PAGE_MAPPING_ANON 1
369#define PAGE_MAPPING_KSM 2
370#define PAGE_MAPPING_FLAGS (PAGE_MAPPING_ANON | PAGE_MAPPING_KSM)
371
372static inline int PageAnon(struct page *page)
373{
374 return ((unsigned long)page->mapping & PAGE_MAPPING_ANON) != 0;
375}
376
377#ifdef CONFIG_KSM
378/*
379 * A KSM page is one of those write-protected "shared pages" or "merged pages"
380 * which KSM maps into multiple mms, wherever identical anonymous page content
381 * is found in VM_MERGEABLE vmas. It's a PageAnon page, pointing not to any
382 * anon_vma, but to that page's node of the stable tree.
383 */
384static inline int PageKsm(struct page *page)
385{
386 return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) ==
387 (PAGE_MAPPING_ANON | PAGE_MAPPING_KSM);
388}
389#else
390TESTPAGEFLAG_FALSE(Ksm)
391#endif
392
Wu Fengguang1a9b5b72009-12-16 12:19:59 +0100393u64 stable_page_flags(struct page *page);
394
Nick Piggin0ed361d2008-02-04 22:29:34 -0800395static inline int PageUptodate(struct page *page)
396{
397 int ret = test_bit(PG_uptodate, &(page)->flags);
398
399 /*
400 * Must ensure that the data we read out of the page is loaded
401 * _after_ we've loaded page->flags to check for PageUptodate.
402 * We can skip the barrier if the page is not uptodate, because
403 * we wouldn't be reading anything from it.
404 *
405 * See SetPageUptodate() for the other side of the story.
406 */
407 if (ret)
408 smp_rmb();
409
410 return ret;
411}
412
413static inline void __SetPageUptodate(struct page *page)
414{
415 smp_wmb();
416 __set_bit(PG_uptodate, &(page)->flags);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800417}
418
Heiko Carstens2dcea572006-09-29 01:58:41 -0700419static inline void SetPageUptodate(struct page *page)
420{
Nick Piggin0ed361d2008-02-04 22:29:34 -0800421 /*
422 * Memory barrier must be issued before setting the PG_uptodate bit,
423 * so that all previous stores issued in order to bring the page
424 * uptodate are actually visible before PageUptodate becomes true.
Nick Piggin0ed361d2008-02-04 22:29:34 -0800425 */
426 smp_wmb();
427 set_bit(PG_uptodate, &(page)->flags);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800428}
429
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800430CLEARPAGEFLAG(Uptodate, uptodate, PF_ANY)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432int test_clear_page_writeback(struct page *page);
Namjae Jeon1c8349a2014-05-12 08:12:25 -0400433int __test_set_page_writeback(struct page *page, bool keep_write);
434
435#define test_set_page_writeback(page) \
436 __test_set_page_writeback(page, false)
437#define test_set_page_writeback_keepwrite(page) \
438 __test_set_page_writeback(page, true)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440static inline void set_page_writeback(struct page *page)
441{
442 test_set_page_writeback(page);
443}
444
Namjae Jeon1c8349a2014-05-12 08:12:25 -0400445static inline void set_page_writeback_keepwrite(struct page *page)
446{
447 test_set_page_writeback_keepwrite(page);
448}
449
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800450__PAGEFLAG(Head, head, PF_ANY) CLEARPAGEFLAG(Head, head, PF_ANY)
Kirill A. Shutemov1d798ca2015-11-06 16:29:54 -0800451
Kirill A. Shutemov1d798ca2015-11-06 16:29:54 -0800452static inline void set_compound_head(struct page *page, struct page *head)
453{
454 WRITE_ONCE(page->compound_head, (unsigned long)head + 1);
455}
456
457static inline void clear_compound_head(struct page *page)
458{
459 WRITE_ONCE(page->compound_head, 0);
460}
461
Andrea Arcangeli4e6af672011-01-13 15:46:44 -0800462#ifdef CONFIG_TRANSPARENT_HUGEPAGE
463static inline void ClearPageCompound(struct page *page)
464{
465 BUG_ON(!PageHead(page));
466 ClearPageHead(page);
467}
468#endif
Petr Tesarikb3acc562014-06-23 13:22:03 -0700469
470#define PG_head_mask ((1L << PG_head))
471
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700472#ifdef CONFIG_HUGETLB_PAGE
473int PageHuge(struct page *page);
474int PageHeadHuge(struct page *page);
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700475bool page_huge_active(struct page *page);
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700476#else
477TESTPAGEFLAG_FALSE(Huge)
478TESTPAGEFLAG_FALSE(HeadHuge)
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700479
480static inline bool page_huge_active(struct page *page)
481{
482 return 0;
483}
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700484#endif
485
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700486
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800487#ifdef CONFIG_TRANSPARENT_HUGEPAGE
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800488/*
489 * PageHuge() only returns true for hugetlbfs pages, but not for
490 * normal or transparent huge pages.
491 *
492 * PageTransHuge() returns true for both transparent huge and
493 * hugetlbfs pages, but not normal pages. PageTransHuge() can only be
494 * called only in the core VM paths where hugetlbfs pages can't exist.
495 */
496static inline int PageTransHuge(struct page *page)
497{
Sasha Levin309381fea2014-01-23 15:52:54 -0800498 VM_BUG_ON_PAGE(PageTail(page), page);
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800499 return PageHead(page);
500}
501
Dean Nelson385de352012-03-21 16:34:05 -0700502/*
503 * PageTransCompound returns true for both transparent huge pages
504 * and hugetlbfs pages, so it should only be called when it's known
505 * that hugetlbfs pages aren't involved.
506 */
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800507static inline int PageTransCompound(struct page *page)
508{
509 return PageCompound(page);
510}
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800511
Dean Nelson385de352012-03-21 16:34:05 -0700512/*
513 * PageTransTail returns true for both transparent huge pages
514 * and hugetlbfs pages, so it should only be called when it's known
515 * that hugetlbfs pages aren't involved.
516 */
517static inline int PageTransTail(struct page *page)
518{
519 return PageTail(page);
520}
521
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800522#else
Kirill A. Shutemovd8c1bde2016-01-15 16:51:13 -0800523TESTPAGEFLAG_FALSE(TransHuge)
524TESTPAGEFLAG_FALSE(TransCompound)
525TESTPAGEFLAG_FALSE(TransTail)
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800526#endif
527
Mel Gorman072bb0a2012-07-31 16:43:58 -0700528/*
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700529 * PageBuddy() indicate that the page is free and in the buddy system
530 * (see mm/page_alloc.c).
531 *
532 * PAGE_BUDDY_MAPCOUNT_VALUE must be <= -2 but better not too close to
533 * -2 so that an underflow of the page_mapcount() won't be mistaken
534 * for a genuine PAGE_BUDDY_MAPCOUNT_VALUE. -128 can be created very
535 * efficiently by most CPU architectures.
536 */
537#define PAGE_BUDDY_MAPCOUNT_VALUE (-128)
538
539static inline int PageBuddy(struct page *page)
540{
541 return atomic_read(&page->_mapcount) == PAGE_BUDDY_MAPCOUNT_VALUE;
542}
543
544static inline void __SetPageBuddy(struct page *page)
545{
546 VM_BUG_ON_PAGE(atomic_read(&page->_mapcount) != -1, page);
547 atomic_set(&page->_mapcount, PAGE_BUDDY_MAPCOUNT_VALUE);
548}
549
550static inline void __ClearPageBuddy(struct page *page)
551{
552 VM_BUG_ON_PAGE(!PageBuddy(page), page);
553 atomic_set(&page->_mapcount, -1);
554}
555
556#define PAGE_BALLOON_MAPCOUNT_VALUE (-256)
557
558static inline int PageBalloon(struct page *page)
559{
560 return atomic_read(&page->_mapcount) == PAGE_BALLOON_MAPCOUNT_VALUE;
561}
562
563static inline void __SetPageBalloon(struct page *page)
564{
565 VM_BUG_ON_PAGE(atomic_read(&page->_mapcount) != -1, page);
566 atomic_set(&page->_mapcount, PAGE_BALLOON_MAPCOUNT_VALUE);
567}
568
569static inline void __ClearPageBalloon(struct page *page)
570{
571 VM_BUG_ON_PAGE(!PageBalloon(page), page);
572 atomic_set(&page->_mapcount, -1);
573}
574
575/*
Mel Gorman072bb0a2012-07-31 16:43:58 -0700576 * If network-based swap is enabled, sl*b must keep track of whether pages
577 * were allocated from pfmemalloc reserves.
578 */
579static inline int PageSlabPfmemalloc(struct page *page)
580{
Sasha Levin309381fea2014-01-23 15:52:54 -0800581 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700582 return PageActive(page);
583}
584
585static inline void SetPageSlabPfmemalloc(struct page *page)
586{
Sasha Levin309381fea2014-01-23 15:52:54 -0800587 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700588 SetPageActive(page);
589}
590
591static inline void __ClearPageSlabPfmemalloc(struct page *page)
592{
Sasha Levin309381fea2014-01-23 15:52:54 -0800593 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700594 __ClearPageActive(page);
595}
596
597static inline void ClearPageSlabPfmemalloc(struct page *page)
598{
Sasha Levin309381fea2014-01-23 15:52:54 -0800599 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700600 ClearPageActive(page);
601}
602
Hugh Dickinsaf8e3352009-12-14 17:58:59 -0800603#ifdef CONFIG_MMU
David Howells33925b22009-03-31 15:23:26 -0700604#define __PG_MLOCKED (1 << PG_mlocked)
605#else
Nick Pigginb291f002008-10-18 20:26:44 -0700606#define __PG_MLOCKED 0
Lee Schermerhorn894bc312008-10-18 20:26:39 -0700607#endif
608
Andrea Arcangelie9da73d2011-01-13 15:46:32 -0800609#ifdef CONFIG_TRANSPARENT_HUGEPAGE
610#define __PG_COMPOUND_LOCK (1 << PG_compound_lock)
611#else
612#define __PG_COMPOUND_LOCK 0
613#endif
614
Russ Andersondfa7e202008-06-09 11:18:45 -0500615/*
616 * Flags checked when a page is freed. Pages being freed should not have
617 * these flags set. It they are, there is a problem.
618 */
Hugh Dickins79f4b7b2009-01-06 14:40:05 -0800619#define PAGE_FLAGS_CHECK_AT_FREE \
David Howells266cf652009-04-03 16:42:36 +0100620 (1 << PG_lru | 1 << PG_locked | \
621 1 << PG_private | 1 << PG_private_2 | \
Andrea Arcangeli5f24ce52011-01-13 15:47:00 -0800622 1 << PG_writeback | 1 << PG_reserved | \
David Howells266cf652009-04-03 16:42:36 +0100623 1 << PG_slab | 1 << PG_swapcache | 1 << PG_active | \
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700624 1 << PG_unevictable | __PG_MLOCKED | \
Andrea Arcangelie9da73d2011-01-13 15:46:32 -0800625 __PG_COMPOUND_LOCK)
Russ Andersondfa7e202008-06-09 11:18:45 -0500626
627/*
628 * Flags checked when a page is prepped for return by the page allocator.
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700629 * Pages being prepped should not have these flags set. It they are set,
Hugh Dickins79f4b7b2009-01-06 14:40:05 -0800630 * there has been a kernel bug or struct page corruption.
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700631 *
632 * __PG_HWPOISON is exceptional because it needs to be kept beyond page's
633 * alloc-free cycle to prevent from reusing the page.
Russ Andersondfa7e202008-06-09 11:18:45 -0500634 */
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700635#define PAGE_FLAGS_CHECK_AT_PREP \
636 (((1 << NR_PAGEFLAGS) - 1) & ~__PG_HWPOISON)
Russ Andersondfa7e202008-06-09 11:18:45 -0500637
Johannes Weineredcf4742009-09-21 17:02:59 -0700638#define PAGE_FLAGS_PRIVATE \
639 (1 << PG_private | 1 << PG_private_2)
David Howells266cf652009-04-03 16:42:36 +0100640/**
641 * page_has_private - Determine if page has private stuff
642 * @page: The page to be checked
643 *
644 * Determine if a page has private stuff, indicating that release routines
645 * should be invoked upon it.
646 */
Johannes Weineredcf4742009-09-21 17:02:59 -0700647static inline int page_has_private(struct page *page)
648{
649 return !!(page->flags & PAGE_FLAGS_PRIVATE);
650}
651
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800652#undef PF_ANY
653#undef PF_HEAD
654#undef PF_NO_TAIL
655#undef PF_NO_COMPOUND
Johannes Weineredcf4742009-09-21 17:02:59 -0700656#endif /* !__GENERATING_BOUNDS_H */
David Howells266cf652009-04-03 16:42:36 +0100657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658#endif /* PAGE_FLAGS_H */