page-flags.h 23.7 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
L
Linus Torvalds 已提交
2 3 4 5 6 7 8
/*
 * Macros for manipulating and testing page->flags
 */

#ifndef PAGE_FLAGS_H
#define PAGE_FLAGS_H

A
Andrew Morton 已提交
9
#include <linux/types.h>
10
#include <linux/bug.h>
11
#include <linux/mmdebug.h>
12
#ifndef __GENERATING_BOUNDS_H
13
#include <linux/mm_types.h>
14
#include <generated/bounds.h>
15
#endif /* !__GENERATING_BOUNDS_H */
A
Andrew Morton 已提交
16

L
Linus Torvalds 已提交
17 18 19 20
/*
 * Various page->flags bits:
 *
 * PG_reserved is set for special pages, which can never be swapped out. Some
M
Michal Hocko 已提交
21
 * of them might not even exist...
L
Linus Torvalds 已提交
22
 *
N
Nick Piggin 已提交
23 24 25
 * 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.
L
Linus Torvalds 已提交
26
 *
N
Nick Piggin 已提交
27 28 29 30 31 32 33 34 35
 * 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.
L
Linus Torvalds 已提交
36 37 38 39
 *
 * 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.
 *
N
Nick Piggin 已提交
40 41
 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
 * file-backed pagecache (see mm/vmscan.c).
L
Linus Torvalds 已提交
42 43 44 45 46 47 48
 *
 * 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.
 *
49 50 51
 * 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!
L
Linus Torvalds 已提交
52 53 54 55
 */

/*
 * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
56 57 58 59 60 61 62
 * 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 |
63 64
 *  N-1           ^       0
 *               (NR_PAGEFLAGS)
65
 *
66 67 68
 * 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).
L
Linus Torvalds 已提交
69
 */
70 71 72 73 74 75 76 77
enum pageflags {
	PG_locked,		/* Page is locked. Don't touch. */
	PG_error,
	PG_referenced,
	PG_uptodate,
	PG_dirty,
	PG_lru,
	PG_active,
78
	PG_waiters,		/* Page has waiters, check its waitqueue. Must be bit #7 and in the same byte as "PG_locked" */
79 80 81 82 83
	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 */
84
	PG_private_2,		/* If pagecache, has fs aux data */
85
	PG_writeback,		/* Page is under writeback */
86
	PG_head,		/* A head page */
87 88
	PG_mappedtodisk,	/* Has blocks allocated on-disk */
	PG_reclaim,		/* To be reclaimed asap */
R
Rik van Riel 已提交
89
	PG_swapbacked,		/* Page is backed by RAM/swap */
L
Lee Schermerhorn 已提交
90
	PG_unevictable,		/* Page is "unevictable"  */
H
Hugh Dickins 已提交
91
#ifdef CONFIG_MMU
N
Nick Piggin 已提交
92
	PG_mlocked,		/* Page is vma mlocked */
L
Lee Schermerhorn 已提交
93
#endif
94
#ifdef CONFIG_ARCH_USES_PG_UNCACHED
95
	PG_uncached,		/* Page has been mapped as uncached */
96 97 98
#endif
#ifdef CONFIG_MEMORY_FAILURE
	PG_hwpoison,		/* hardware poisoned page. Don't touch */
A
Andrea Arcangeli 已提交
99
#endif
100 101 102
#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
	PG_young,
	PG_idle,
A
Andrew Morton 已提交
103
#endif
104 105 106 107 108
	__NR_PAGEFLAGS,

	/* Filesystems */
	PG_checked = PG_owner_priv_1,

109 110 111
	/* SwapBacked */
	PG_swapcache = PG_owner_priv_1,	/* Swap page: swp_entry_t in private */

112 113 114 115 116 117
	/* 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 */

118
	/* XEN */
119
	/* Pinned in Xen as a read-only pagetable page. */
120
	PG_pinned = PG_owner_priv_1,
121
	/* Pinned as part of domain save (see xen_mm_pin_all()). */
122
	PG_savepinned = PG_dirty,
123 124
	/* Has a grant mapping of another (foreign) domain's page. */
	PG_foreign = PG_owner_priv_1,
125

126 127
	/* SLOB */
	PG_slob_free = PG_private,
128 129 130

	/* Compound pages. Stored in first tail page's flags */
	PG_double_map = PG_private_2,
131 132 133

	/* non-lru isolated movable page */
	PG_isolated = PG_reclaim,
134
};
L
Linus Torvalds 已提交
135

136 137
#ifndef __GENERATING_BOUNDS_H

138 139 140 141 142 143 144 145 146 147 148
struct page;	/* forward declaration */

static inline struct page *compound_head(struct page *page)
{
	unsigned long head = READ_ONCE(page->compound_head);

	if (unlikely(head & 1))
		return (struct page *) (head - 1);
	return page;
}

149
static __always_inline int PageTail(struct page *page)
150 151 152 153
{
	return READ_ONCE(page->compound_head) & 1;
}

154
static __always_inline int PageCompound(struct page *page)
155 156 157 158
{
	return test_bit(PG_head, &page->flags) || PageTail(page);
}

159 160 161 162 163 164
#define	PAGE_POISON_PATTERN	-1l
static inline int PagePoisoned(const struct page *page)
{
	return page->flags == PAGE_POISON_PATTERN;
}

165 166 167
/*
 * Page flags policies wrt compound pages
 *
168 169 170
 * PF_POISONED_CHECK
 *     check if this struct page poisoned/uninitialized
 *
171 172 173 174 175 176 177
 * PF_ANY:
 *     the page flag is relevant for small, head and tail pages.
 *
 * PF_HEAD:
 *     for compound page all operations related to the page flag applied to
 *     head page.
 *
178 179 180
 * PF_ONLY_HEAD:
 *     for compound page, callers only ever operate on the head page.
 *
181 182 183 184 185 186 187
 * PF_NO_TAIL:
 *     modifications of the page flag must be done on small or head pages,
 *     checks can be done on tail pages too.
 *
 * PF_NO_COMPOUND:
 *     the page flag is not relevant for compound pages.
 */
188 189 190 191 192
#define PF_POISONED_CHECK(page) ({					\
		VM_BUG_ON_PGFLAGS(PagePoisoned(page), page);		\
		page; })
#define PF_ANY(page, enforce)	PF_POISONED_CHECK(page)
#define PF_HEAD(page, enforce)	PF_POISONED_CHECK(compound_head(page))
193 194
#define PF_ONLY_HEAD(page, enforce) ({					\
		VM_BUG_ON_PGFLAGS(PageTail(page), page);		\
195
		PF_POISONED_CHECK(page); })
196 197
#define PF_NO_TAIL(page, enforce) ({					\
		VM_BUG_ON_PGFLAGS(enforce && PageTail(page), page);	\
198
		PF_POISONED_CHECK(compound_head(page)); })
199
#define PF_NO_COMPOUND(page, enforce) ({				\
200
		VM_BUG_ON_PGFLAGS(enforce && PageCompound(page), page);	\
201
		PF_POISONED_CHECK(page); })
202

203 204 205
/*
 * Macros to create function definitions for page flags
 */
206
#define TESTPAGEFLAG(uname, lname, policy)				\
207
static __always_inline int Page##uname(struct page *page)		\
208
	{ return test_bit(PG_##lname, &policy(page, 0)->flags); }
209

210
#define SETPAGEFLAG(uname, lname, policy)				\
211
static __always_inline void SetPage##uname(struct page *page)		\
212
	{ set_bit(PG_##lname, &policy(page, 1)->flags); }
213

214
#define CLEARPAGEFLAG(uname, lname, policy)				\
215
static __always_inline void ClearPage##uname(struct page *page)		\
216
	{ clear_bit(PG_##lname, &policy(page, 1)->flags); }
217

218
#define __SETPAGEFLAG(uname, lname, policy)				\
219
static __always_inline void __SetPage##uname(struct page *page)		\
220
	{ __set_bit(PG_##lname, &policy(page, 1)->flags); }
221

222
#define __CLEARPAGEFLAG(uname, lname, policy)				\
223
static __always_inline void __ClearPage##uname(struct page *page)	\
224
	{ __clear_bit(PG_##lname, &policy(page, 1)->flags); }
225

226
#define TESTSETFLAG(uname, lname, policy)				\
227
static __always_inline int TestSetPage##uname(struct page *page)	\
228
	{ return test_and_set_bit(PG_##lname, &policy(page, 1)->flags); }
229

230
#define TESTCLEARFLAG(uname, lname, policy)				\
231
static __always_inline int TestClearPage##uname(struct page *page)	\
232
	{ return test_and_clear_bit(PG_##lname, &policy(page, 1)->flags); }
233

234 235 236 237
#define PAGEFLAG(uname, lname, policy)					\
	TESTPAGEFLAG(uname, lname, policy)				\
	SETPAGEFLAG(uname, lname, policy)				\
	CLEARPAGEFLAG(uname, lname, policy)
238

239 240 241 242
#define __PAGEFLAG(uname, lname, policy)				\
	TESTPAGEFLAG(uname, lname, policy)				\
	__SETPAGEFLAG(uname, lname, policy)				\
	__CLEARPAGEFLAG(uname, lname, policy)
243

244 245 246
#define TESTSCFLAG(uname, lname, policy)				\
	TESTSETFLAG(uname, lname, policy)				\
	TESTCLEARFLAG(uname, lname, policy)
247

248 249 250
#define TESTPAGEFLAG_FALSE(uname)					\
static inline int Page##uname(const struct page *page) { return 0; }

251 252 253 254 255 256 257 258 259
#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) {  }

260 261 262
#define TESTSETFLAG_FALSE(uname)					\
static inline int TestSetPage##uname(struct page *page) { return 0; }

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

266 267 268 269 270 271
#define PAGEFLAG_FALSE(uname) TESTPAGEFLAG_FALSE(uname)			\
	SETPAGEFLAG_NOOP(uname) CLEARPAGEFLAG_NOOP(uname)

#define TESTSCFLAG_FALSE(uname)						\
	TESTSETFLAG_FALSE(uname) TESTCLEARFLAG_FALSE(uname)

272
__PAGEFLAG(Locked, locked, PF_NO_TAIL)
273
PAGEFLAG(Waiters, waiters, PF_ONLY_HEAD) __CLEARPAGEFLAG(Waiters, waiters, PF_ONLY_HEAD)
274
PAGEFLAG(Error, error, PF_NO_COMPOUND) TESTCLEARFLAG(Error, error, PF_NO_COMPOUND)
275 276 277
PAGEFLAG(Referenced, referenced, PF_HEAD)
	TESTCLEARFLAG(Referenced, referenced, PF_HEAD)
	__SETPAGEFLAG(Referenced, referenced, PF_HEAD)
278 279
PAGEFLAG(Dirty, dirty, PF_HEAD) TESTSCFLAG(Dirty, dirty, PF_HEAD)
	__CLEARPAGEFLAG(Dirty, dirty, PF_HEAD)
280 281 282
PAGEFLAG(LRU, lru, PF_HEAD) __CLEARPAGEFLAG(LRU, lru, PF_HEAD)
PAGEFLAG(Active, active, PF_HEAD) __CLEARPAGEFLAG(Active, active, PF_HEAD)
	TESTCLEARFLAG(Active, active, PF_HEAD)
283 284
__PAGEFLAG(Slab, slab, PF_NO_TAIL)
__PAGEFLAG(SlobFree, slob_free, PF_NO_TAIL)
285
PAGEFLAG(Checked, checked, PF_NO_COMPOUND)	   /* Used by some filesystems */
286 287 288 289 290 291 292

/* Xen */
PAGEFLAG(Pinned, pinned, PF_NO_COMPOUND)
	TESTSCFLAG(Pinned, pinned, PF_NO_COMPOUND)
PAGEFLAG(SavePinned, savepinned, PF_NO_COMPOUND);
PAGEFLAG(Foreign, foreign, PF_NO_COMPOUND);

293 294
PAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
	__CLEARPAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
295 296 297
PAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
	__CLEARPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
	__SETPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
298

299 300 301 302 303
/*
 * 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
 */
304 305 306 307 308
PAGEFLAG(Private, private, PF_ANY) __SETPAGEFLAG(Private, private, PF_ANY)
	__CLEARPAGEFLAG(Private, private, PF_ANY)
PAGEFLAG(Private2, private_2, PF_ANY) TESTSCFLAG(Private2, private_2, PF_ANY)
PAGEFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
	TESTCLEARFLAG(OwnerPriv1, owner_priv_1, PF_ANY)
309

310 311 312 313
/*
 * Only test-and-set exist for PG_writeback.  The unconditional operators are
 * risky: they bypass page accounting.
 */
314 315
TESTPAGEFLAG(Writeback, writeback, PF_NO_TAIL)
	TESTSCFLAG(Writeback, writeback, PF_NO_TAIL)
316
PAGEFLAG(MappedToDisk, mappedtodisk, PF_NO_TAIL)
317

318
/* PG_readahead is only used for reads; PG_reclaim is only for writes */
319 320
PAGEFLAG(Reclaim, reclaim, PF_NO_TAIL)
	TESTCLEARFLAG(Reclaim, reclaim, PF_NO_TAIL)
321 322
PAGEFLAG(Readahead, reclaim, PF_NO_COMPOUND)
	TESTCLEARFLAG(Readahead, reclaim, PF_NO_COMPOUND)
323 324

#ifdef CONFIG_HIGHMEM
L
Linus Torvalds 已提交
325
/*
326 327
 * Must use a macro here due to header dependency issues. page_zone() is not
 * available at this point.
L
Linus Torvalds 已提交
328
 */
V
Vineet Gupta 已提交
329
#define PageHighMem(__p) is_highmem_idx(page_zonenum(__p))
330
#else
331
PAGEFLAG_FALSE(HighMem)
332 333 334
#endif

#ifdef CONFIG_SWAP
335 336
static __always_inline int PageSwapCache(struct page *page)
{
337 338 339
#ifdef CONFIG_THP_SWAP
	page = compound_head(page);
#endif
340 341 342
	return PageSwapBacked(page) && test_bit(PG_swapcache, &page->flags);

}
343 344
SETPAGEFLAG(SwapCache, swapcache, PF_NO_TAIL)
CLEARPAGEFLAG(SwapCache, swapcache, PF_NO_TAIL)
345
#else
346
PAGEFLAG_FALSE(SwapCache)
347 348
#endif

349 350 351
PAGEFLAG(Unevictable, unevictable, PF_HEAD)
	__CLEARPAGEFLAG(Unevictable, unevictable, PF_HEAD)
	TESTCLEARFLAG(Unevictable, unevictable, PF_HEAD)
N
Nick Piggin 已提交
352

H
Hugh Dickins 已提交
353
#ifdef CONFIG_MMU
354 355 356
PAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
	__CLEARPAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
	TESTSCFLAG(Mlocked, mlocked, PF_NO_TAIL)
L
Lee Schermerhorn 已提交
357
#else
358
PAGEFLAG_FALSE(Mlocked) __CLEARPAGEFLAG_NOOP(Mlocked)
359
	TESTSCFLAG_FALSE(Mlocked)
L
Lee Schermerhorn 已提交
360 361
#endif

362
#ifdef CONFIG_ARCH_USES_PG_UNCACHED
363
PAGEFLAG(Uncached, uncached, PF_NO_COMPOUND)
364
#else
365
PAGEFLAG_FALSE(Uncached)
366
#endif
L
Linus Torvalds 已提交
367

368
#ifdef CONFIG_MEMORY_FAILURE
369 370
PAGEFLAG(HWPoison, hwpoison, PF_ANY)
TESTSCFLAG(HWPoison, hwpoison, PF_ANY)
371 372 373 374 375 376
#define __PG_HWPOISON (1UL << PG_hwpoison)
#else
PAGEFLAG_FALSE(HWPoison)
#define __PG_HWPOISON 0
#endif

377
#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
378 379 380 381
TESTPAGEFLAG(Young, young, PF_ANY)
SETPAGEFLAG(Young, young, PF_ANY)
TESTCLEARFLAG(Young, young, PF_ANY)
PAGEFLAG(Idle, idle, PF_ANY)
382 383
#endif

384 385 386 387 388 389
/*
 * On an anonymous page mapped into a user virtual memory area,
 * page->mapping points to its anon_vma, not to a struct address_space;
 * with the PAGE_MAPPING_ANON bit set to distinguish it.  See rmap.h.
 *
 * On an anonymous page in a VM_MERGEABLE area, if CONFIG_KSM is enabled,
390 391
 * the PAGE_MAPPING_MOVABLE bit may be set along with the PAGE_MAPPING_ANON
 * bit; and then page->mapping points, not to an anon_vma, but to a private
392 393
 * structure which KSM associates with that merged page.  See ksm.h.
 *
394 395
 * PAGE_MAPPING_KSM without PAGE_MAPPING_ANON is used for non-lru movable
 * page and then page->mapping points a struct address_space.
396 397 398 399 400
 *
 * Please note that, confusingly, "page_mapping" refers to the inode
 * address_space which maps the page from disk; whereas "page_mapped"
 * refers to user virtual address space into which the page is mapped.
 */
401 402 403 404
#define PAGE_MAPPING_ANON	0x1
#define PAGE_MAPPING_MOVABLE	0x2
#define PAGE_MAPPING_KSM	(PAGE_MAPPING_ANON | PAGE_MAPPING_MOVABLE)
#define PAGE_MAPPING_FLAGS	(PAGE_MAPPING_ANON | PAGE_MAPPING_MOVABLE)
405

406
static __always_inline int PageMappingFlags(struct page *page)
407
{
408
	return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) != 0;
409 410
}

411
static __always_inline int PageAnon(struct page *page)
412
{
413
	page = compound_head(page);
414 415 416 417 418 419 420
	return ((unsigned long)page->mapping & PAGE_MAPPING_ANON) != 0;
}

static __always_inline int __PageMovable(struct page *page)
{
	return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) ==
				PAGE_MAPPING_MOVABLE;
421 422 423 424 425 426 427 428 429
}

#ifdef CONFIG_KSM
/*
 * A KSM page is one of those write-protected "shared pages" or "merged pages"
 * which KSM maps into multiple mms, wherever identical anonymous page content
 * is found in VM_MERGEABLE vmas.  It's a PageAnon page, pointing not to any
 * anon_vma, but to that page's node of the stable tree.
 */
430
static __always_inline int PageKsm(struct page *page)
431
{
432
	page = compound_head(page);
433
	return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) ==
434
				PAGE_MAPPING_KSM;
435 436 437 438 439
}
#else
TESTPAGEFLAG_FALSE(Ksm)
#endif

W
Wu Fengguang 已提交
440 441
u64 stable_page_flags(struct page *page);

N
Nick Piggin 已提交
442 443
static inline int PageUptodate(struct page *page)
{
444 445 446
	int ret;
	page = compound_head(page);
	ret = test_bit(PG_uptodate, &(page)->flags);
N
Nick Piggin 已提交
447 448 449 450 451 452 453 454 455 456 457 458 459 460
	/*
	 * 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;
}

461
static __always_inline void __SetPageUptodate(struct page *page)
N
Nick Piggin 已提交
462
{
463
	VM_BUG_ON_PAGE(PageTail(page), page);
N
Nick Piggin 已提交
464
	smp_wmb();
465
	__set_bit(PG_uptodate, &page->flags);
N
Nick Piggin 已提交
466 467
}

468
static __always_inline void SetPageUptodate(struct page *page)
469
{
470
	VM_BUG_ON_PAGE(PageTail(page), page);
N
Nick Piggin 已提交
471 472 473 474 475 476
	/*
	 * 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.
	 */
	smp_wmb();
477
	set_bit(PG_uptodate, &page->flags);
N
Nick Piggin 已提交
478 479
}

480
CLEARPAGEFLAG(Uptodate, uptodate, PF_NO_TAIL)
L
Linus Torvalds 已提交
481

482
int test_clear_page_writeback(struct page *page);
483 484 485 486 487 488
int __test_set_page_writeback(struct page *page, bool keep_write);

#define test_set_page_writeback(page)			\
	__test_set_page_writeback(page, false)
#define test_set_page_writeback_keepwrite(page)	\
	__test_set_page_writeback(page, true)
L
Linus Torvalds 已提交
489

490 491 492 493
static inline void set_page_writeback(struct page *page)
{
	test_set_page_writeback(page);
}
L
Linus Torvalds 已提交
494

495 496 497 498 499
static inline void set_page_writeback_keepwrite(struct page *page)
{
	test_set_page_writeback_keepwrite(page);
}

500
__PAGEFLAG(Head, head, PF_ANY) CLEARPAGEFLAG(Head, head, PF_ANY)
501

502
static __always_inline void set_compound_head(struct page *page, struct page *head)
503
{
504
	WRITE_ONCE(page->compound_head, (unsigned long)head + 1);
505 506
}

507
static __always_inline void clear_compound_head(struct page *page)
508
{
509
	WRITE_ONCE(page->compound_head, 0);
510
}
511

A
Andrea Arcangeli 已提交
512 513 514
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
static inline void ClearPageCompound(struct page *page)
{
515 516
	BUG_ON(!PageHead(page));
	ClearPageHead(page);
A
Andrea Arcangeli 已提交
517 518 519
}
#endif

520
#define PG_head_mask ((1UL << PG_head))
521

522 523 524
#ifdef CONFIG_HUGETLB_PAGE
int PageHuge(struct page *page);
int PageHeadHuge(struct page *page);
525
bool page_huge_active(struct page *page);
526 527 528
#else
TESTPAGEFLAG_FALSE(Huge)
TESTPAGEFLAG_FALSE(HeadHuge)
529 530 531 532 533

static inline bool page_huge_active(struct page *page)
{
	return 0;
}
534 535
#endif

536

537
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
538 539 540 541 542 543 544 545 546 547
/*
 * 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)
{
548
	VM_BUG_ON_PAGE(PageTail(page), page);
549 550 551
	return PageHead(page);
}

552 553 554 555 556
/*
 * PageTransCompound returns true for both transparent huge pages
 * and hugetlbfs pages, so it should only be called when it's known
 * that hugetlbfs pages aren't involved.
 */
557 558 559 560
static inline int PageTransCompound(struct page *page)
{
	return PageCompound(page);
}
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
/*
 * PageTransCompoundMap is the same as PageTransCompound, but it also
 * guarantees the primary MMU has the entire compound page mapped
 * through pmd_trans_huge, which in turn guarantees the secondary MMUs
 * can also map the entire compound page. This allows the secondary
 * MMUs to call get_user_pages() only once for each compound page and
 * to immediately map the entire compound page with a single secondary
 * MMU fault. If there will be a pmd split later, the secondary MMUs
 * will get an update through the MMU notifier invalidation through
 * split_huge_pmd().
 *
 * Unlike PageTransCompound, this is safe to be called only while
 * split_huge_pmd() cannot run from under us, like if protected by the
 * MMU notifier, otherwise it may result in page->_mapcount < 0 false
 * positives.
 */
static inline int PageTransCompoundMap(struct page *page)
{
	return PageTransCompound(page) && atomic_read(&page->_mapcount) < 0;
}

583 584 585 586 587 588 589 590 591 592
/*
 * PageTransTail returns true for both transparent huge pages
 * and hugetlbfs pages, so it should only be called when it's known
 * that hugetlbfs pages aren't involved.
 */
static inline int PageTransTail(struct page *page)
{
	return PageTail(page);
}

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
/*
 * PageDoubleMap indicates that the compound page is mapped with PTEs as well
 * as PMDs.
 *
 * This is required for optimization of rmap operations for THP: we can postpone
 * per small page mapcount accounting (and its overhead from atomic operations)
 * until the first PMD split.
 *
 * For the page PageDoubleMap means ->_mapcount in all sub-pages is offset up
 * by one. This reference will go away with last compound_mapcount.
 *
 * See also __split_huge_pmd_locked() and page_remove_anon_compound_rmap().
 */
static inline int PageDoubleMap(struct page *page)
{
	return PageHead(page) && test_bit(PG_double_map, &page[1].flags);
}

611 612 613 614 615 616 617 618 619 620 621
static inline void SetPageDoubleMap(struct page *page)
{
	VM_BUG_ON_PAGE(!PageHead(page), page);
	set_bit(PG_double_map, &page[1].flags);
}

static inline void ClearPageDoubleMap(struct page *page)
{
	VM_BUG_ON_PAGE(!PageHead(page), page);
	clear_bit(PG_double_map, &page[1].flags);
}
622 623 624 625 626 627 628 629 630 631 632 633
static inline int TestSetPageDoubleMap(struct page *page)
{
	VM_BUG_ON_PAGE(!PageHead(page), page);
	return test_and_set_bit(PG_double_map, &page[1].flags);
}

static inline int TestClearPageDoubleMap(struct page *page)
{
	VM_BUG_ON_PAGE(!PageHead(page), page);
	return test_and_clear_bit(PG_double_map, &page[1].flags);
}

634
#else
635 636
TESTPAGEFLAG_FALSE(TransHuge)
TESTPAGEFLAG_FALSE(TransCompound)
637
TESTPAGEFLAG_FALSE(TransCompoundMap)
638
TESTPAGEFLAG_FALSE(TransTail)
639
PAGEFLAG_FALSE(DoubleMap)
640 641
	TESTSETFLAG_FALSE(DoubleMap)
	TESTCLEARFLAG_FALSE(DoubleMap)
642 643
#endif

644
/*
645 646 647 648 649 650
 * For pages that are never mapped to userspace (and aren't PageSlab),
 * page_type may be used.  Because it is initialised to -1, we invert the
 * sense of the bit, so __SetPageFoo *clears* the bit used for PageFoo, and
 * __ClearPageFoo *sets* the bit used for PageFoo.  We reserve a few high and
 * low bits so that an underflow or overflow of page_mapcount() won't be
 * mistaken for a page type value.
651
 */
652 653 654 655 656 657 658 659 660 661 662

#define PAGE_TYPE_BASE	0xf0000000
/* Reserve		0x0000007f to catch underflows of page_mapcount */
#define PG_buddy	0x00000080
#define PG_balloon	0x00000100
#define PG_kmemcg	0x00000200

#define PageType(page, flag)						\
	((page->page_type & (PAGE_TYPE_BASE | flag)) == PAGE_TYPE_BASE)

#define PAGE_TYPE_OPS(uname, lname)					\
663 664
static __always_inline int Page##uname(struct page *page)		\
{									\
665
	return PageType(page, PG_##lname);				\
666 667 668
}									\
static __always_inline void __SetPage##uname(struct page *page)		\
{									\
669 670
	VM_BUG_ON_PAGE(!PageType(page, 0), page);			\
	page->page_type &= ~PG_##lname;					\
671 672 673 674
}									\
static __always_inline void __ClearPage##uname(struct page *page)	\
{									\
	VM_BUG_ON_PAGE(!Page##uname(page), page);			\
675
	page->page_type |= PG_##lname;					\
676 677
}

678
/*
679
 * PageBuddy() indicates that the page is free and in the buddy system
680 681
 * (see mm/page_alloc.c).
 */
682
PAGE_TYPE_OPS(Buddy, buddy)
683

684
/*
685
 * PageBalloon() is true for pages that are on the balloon page list
686 687
 * (see mm/balloon_compaction.c).
 */
688
PAGE_TYPE_OPS(Balloon, balloon)
689

690 691 692 693
/*
 * If kmemcg is enabled, the buddy allocator will set PageKmemcg() on
 * pages allocated with __GFP_ACCOUNT. It gets cleared on page free.
 */
694
PAGE_TYPE_OPS(Kmemcg, kmemcg)
695

696 697
extern bool is_free_buddy_page(struct page *page);

698 699
__PAGEFLAG(Isolated, isolated, PF_ANY);

700 701 702 703 704 705
/*
 * If network-based swap is enabled, sl*b must keep track of whether pages
 * were allocated from pfmemalloc reserves.
 */
static inline int PageSlabPfmemalloc(struct page *page)
{
706
	VM_BUG_ON_PAGE(!PageSlab(page), page);
707 708 709 710 711
	return PageActive(page);
}

static inline void SetPageSlabPfmemalloc(struct page *page)
{
712
	VM_BUG_ON_PAGE(!PageSlab(page), page);
713 714 715 716 717
	SetPageActive(page);
}

static inline void __ClearPageSlabPfmemalloc(struct page *page)
{
718
	VM_BUG_ON_PAGE(!PageSlab(page), page);
719 720 721 722 723
	__ClearPageActive(page);
}

static inline void ClearPageSlabPfmemalloc(struct page *page)
{
724
	VM_BUG_ON_PAGE(!PageSlab(page), page);
725 726 727
	ClearPageActive(page);
}

H
Hugh Dickins 已提交
728
#ifdef CONFIG_MMU
729
#define __PG_MLOCKED		(1UL << PG_mlocked)
730
#else
N
Nick Piggin 已提交
731
#define __PG_MLOCKED		0
L
Lee Schermerhorn 已提交
732 733
#endif

734 735 736 737
/*
 * Flags checked when a page is freed.  Pages being freed should not have
 * these flags set.  It they are, there is a problem.
 */
738 739 740 741 742 743
#define PAGE_FLAGS_CHECK_AT_FREE				\
	(1UL << PG_lru		| 1UL << PG_locked	|	\
	 1UL << PG_private	| 1UL << PG_private_2	|	\
	 1UL << PG_writeback	| 1UL << PG_reserved	|	\
	 1UL << PG_slab		| 1UL << PG_active 	|	\
	 1UL << PG_unevictable	| __PG_MLOCKED)
744 745 746

/*
 * Flags checked when a page is prepped for return by the page allocator.
747
 * Pages being prepped should not have these flags set.  It they are set,
748
 * there has been a kernel bug or struct page corruption.
749 750 751
 *
 * __PG_HWPOISON is exceptional because it needs to be kept beyond page's
 * alloc-free cycle to prevent from reusing the page.
752
 */
753
#define PAGE_FLAGS_CHECK_AT_PREP	\
754
	(((1UL << NR_PAGEFLAGS) - 1) & ~__PG_HWPOISON)
755

756
#define PAGE_FLAGS_PRIVATE				\
757
	(1UL << PG_private | 1UL << PG_private_2)
758 759 760 761 762 763 764
/**
 * 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.
 */
765 766 767 768 769
static inline int page_has_private(struct page *page)
{
	return !!(page->flags & PAGE_FLAGS_PRIVATE);
}

770 771
#undef PF_ANY
#undef PF_HEAD
772
#undef PF_ONLY_HEAD
773 774
#undef PF_NO_TAIL
#undef PF_NO_COMPOUND
775
#endif /* !__GENERATING_BOUNDS_H */
776

L
Linus Torvalds 已提交
777
#endif	/* PAGE_FLAGS_H */