blob: e5a32445f930d71d611098fc1e5c7dc1351c166d [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
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700104#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
105 PG_young,
106 PG_idle,
107#endif
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700108 __NR_PAGEFLAGS,
109
110 /* Filesystems */
111 PG_checked = PG_owner_priv_1,
112
David Howells266cf652009-04-03 16:42:36 +0100113 /* Two page bits are conscripted by FS-Cache to maintain local caching
114 * state. These bits are set on pages belonging to the netfs's inodes
115 * when those inodes are being locally cached.
116 */
117 PG_fscache = PG_private_2, /* page backed by cache */
118
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700119 /* XEN */
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000120 /* Pinned in Xen as a read-only pagetable page. */
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700121 PG_pinned = PG_owner_priv_1,
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000122 /* Pinned as part of domain save (see xen_mm_pin_all()). */
Andy Whitcroft0cad47c2008-07-23 21:27:16 -0700123 PG_savepinned = PG_dirty,
Jennifer Herbertd8ac3dd2015-01-05 13:24:09 +0000124 /* Has a grant mapping of another (foreign) domain's page. */
125 PG_foreign = PG_owner_priv_1,
Andy Whitcroft8a380822008-07-23 21:27:18 -0700126
Andy Whitcroft9023cb72008-07-23 21:27:19 -0700127 /* SLOB */
Andy Whitcroft9023cb72008-07-23 21:27:19 -0700128 PG_slob_free = PG_private,
Kirill A. Shutemov53f92632016-01-15 16:53:42 -0800129
130 /* Compound pages. Stored in first tail page's flags */
131 PG_double_map = PG_private_2,
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
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700147static __always_inline int PageTail(struct page *page)
Kirill A. Shutemov0e6d31a2016-01-15 16:51:17 -0800148{
149 return READ_ONCE(page->compound_head) & 1;
150}
151
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700152static __always_inline int PageCompound(struct page *page)
Kirill A. Shutemov0e6d31a2016-01-15 16:51:17 -0800153{
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);})
Kirill A. Shutemov822cdd112016-01-15 16:52:03 -0800179#define PF_NO_COMPOUND(page, enforce) ({ \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800180 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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700187static __always_inline int Page##uname(struct page *page) \
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800188 { 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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700191static __always_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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700195static __always_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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700199static __always_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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700203static __always_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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700207static __always_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) \
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700211static __always_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 PAGEFLAG(uname, lname, policy) \
215 TESTPAGEFLAG(uname, lname, policy) \
216 SETPAGEFLAG(uname, lname, policy) \
217 CLEARPAGEFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700218
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800219#define __PAGEFLAG(uname, lname, policy) \
220 TESTPAGEFLAG(uname, lname, policy) \
221 __SETPAGEFLAG(uname, lname, policy) \
222 __CLEARPAGEFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700223
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800224#define TESTSCFLAG(uname, lname, policy) \
225 TESTSETFLAG(uname, lname, policy) \
226 TESTCLEARFLAG(uname, lname, policy)
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700227
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700228#define TESTPAGEFLAG_FALSE(uname) \
229static inline int Page##uname(const struct page *page) { return 0; }
230
Lee Schermerhorn8a7a8542008-10-18 20:26:37 -0700231#define SETPAGEFLAG_NOOP(uname) \
232static inline void SetPage##uname(struct page *page) { }
233
234#define CLEARPAGEFLAG_NOOP(uname) \
235static inline void ClearPage##uname(struct page *page) { }
236
237#define __CLEARPAGEFLAG_NOOP(uname) \
238static inline void __ClearPage##uname(struct page *page) { }
239
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700240#define TESTSETFLAG_FALSE(uname) \
241static inline int TestSetPage##uname(struct page *page) { return 0; }
242
Lee Schermerhorn8a7a8542008-10-18 20:26:37 -0700243#define TESTCLEARFLAG_FALSE(uname) \
244static inline int TestClearPage##uname(struct page *page) { return 0; }
245
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700246#define PAGEFLAG_FALSE(uname) TESTPAGEFLAG_FALSE(uname) \
247 SETPAGEFLAG_NOOP(uname) CLEARPAGEFLAG_NOOP(uname)
248
249#define TESTSCFLAG_FALSE(uname) \
250 TESTSETFLAG_FALSE(uname) TESTCLEARFLAG_FALSE(uname)
251
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800252__PAGEFLAG(Locked, locked, PF_NO_TAIL)
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800253PAGEFLAG(Error, error, PF_NO_COMPOUND) TESTCLEARFLAG(Error, error, PF_NO_COMPOUND)
Kirill A. Shutemov8cb38fa2016-01-15 16:51:32 -0800254PAGEFLAG(Referenced, referenced, PF_HEAD)
255 TESTCLEARFLAG(Referenced, referenced, PF_HEAD)
256 __SETPAGEFLAG(Referenced, referenced, PF_HEAD)
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800257PAGEFLAG(Dirty, dirty, PF_HEAD) TESTSCFLAG(Dirty, dirty, PF_HEAD)
258 __CLEARPAGEFLAG(Dirty, dirty, PF_HEAD)
Kirill A. Shutemov8cb38fa2016-01-15 16:51:32 -0800259PAGEFLAG(LRU, lru, PF_HEAD) __CLEARPAGEFLAG(LRU, lru, PF_HEAD)
260PAGEFLAG(Active, active, PF_HEAD) __CLEARPAGEFLAG(Active, active, PF_HEAD)
261 TESTCLEARFLAG(Active, active, PF_HEAD)
Kirill A. Shutemovdcb351c2016-01-15 16:51:35 -0800262__PAGEFLAG(Slab, slab, PF_NO_TAIL)
263__PAGEFLAG(SlobFree, slob_free, PF_NO_TAIL)
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800264PAGEFLAG(Checked, checked, PF_NO_COMPOUND) /* Used by some filesystems */
Kirill A. Shutemovc13985f2016-01-15 16:51:39 -0800265
266/* Xen */
267PAGEFLAG(Pinned, pinned, PF_NO_COMPOUND)
268 TESTSCFLAG(Pinned, pinned, PF_NO_COMPOUND)
269PAGEFLAG(SavePinned, savepinned, PF_NO_COMPOUND);
270PAGEFLAG(Foreign, foreign, PF_NO_COMPOUND);
271
Kirill A. Shutemovde09d312016-01-15 16:51:42 -0800272PAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
273 __CLEARPAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
Kirill A. Shutemovda5efc42016-01-15 16:51:46 -0800274PAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
275 __CLEARPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
276 __SETPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700277
Christoph Lameterf94a62e2008-04-28 02:12:49 -0700278/*
David Howells266cf652009-04-03 16:42:36 +0100279 * Private page markings that may be used by the filesystem that owns the page
280 * for its own purposes.
281 * - PG_private and PG_private_2 cause releasepage() and co to be invoked
282 */
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800283PAGEFLAG(Private, private, PF_ANY) __SETPAGEFLAG(Private, private, PF_ANY)
284 __CLEARPAGEFLAG(Private, private, PF_ANY)
285PAGEFLAG(Private2, private_2, PF_ANY) TESTSCFLAG(Private2, private_2, PF_ANY)
286PAGEFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
287 TESTCLEARFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
David Howells266cf652009-04-03 16:42:36 +0100288
289/*
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700290 * Only test-and-set exist for PG_writeback. The unconditional operators are
291 * risky: they bypass page accounting.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 */
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800293TESTPAGEFLAG(Writeback, writeback, PF_NO_COMPOUND)
294 TESTSCFLAG(Writeback, writeback, PF_NO_COMPOUND)
295PAGEFLAG(MappedToDisk, mappedtodisk, PF_NO_COMPOUND)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Shaohua Li579f8292014-02-06 12:04:21 -0800297/* PG_readahead is only used for reads; PG_reclaim is only for writes */
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800298PAGEFLAG(Reclaim, reclaim, PF_NO_COMPOUND)
299 TESTCLEARFLAG(Reclaim, reclaim, PF_NO_COMPOUND)
300PAGEFLAG(Readahead, reclaim, PF_NO_COMPOUND)
301 TESTCLEARFLAG(Readahead, reclaim, PF_NO_COMPOUND)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700303#ifdef CONFIG_HIGHMEM
304/*
305 * Must use a macro here due to header dependency issues. page_zone() is not
306 * available at this point.
307 */
Vineet Gupta3ca65c12015-11-05 18:48:29 -0800308#define PageHighMem(__p) is_highmem_idx(page_zonenum(__p))
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700309#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700310PAGEFLAG_FALSE(HighMem)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700311#endif
312
313#ifdef CONFIG_SWAP
Kirill A. Shutemov50ea78d2016-01-15 16:51:49 -0800314PAGEFLAG(SwapCache, swapcache, PF_NO_COMPOUND)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700315#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700316PAGEFLAG_FALSE(SwapCache)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700317#endif
318
Kirill A. Shutemov8cb38fa2016-01-15 16:51:32 -0800319PAGEFLAG(Unevictable, unevictable, PF_HEAD)
320 __CLEARPAGEFLAG(Unevictable, unevictable, PF_HEAD)
321 TESTCLEARFLAG(Unevictable, unevictable, PF_HEAD)
Lee Schermerhorn894bc312008-10-18 20:26:39 -0700322
Hugh Dickinsaf8e3352009-12-14 17:58:59 -0800323#ifdef CONFIG_MMU
Kirill A. Shutemove4f87d52016-01-15 16:51:53 -0800324PAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
325 __CLEARPAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
326 TESTSCFLAG(Mlocked, mlocked, PF_NO_TAIL)
David Howells33925b22009-03-31 15:23:26 -0700327#else
Johannes Weiner2f3e4422014-08-06 16:05:40 -0700328PAGEFLAG_FALSE(Mlocked) __CLEARPAGEFLAG_NOOP(Mlocked)
Kirill A. Shutemov685eaad2016-01-15 16:52:10 -0800329 TESTSCFLAG_FALSE(Mlocked)
David Howells33925b22009-03-31 15:23:26 -0700330#endif
331
Venkatesh Pallipadi46cf98c2009-07-10 09:57:37 -0700332#ifdef CONFIG_ARCH_USES_PG_UNCACHED
Kirill A. Shutemovb9d41812016-01-15 16:51:56 -0800333PAGEFLAG(Uncached, uncached, PF_NO_COMPOUND)
Christoph Lameter602c4d12008-04-28 02:12:52 -0700334#else
Christoph Lameterec7cade2008-04-28 02:12:53 -0700335PAGEFLAG_FALSE(Uncached)
Christoph Lameter6a1e7f72008-04-28 02:12:50 -0700336#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
Andi Kleend466f2f2009-09-16 11:50:03 +0200338#ifdef CONFIG_MEMORY_FAILURE
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800339PAGEFLAG(HWPoison, hwpoison, PF_ANY)
340TESTSCFLAG(HWPoison, hwpoison, PF_ANY)
Andi Kleend466f2f2009-09-16 11:50:03 +0200341#define __PG_HWPOISON (1UL << PG_hwpoison)
342#else
343PAGEFLAG_FALSE(HWPoison)
344#define __PG_HWPOISON 0
345#endif
346
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700347#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800348TESTPAGEFLAG(Young, young, PF_ANY)
349SETPAGEFLAG(Young, young, PF_ANY)
350TESTCLEARFLAG(Young, young, PF_ANY)
351PAGEFLAG(Idle, idle, PF_ANY)
Vladimir Davydov33c3fc72015-09-09 15:35:45 -0700352#endif
353
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700354/*
355 * On an anonymous page mapped into a user virtual memory area,
356 * page->mapping points to its anon_vma, not to a struct address_space;
357 * with the PAGE_MAPPING_ANON bit set to distinguish it. See rmap.h.
358 *
359 * On an anonymous page in a VM_MERGEABLE area, if CONFIG_KSM is enabled,
360 * the PAGE_MAPPING_KSM bit may be set along with the PAGE_MAPPING_ANON bit;
361 * and then page->mapping points, not to an anon_vma, but to a private
362 * structure which KSM associates with that merged page. See ksm.h.
363 *
364 * PAGE_MAPPING_KSM without PAGE_MAPPING_ANON is currently never used.
365 *
366 * Please note that, confusingly, "page_mapping" refers to the inode
367 * address_space which maps the page from disk; whereas "page_mapped"
368 * refers to user virtual address space into which the page is mapped.
369 */
370#define PAGE_MAPPING_ANON 1
371#define PAGE_MAPPING_KSM 2
372#define PAGE_MAPPING_FLAGS (PAGE_MAPPING_ANON | PAGE_MAPPING_KSM)
373
Mel Gorman17514572016-05-19 17:13:21 -0700374static __always_inline int PageAnonHead(struct page *page)
375{
376 return ((unsigned long)page->mapping & PAGE_MAPPING_ANON) != 0;
377}
378
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700379static __always_inline int PageAnon(struct page *page)
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700380{
Kirill A. Shutemov822cdd112016-01-15 16:52:03 -0800381 page = compound_head(page);
Mel Gorman17514572016-05-19 17:13:21 -0700382 return PageAnonHead(page);
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700383}
384
385#ifdef CONFIG_KSM
386/*
387 * A KSM page is one of those write-protected "shared pages" or "merged pages"
388 * which KSM maps into multiple mms, wherever identical anonymous page content
389 * is found in VM_MERGEABLE vmas. It's a PageAnon page, pointing not to any
390 * anon_vma, but to that page's node of the stable tree.
391 */
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700392static __always_inline int PageKsm(struct page *page)
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700393{
Kirill A. Shutemov822cdd112016-01-15 16:52:03 -0800394 page = compound_head(page);
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700395 return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) ==
396 (PAGE_MAPPING_ANON | PAGE_MAPPING_KSM);
397}
398#else
399TESTPAGEFLAG_FALSE(Ksm)
400#endif
401
Wu Fengguang1a9b5b72009-12-16 12:19:59 +0100402u64 stable_page_flags(struct page *page);
403
Nick Piggin0ed361d2008-02-04 22:29:34 -0800404static inline int PageUptodate(struct page *page)
405{
Kirill A. Shutemovd2998c42016-01-15 16:52:00 -0800406 int ret;
407 page = compound_head(page);
408 ret = test_bit(PG_uptodate, &(page)->flags);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800409 /*
410 * Must ensure that the data we read out of the page is loaded
411 * _after_ we've loaded page->flags to check for PageUptodate.
412 * We can skip the barrier if the page is not uptodate, because
413 * we wouldn't be reading anything from it.
414 *
415 * See SetPageUptodate() for the other side of the story.
416 */
417 if (ret)
418 smp_rmb();
419
420 return ret;
421}
422
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700423static __always_inline void __SetPageUptodate(struct page *page)
Nick Piggin0ed361d2008-02-04 22:29:34 -0800424{
Kirill A. Shutemovd2998c42016-01-15 16:52:00 -0800425 VM_BUG_ON_PAGE(PageTail(page), page);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800426 smp_wmb();
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800427 __set_bit(PG_uptodate, &page->flags);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800428}
429
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700430static __always_inline void SetPageUptodate(struct page *page)
Heiko Carstens2dcea572006-09-29 01:58:41 -0700431{
Kirill A. Shutemovd2998c42016-01-15 16:52:00 -0800432 VM_BUG_ON_PAGE(PageTail(page), page);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800433 /*
434 * Memory barrier must be issued before setting the PG_uptodate bit,
435 * so that all previous stores issued in order to bring the page
436 * uptodate are actually visible before PageUptodate becomes true.
Nick Piggin0ed361d2008-02-04 22:29:34 -0800437 */
438 smp_wmb();
Kirill A. Shutemovdf8c94d2016-01-15 16:51:28 -0800439 set_bit(PG_uptodate, &page->flags);
Nick Piggin0ed361d2008-02-04 22:29:34 -0800440}
441
Kirill A. Shutemovd2998c42016-01-15 16:52:00 -0800442CLEARPAGEFLAG(Uptodate, uptodate, PF_NO_TAIL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444int test_clear_page_writeback(struct page *page);
Namjae Jeon1c8349a2014-05-12 08:12:25 -0400445int __test_set_page_writeback(struct page *page, bool keep_write);
446
447#define test_set_page_writeback(page) \
448 __test_set_page_writeback(page, false)
449#define test_set_page_writeback_keepwrite(page) \
450 __test_set_page_writeback(page, true)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452static inline void set_page_writeback(struct page *page)
453{
454 test_set_page_writeback(page);
455}
456
Namjae Jeon1c8349a2014-05-12 08:12:25 -0400457static inline void set_page_writeback_keepwrite(struct page *page)
458{
459 test_set_page_writeback_keepwrite(page);
460}
461
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800462__PAGEFLAG(Head, head, PF_ANY) CLEARPAGEFLAG(Head, head, PF_ANY)
Kirill A. Shutemov1d798ca2015-11-06 16:29:54 -0800463
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700464static __always_inline void set_compound_head(struct page *page, struct page *head)
Kirill A. Shutemov1d798ca2015-11-06 16:29:54 -0800465{
466 WRITE_ONCE(page->compound_head, (unsigned long)head + 1);
467}
468
Denys Vlasenko4b0f3262016-03-17 14:18:24 -0700469static __always_inline void clear_compound_head(struct page *page)
Kirill A. Shutemov1d798ca2015-11-06 16:29:54 -0800470{
471 WRITE_ONCE(page->compound_head, 0);
472}
473
Andrea Arcangeli4e6af672011-01-13 15:46:44 -0800474#ifdef CONFIG_TRANSPARENT_HUGEPAGE
475static inline void ClearPageCompound(struct page *page)
476{
477 BUG_ON(!PageHead(page));
478 ClearPageHead(page);
479}
480#endif
Petr Tesarikb3acc562014-06-23 13:22:03 -0700481
Yu Zhaod2a1a1f2016-05-20 16:58:16 -0700482#define PG_head_mask ((1UL << PG_head))
Petr Tesarikb3acc562014-06-23 13:22:03 -0700483
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700484#ifdef CONFIG_HUGETLB_PAGE
485int PageHuge(struct page *page);
486int PageHeadHuge(struct page *page);
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700487bool page_huge_active(struct page *page);
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700488#else
489TESTPAGEFLAG_FALSE(Huge)
490TESTPAGEFLAG_FALSE(HeadHuge)
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700491
492static inline bool page_huge_active(struct page *page)
493{
494 return 0;
495}
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700496#endif
497
Naoya Horiguchi7e1f0492015-04-15 16:14:41 -0700498
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800499#ifdef CONFIG_TRANSPARENT_HUGEPAGE
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800500/*
501 * PageHuge() only returns true for hugetlbfs pages, but not for
502 * normal or transparent huge pages.
503 *
504 * PageTransHuge() returns true for both transparent huge and
505 * hugetlbfs pages, but not normal pages. PageTransHuge() can only be
506 * called only in the core VM paths where hugetlbfs pages can't exist.
507 */
508static inline int PageTransHuge(struct page *page)
509{
Sasha Levin309381fea2014-01-23 15:52:54 -0800510 VM_BUG_ON_PAGE(PageTail(page), page);
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800511 return PageHead(page);
512}
513
Dean Nelson385de352012-03-21 16:34:05 -0700514/*
515 * PageTransCompound returns true for both transparent huge pages
516 * and hugetlbfs pages, so it should only be called when it's known
517 * that hugetlbfs pages aren't involved.
518 */
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800519static inline int PageTransCompound(struct page *page)
520{
521 return PageCompound(page);
522}
Andrea Arcangeli71e3aac2011-01-13 15:46:52 -0800523
Dean Nelson385de352012-03-21 16:34:05 -0700524/*
Andrea Arcangeli127393f2016-05-05 16:22:20 -0700525 * PageTransCompoundMap is the same as PageTransCompound, but it also
526 * guarantees the primary MMU has the entire compound page mapped
527 * through pmd_trans_huge, which in turn guarantees the secondary MMUs
528 * can also map the entire compound page. This allows the secondary
529 * MMUs to call get_user_pages() only once for each compound page and
530 * to immediately map the entire compound page with a single secondary
531 * MMU fault. If there will be a pmd split later, the secondary MMUs
532 * will get an update through the MMU notifier invalidation through
533 * split_huge_pmd().
534 *
535 * Unlike PageTransCompound, this is safe to be called only while
536 * split_huge_pmd() cannot run from under us, like if protected by the
537 * MMU notifier, otherwise it may result in page->_mapcount < 0 false
538 * positives.
539 */
540static inline int PageTransCompoundMap(struct page *page)
541{
542 return PageTransCompound(page) && atomic_read(&page->_mapcount) < 0;
543}
544
545/*
Dean Nelson385de352012-03-21 16:34:05 -0700546 * PageTransTail returns true for both transparent huge pages
547 * and hugetlbfs pages, so it should only be called when it's known
548 * that hugetlbfs pages aren't involved.
549 */
550static inline int PageTransTail(struct page *page)
551{
552 return PageTail(page);
553}
554
Kirill A. Shutemov53f92632016-01-15 16:53:42 -0800555/*
556 * PageDoubleMap indicates that the compound page is mapped with PTEs as well
557 * as PMDs.
558 *
559 * This is required for optimization of rmap operations for THP: we can postpone
560 * per small page mapcount accounting (and its overhead from atomic operations)
561 * until the first PMD split.
562 *
563 * For the page PageDoubleMap means ->_mapcount in all sub-pages is offset up
564 * by one. This reference will go away with last compound_mapcount.
565 *
566 * See also __split_huge_pmd_locked() and page_remove_anon_compound_rmap().
567 */
568static inline int PageDoubleMap(struct page *page)
569{
570 return PageHead(page) && test_bit(PG_double_map, &page[1].flags);
571}
572
573static inline int TestSetPageDoubleMap(struct page *page)
574{
575 VM_BUG_ON_PAGE(!PageHead(page), page);
576 return test_and_set_bit(PG_double_map, &page[1].flags);
577}
578
579static inline int TestClearPageDoubleMap(struct page *page)
580{
581 VM_BUG_ON_PAGE(!PageHead(page), page);
582 return test_and_clear_bit(PG_double_map, &page[1].flags);
583}
584
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800585#else
Kirill A. Shutemovd8c1bde2016-01-15 16:51:13 -0800586TESTPAGEFLAG_FALSE(TransHuge)
587TESTPAGEFLAG_FALSE(TransCompound)
Andrea Arcangeli127393f2016-05-05 16:22:20 -0700588TESTPAGEFLAG_FALSE(TransCompoundMap)
Kirill A. Shutemovd8c1bde2016-01-15 16:51:13 -0800589TESTPAGEFLAG_FALSE(TransTail)
Kirill A. Shutemov53f92632016-01-15 16:53:42 -0800590TESTPAGEFLAG_FALSE(DoubleMap)
591 TESTSETFLAG_FALSE(DoubleMap)
592 TESTCLEARFLAG_FALSE(DoubleMap)
Andrea Arcangeli936a5fe2011-01-13 15:46:48 -0800593#endif
594
Mel Gorman072bb0a2012-07-31 16:43:58 -0700595/*
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700596 * PageBuddy() indicate that the page is free and in the buddy system
597 * (see mm/page_alloc.c).
598 *
599 * PAGE_BUDDY_MAPCOUNT_VALUE must be <= -2 but better not too close to
600 * -2 so that an underflow of the page_mapcount() won't be mistaken
601 * for a genuine PAGE_BUDDY_MAPCOUNT_VALUE. -128 can be created very
602 * efficiently by most CPU architectures.
603 */
604#define PAGE_BUDDY_MAPCOUNT_VALUE (-128)
605
606static inline int PageBuddy(struct page *page)
607{
608 return atomic_read(&page->_mapcount) == PAGE_BUDDY_MAPCOUNT_VALUE;
609}
610
611static inline void __SetPageBuddy(struct page *page)
612{
613 VM_BUG_ON_PAGE(atomic_read(&page->_mapcount) != -1, page);
614 atomic_set(&page->_mapcount, PAGE_BUDDY_MAPCOUNT_VALUE);
615}
616
617static inline void __ClearPageBuddy(struct page *page)
618{
619 VM_BUG_ON_PAGE(!PageBuddy(page), page);
620 atomic_set(&page->_mapcount, -1);
621}
622
Naoya Horiguchi832fc1d2016-03-17 14:17:41 -0700623extern bool is_free_buddy_page(struct page *page);
624
Kirill A. Shutemove8c61582015-04-15 16:13:08 -0700625#define PAGE_BALLOON_MAPCOUNT_VALUE (-256)
626
627static inline int PageBalloon(struct page *page)
628{
629 return atomic_read(&page->_mapcount) == PAGE_BALLOON_MAPCOUNT_VALUE;
630}
631
632static inline void __SetPageBalloon(struct page *page)
633{
634 VM_BUG_ON_PAGE(atomic_read(&page->_mapcount) != -1, page);
635 atomic_set(&page->_mapcount, PAGE_BALLOON_MAPCOUNT_VALUE);
636}
637
638static inline void __ClearPageBalloon(struct page *page)
639{
640 VM_BUG_ON_PAGE(!PageBalloon(page), page);
641 atomic_set(&page->_mapcount, -1);
642}
643
644/*
Mel Gorman072bb0a2012-07-31 16:43:58 -0700645 * If network-based swap is enabled, sl*b must keep track of whether pages
646 * were allocated from pfmemalloc reserves.
647 */
648static inline int PageSlabPfmemalloc(struct page *page)
649{
Sasha Levin309381fea2014-01-23 15:52:54 -0800650 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700651 return PageActive(page);
652}
653
654static inline void SetPageSlabPfmemalloc(struct page *page)
655{
Sasha Levin309381fea2014-01-23 15:52:54 -0800656 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700657 SetPageActive(page);
658}
659
660static inline void __ClearPageSlabPfmemalloc(struct page *page)
661{
Sasha Levin309381fea2014-01-23 15:52:54 -0800662 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700663 __ClearPageActive(page);
664}
665
666static inline void ClearPageSlabPfmemalloc(struct page *page)
667{
Sasha Levin309381fea2014-01-23 15:52:54 -0800668 VM_BUG_ON_PAGE(!PageSlab(page), page);
Mel Gorman072bb0a2012-07-31 16:43:58 -0700669 ClearPageActive(page);
670}
671
Hugh Dickinsaf8e3352009-12-14 17:58:59 -0800672#ifdef CONFIG_MMU
Yu Zhaod2a1a1f2016-05-20 16:58:16 -0700673#define __PG_MLOCKED (1UL << PG_mlocked)
David Howells33925b22009-03-31 15:23:26 -0700674#else
Nick Pigginb291f002008-10-18 20:26:44 -0700675#define __PG_MLOCKED 0
Lee Schermerhorn894bc312008-10-18 20:26:39 -0700676#endif
677
Russ Andersondfa7e202008-06-09 11:18:45 -0500678/*
679 * Flags checked when a page is freed. Pages being freed should not have
680 * these flags set. It they are, there is a problem.
681 */
Hugh Dickins79f4b7b2009-01-06 14:40:05 -0800682#define PAGE_FLAGS_CHECK_AT_FREE \
Yu Zhaod2a1a1f2016-05-20 16:58:16 -0700683 (1UL << PG_lru | 1UL << PG_locked | \
684 1UL << PG_private | 1UL << PG_private_2 | \
685 1UL << PG_writeback | 1UL << PG_reserved | \
686 1UL << PG_slab | 1UL << PG_swapcache | 1UL << PG_active | \
687 1UL << PG_unevictable | __PG_MLOCKED)
Russ Andersondfa7e202008-06-09 11:18:45 -0500688
689/*
690 * Flags checked when a page is prepped for return by the page allocator.
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700691 * Pages being prepped should not have these flags set. It they are set,
Hugh Dickins79f4b7b2009-01-06 14:40:05 -0800692 * there has been a kernel bug or struct page corruption.
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700693 *
694 * __PG_HWPOISON is exceptional because it needs to be kept beyond page's
695 * alloc-free cycle to prevent from reusing the page.
Russ Andersondfa7e202008-06-09 11:18:45 -0500696 */
Naoya Horiguchif4c18e62015-08-06 15:47:08 -0700697#define PAGE_FLAGS_CHECK_AT_PREP \
Yu Zhaod2a1a1f2016-05-20 16:58:16 -0700698 (((1UL << NR_PAGEFLAGS) - 1) & ~__PG_HWPOISON)
Russ Andersondfa7e202008-06-09 11:18:45 -0500699
Johannes Weineredcf4742009-09-21 17:02:59 -0700700#define PAGE_FLAGS_PRIVATE \
Yu Zhaod2a1a1f2016-05-20 16:58:16 -0700701 (1UL << PG_private | 1UL << PG_private_2)
David Howells266cf652009-04-03 16:42:36 +0100702/**
703 * page_has_private - Determine if page has private stuff
704 * @page: The page to be checked
705 *
706 * Determine if a page has private stuff, indicating that release routines
707 * should be invoked upon it.
708 */
Johannes Weineredcf4742009-09-21 17:02:59 -0700709static inline int page_has_private(struct page *page)
710{
711 return !!(page->flags & PAGE_FLAGS_PRIVATE);
712}
713
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800714#undef PF_ANY
715#undef PF_HEAD
716#undef PF_NO_TAIL
717#undef PF_NO_COMPOUND
Johannes Weineredcf4742009-09-21 17:02:59 -0700718#endif /* !__GENERATING_BOUNDS_H */
David Howells266cf652009-04-03 16:42:36 +0100719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720#endif /* PAGE_FLAGS_H */