page-flags.h 22.8 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7
/*
 * Macros for manipulating and testing page->flags
 */

#ifndef PAGE_FLAGS_H
#define PAGE_FLAGS_H

8
#include <linux/types.h>
9
#include <linux/bug.h>
10
#include <linux/mmdebug.h>
11
#ifndef __GENERATING_BOUNDS_H
12
#include <linux/mm_types.h>
13
#include <generated/bounds.h>
14
#endif /* !__GENERATING_BOUNDS_H */
15

Linus Torvalds's avatar
Linus Torvalds committed
16 17 18 19 20 21
/*
 * Various page->flags bits:
 *
 * PG_reserved is set for special pages, which can never be swapped out. Some
 * of them might not even exist (eg empty_bad_page)...
 *
22 23 24
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
25
 *
26 27 28 29 30 31 32 33 34
 * 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.
Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38
 *
 * 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.
 *
39 40
 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
 * file-backed pagecache (see mm/vmscan.c).
Linus Torvalds's avatar
Linus Torvalds committed
41 42 43 44 45 46 47 48 49 50 51
 *
 * PG_error is set to indicate that an I/O error occurred on this page.
 *
 * PG_arch_1 is an architecture specific page state bit.  The generic code
 * guarantees that this bit is cleared for a page when it first is entered into
 * the page cache.
 *
 * PG_highmem pages are not permanently mapped into the kernel virtual address
 * space, they need to be kmapped separately for doing IO on the pages.  The
 * struct page (these bits with information) are always mapped into kernel
 * address space...
52
 *
53 54 55
 * 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!
Linus Torvalds's avatar
Linus Torvalds committed
56 57 58 59
 */

/*
 * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
60 61 62 63 64 65 66
 * 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 |
67 68
 *  N-1           ^       0
 *               (NR_PAGEFLAGS)
69
 *
70 71 72
 * 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).
Linus Torvalds's avatar
Linus Torvalds committed
73
 */
74 75 76 77 78 79 80 81 82 83 84 85 86
enum pageflags {
	PG_locked,		/* Page is locked. Don't touch. */
	PG_error,
	PG_referenced,
	PG_uptodate,
	PG_dirty,
	PG_lru,
	PG_active,
	PG_slab,
	PG_owner_priv_1,	/* Owner use. If pagecache, fs may use*/
	PG_arch_1,
	PG_reserved,
	PG_private,		/* If pagecache, has fs-private data */
87
	PG_private_2,		/* If pagecache, has fs aux data */
88
	PG_writeback,		/* Page is under writeback */
89
	PG_head,		/* A head page */
90 91 92
	PG_swapcache,		/* Swap page: swp_entry_t in private */
	PG_mappedtodisk,	/* Has blocks allocated on-disk */
	PG_reclaim,		/* To be reclaimed asap */
93
	PG_swapbacked,		/* Page is backed by RAM/swap */
94
	PG_unevictable,		/* Page is "unevictable"  */
95
#ifdef CONFIG_MMU
96
	PG_mlocked,		/* Page is vma mlocked */
97
#endif
98
#ifdef CONFIG_ARCH_USES_PG_UNCACHED
99
	PG_uncached,		/* Page has been mapped as uncached */
100 101 102
#endif
#ifdef CONFIG_MEMORY_FAILURE
	PG_hwpoison,		/* hardware poisoned page. Don't touch */
Andrea Arcangeli's avatar
Andrea Arcangeli committed
103
#endif
104 105 106
#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
	PG_young,
	PG_idle,
107
#endif
108 109 110 111 112
	__NR_PAGEFLAGS,

	/* Filesystems */
	PG_checked = PG_owner_priv_1,

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

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

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

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

	/* non-lru isolated movable page */
	PG_isolated = PG_reclaim,
135
};
Linus Torvalds's avatar
Linus Torvalds committed
136

137 138
#ifndef __GENERATING_BOUNDS_H

139 140 141 142 143 144 145 146 147 148 149
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;
}

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

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

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/*
 * Page flags policies wrt compound pages
 *
 * 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.
 *
 * 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.
 */
#define PF_ANY(page, enforce)	page
#define PF_HEAD(page, enforce)	compound_head(page)
#define PF_NO_TAIL(page, enforce) ({					\
		VM_BUG_ON_PGFLAGS(enforce && PageTail(page), page);	\
		compound_head(page);})
182
#define PF_NO_COMPOUND(page, enforce) ({				\
183 184 185
		VM_BUG_ON_PGFLAGS(enforce && PageCompound(page), page);	\
		page;})

186 187 188
/*
 * Macros to create function definitions for page flags
 */
189
#define TESTPAGEFLAG(uname, lname, policy)				\
190
static __always_inline int Page##uname(struct page *page)		\
191
	{ return test_bit(PG_##lname, &policy(page, 0)->flags); }
192

193
#define SETPAGEFLAG(uname, lname, policy)				\
194
static __always_inline void SetPage##uname(struct page *page)		\
195
	{ set_bit(PG_##lname, &policy(page, 1)->flags); }
196

197
#define CLEARPAGEFLAG(uname, lname, policy)				\
198
static __always_inline void ClearPage##uname(struct page *page)		\
199
	{ clear_bit(PG_##lname, &policy(page, 1)->flags); }
200

201
#define __SETPAGEFLAG(uname, lname, policy)				\
202
static __always_inline void __SetPage##uname(struct page *page)		\
203
	{ __set_bit(PG_##lname, &policy(page, 1)->flags); }
204

205
#define __CLEARPAGEFLAG(uname, lname, policy)				\
206
static __always_inline void __ClearPage##uname(struct page *page)	\
207
	{ __clear_bit(PG_##lname, &policy(page, 1)->flags); }
208

209
#define TESTSETFLAG(uname, lname, policy)				\
210
static __always_inline int TestSetPage##uname(struct page *page)	\
211
	{ return test_and_set_bit(PG_##lname, &policy(page, 1)->flags); }
212

213
#define TESTCLEARFLAG(uname, lname, policy)				\
214
static __always_inline int TestClearPage##uname(struct page *page)	\
215
	{ return test_and_clear_bit(PG_##lname, &policy(page, 1)->flags); }
216

217 218 219 220
#define PAGEFLAG(uname, lname, policy)					\
	TESTPAGEFLAG(uname, lname, policy)				\
	SETPAGEFLAG(uname, lname, policy)				\
	CLEARPAGEFLAG(uname, lname, policy)
221

222 223 224 225
#define __PAGEFLAG(uname, lname, policy)				\
	TESTPAGEFLAG(uname, lname, policy)				\
	__SETPAGEFLAG(uname, lname, policy)				\
	__CLEARPAGEFLAG(uname, lname, policy)
226

227 228 229
#define TESTSCFLAG(uname, lname, policy)				\
	TESTSETFLAG(uname, lname, policy)				\
	TESTCLEARFLAG(uname, lname, policy)
230

231 232 233
#define TESTPAGEFLAG_FALSE(uname)					\
static inline int Page##uname(const struct page *page) { return 0; }

234 235 236 237 238 239 240 241 242
#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) {  }

243 244 245
#define TESTSETFLAG_FALSE(uname)					\
static inline int TestSetPage##uname(struct page *page) { return 0; }

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

249 250 251 252 253 254
#define PAGEFLAG_FALSE(uname) TESTPAGEFLAG_FALSE(uname)			\
	SETPAGEFLAG_NOOP(uname) CLEARPAGEFLAG_NOOP(uname)

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

255
__PAGEFLAG(Locked, locked, PF_NO_TAIL)
256
PAGEFLAG(Error, error, PF_NO_COMPOUND) TESTCLEARFLAG(Error, error, PF_NO_COMPOUND)
257 258 259
PAGEFLAG(Referenced, referenced, PF_HEAD)
	TESTCLEARFLAG(Referenced, referenced, PF_HEAD)
	__SETPAGEFLAG(Referenced, referenced, PF_HEAD)
260 261
PAGEFLAG(Dirty, dirty, PF_HEAD) TESTSCFLAG(Dirty, dirty, PF_HEAD)
	__CLEARPAGEFLAG(Dirty, dirty, PF_HEAD)
262 263 264
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)
265 266
__PAGEFLAG(Slab, slab, PF_NO_TAIL)
__PAGEFLAG(SlobFree, slob_free, PF_NO_TAIL)
267
PAGEFLAG(Checked, checked, PF_NO_COMPOUND)	   /* Used by some filesystems */
268 269 270 271 272 273 274

/* 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);

275 276
PAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
	__CLEARPAGEFLAG(Reserved, reserved, PF_NO_COMPOUND)
277 278 279
PAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
	__CLEARPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
	__SETPAGEFLAG(SwapBacked, swapbacked, PF_NO_TAIL)
280

281 282 283 284 285
/*
 * 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
 */
286 287 288 289 290
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)
291

292 293 294 295
/*
 * Only test-and-set exist for PG_writeback.  The unconditional operators are
 * risky: they bypass page accounting.
 */
296 297
TESTPAGEFLAG(Writeback, writeback, PF_NO_COMPOUND)
	TESTSCFLAG(Writeback, writeback, PF_NO_COMPOUND)
298
PAGEFLAG(MappedToDisk, mappedtodisk, PF_NO_TAIL)
299

300
/* PG_readahead is only used for reads; PG_reclaim is only for writes */
301 302
PAGEFLAG(Reclaim, reclaim, PF_NO_TAIL)
	TESTCLEARFLAG(Reclaim, reclaim, PF_NO_TAIL)
303 304
PAGEFLAG(Readahead, reclaim, PF_NO_COMPOUND)
	TESTCLEARFLAG(Readahead, reclaim, PF_NO_COMPOUND)
305 306

#ifdef CONFIG_HIGHMEM
Linus Torvalds's avatar
Linus Torvalds committed
307
/*
308 309
 * Must use a macro here due to header dependency issues. page_zone() is not
 * available at this point.
Linus Torvalds's avatar
Linus Torvalds committed
310
 */
311
#define PageHighMem(__p) is_highmem_idx(page_zonenum(__p))
312
#else
313
PAGEFLAG_FALSE(HighMem)
314 315 316
#endif

#ifdef CONFIG_SWAP
317
PAGEFLAG(SwapCache, swapcache, PF_NO_COMPOUND)
318
#else
319
PAGEFLAG_FALSE(SwapCache)
320 321
#endif

322 323 324
PAGEFLAG(Unevictable, unevictable, PF_HEAD)
	__CLEARPAGEFLAG(Unevictable, unevictable, PF_HEAD)
	TESTCLEARFLAG(Unevictable, unevictable, PF_HEAD)
325

326
#ifdef CONFIG_MMU
327 328 329
PAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
	__CLEARPAGEFLAG(Mlocked, mlocked, PF_NO_TAIL)
	TESTSCFLAG(Mlocked, mlocked, PF_NO_TAIL)
330
#else
331
PAGEFLAG_FALSE(Mlocked) __CLEARPAGEFLAG_NOOP(Mlocked)
332
	TESTSCFLAG_FALSE(Mlocked)
333 334
#endif

335
#ifdef CONFIG_ARCH_USES_PG_UNCACHED
336
PAGEFLAG(Uncached, uncached, PF_NO_COMPOUND)
337
#else
338
PAGEFLAG_FALSE(Uncached)
339
#endif
Linus Torvalds's avatar
Linus Torvalds committed
340

341
#ifdef CONFIG_MEMORY_FAILURE
342 343
PAGEFLAG(HWPoison, hwpoison, PF_ANY)
TESTSCFLAG(HWPoison, hwpoison, PF_ANY)
344 345 346 347 348 349
#define __PG_HWPOISON (1UL << PG_hwpoison)
#else
PAGEFLAG_FALSE(HWPoison)
#define __PG_HWPOISON 0
#endif

350
#if defined(CONFIG_IDLE_PAGE_TRACKING) && defined(CONFIG_64BIT)
351 352 353 354
TESTPAGEFLAG(Young, young, PF_ANY)
SETPAGEFLAG(Young, young, PF_ANY)
TESTCLEARFLAG(Young, young, PF_ANY)
PAGEFLAG(Idle, idle, PF_ANY)
355 356
#endif

357 358 359 360 361 362
/*
 * 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,
363 364
 * 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
365 366
 * structure which KSM associates with that merged page.  See ksm.h.
 *
367 368
 * PAGE_MAPPING_KSM without PAGE_MAPPING_ANON is used for non-lru movable
 * page and then page->mapping points a struct address_space.
369 370 371 372 373
 *
 * 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.
 */
374 375 376 377
#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)
378

379
static __always_inline int PageMappingFlags(struct page *page)
380
{
381
	return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) != 0;
382 383
}

384
static __always_inline int PageAnon(struct page *page)
385
{
386
	page = compound_head(page);
387 388 389 390 391 392 393
	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;
394 395 396 397 398 399 400 401 402
}

#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.
 */
403
static __always_inline int PageKsm(struct page *page)
404
{
405
	page = compound_head(page);
406
	return ((unsigned long)page->mapping & PAGE_MAPPING_FLAGS) ==
407
				PAGE_MAPPING_KSM;
408 409 410 411 412
}
#else
TESTPAGEFLAG_FALSE(Ksm)
#endif

413 414
u64 stable_page_flags(struct page *page);

415 416
static inline int PageUptodate(struct page *page)
{
417 418 419
	int ret;
	page = compound_head(page);
	ret = test_bit(PG_uptodate, &(page)->flags);
420 421 422 423 424 425 426 427 428 429 430 431 432 433
	/*
	 * 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;
}

434
static __always_inline void __SetPageUptodate(struct page *page)
435
{
436
	VM_BUG_ON_PAGE(PageTail(page), page);
437
	smp_wmb();
438
	__set_bit(PG_uptodate, &page->flags);
439 440
}

441
static __always_inline void SetPageUptodate(struct page *page)
442
{
443
	VM_BUG_ON_PAGE(PageTail(page), page);
444 445 446 447 448 449
	/*
	 * 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();
450
	set_bit(PG_uptodate, &page->flags);
451 452
}

453
CLEARPAGEFLAG(Uptodate, uptodate, PF_NO_TAIL)
Linus Torvalds's avatar
Linus Torvalds committed
454

455
int test_clear_page_writeback(struct page *page);
456 457 458 459 460 461
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)
Linus Torvalds's avatar
Linus Torvalds committed
462

463 464 465 466
static inline void set_page_writeback(struct page *page)
{
	test_set_page_writeback(page);
}
Linus Torvalds's avatar
Linus Torvalds committed
467

468 469 470 471 472
static inline void set_page_writeback_keepwrite(struct page *page)
{
	test_set_page_writeback_keepwrite(page);
}

473
__PAGEFLAG(Head, head, PF_ANY) CLEARPAGEFLAG(Head, head, PF_ANY)
474

475
static __always_inline void set_compound_head(struct page *page, struct page *head)
476
{
477
	WRITE_ONCE(page->compound_head, (unsigned long)head + 1);
478 479
}

480
static __always_inline void clear_compound_head(struct page *page)
481
{
482
	WRITE_ONCE(page->compound_head, 0);
483
}
484

485 486 487
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
static inline void ClearPageCompound(struct page *page)
{
488 489
	BUG_ON(!PageHead(page));
	ClearPageHead(page);
490 491 492
}
#endif

493
#define PG_head_mask ((1UL << PG_head))
494

495 496 497
#ifdef CONFIG_HUGETLB_PAGE
int PageHuge(struct page *page);
int PageHeadHuge(struct page *page);
498
bool page_huge_active(struct page *page);
499 500 501
#else
TESTPAGEFLAG_FALSE(Huge)
TESTPAGEFLAG_FALSE(HeadHuge)
502 503 504 505 506

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

509

510
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
511 512 513 514 515 516 517 518 519 520
/*
 * 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)
{
521
	VM_BUG_ON_PAGE(PageTail(page), page);
522 523 524
	return PageHead(page);
}

525 526 527 528 529
/*
 * 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.
 */
530 531 532 533
static inline int PageTransCompound(struct page *page)
{
	return PageCompound(page);
}
534

535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
/*
 * 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;
}

556 557 558 559 560 561 562 563 564 565
/*
 * 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);
}

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
/*
 * 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);
}

584 585 586 587 588 589 590 591 592 593 594
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);
}
595 596 597 598 599 600 601 602 603 604 605 606
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);
}

607
#else
608 609
TESTPAGEFLAG_FALSE(TransHuge)
TESTPAGEFLAG_FALSE(TransCompound)
610
TESTPAGEFLAG_FALSE(TransCompoundMap)
611
TESTPAGEFLAG_FALSE(TransTail)
612
PAGEFLAG_FALSE(DoubleMap)
613 614
	TESTSETFLAG_FALSE(DoubleMap)
	TESTCLEARFLAG_FALSE(DoubleMap)
615 616
#endif

617
/*
618 619 620 621 622
 * For pages that are never mapped to userspace, page->mapcount may be
 * used for storing extra information about page type. Any value used
 * for this purpose must be <= -2, but it's better start not too close
 * to -2 so that an underflow of the page_mapcount() won't be mistaken
 * for a special page.
623
 */
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
#define PAGE_MAPCOUNT_OPS(uname, lname)					\
static __always_inline int Page##uname(struct page *page)		\
{									\
	return atomic_read(&page->_mapcount) ==				\
				PAGE_##lname##_MAPCOUNT_VALUE;		\
}									\
static __always_inline void __SetPage##uname(struct page *page)		\
{									\
	VM_BUG_ON_PAGE(atomic_read(&page->_mapcount) != -1, page);	\
	atomic_set(&page->_mapcount, PAGE_##lname##_MAPCOUNT_VALUE);	\
}									\
static __always_inline void __ClearPage##uname(struct page *page)	\
{									\
	VM_BUG_ON_PAGE(!Page##uname(page), page);			\
	atomic_set(&page->_mapcount, -1);				\
639 640
}

641 642 643 644 645 646
/*
 * PageBuddy() indicate that the page is free and in the buddy system
 * (see mm/page_alloc.c).
 */
#define PAGE_BUDDY_MAPCOUNT_VALUE		(-128)
PAGE_MAPCOUNT_OPS(Buddy, BUDDY)
647

648 649 650 651 652 653
/*
 * PageBalloon() is set on pages that are on the balloon page list
 * (see mm/balloon_compaction.c).
 */
#define PAGE_BALLOON_MAPCOUNT_VALUE		(-256)
PAGE_MAPCOUNT_OPS(Balloon, BALLOON)
654

655 656 657 658 659 660 661
/*
 * If kmemcg is enabled, the buddy allocator will set PageKmemcg() on
 * pages allocated with __GFP_ACCOUNT. It gets cleared on page free.
 */
#define PAGE_KMEMCG_MAPCOUNT_VALUE		(-512)
PAGE_MAPCOUNT_OPS(Kmemcg, KMEMCG)

662 663
extern bool is_free_buddy_page(struct page *page);

664 665
__PAGEFLAG(Isolated, isolated, PF_ANY);

666 667 668 669 670 671
/*
 * 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)
{
672
	VM_BUG_ON_PAGE(!PageSlab(page), page);
673 674 675 676 677
	return PageActive(page);
}

static inline void SetPageSlabPfmemalloc(struct page *page)
{
678
	VM_BUG_ON_PAGE(!PageSlab(page), page);
679 680 681 682 683
	SetPageActive(page);
}

static inline void __ClearPageSlabPfmemalloc(struct page *page)
{
684
	VM_BUG_ON_PAGE(!PageSlab(page), page);
685 686 687 688 689
	__ClearPageActive(page);
}

static inline void ClearPageSlabPfmemalloc(struct page *page)
{
690
	VM_BUG_ON_PAGE(!PageSlab(page), page);
691 692 693
	ClearPageActive(page);
}

694
#ifdef CONFIG_MMU
695
#define __PG_MLOCKED		(1UL << PG_mlocked)
696
#else
697
#define __PG_MLOCKED		0
698 699
#endif

700 701 702 703
/*
 * Flags checked when a page is freed.  Pages being freed should not have
 * these flags set.  It they are, there is a problem.
 */
704
#define PAGE_FLAGS_CHECK_AT_FREE \
705 706 707 708 709
	(1UL << PG_lru	 | 1UL << PG_locked    | \
	 1UL << PG_private | 1UL << PG_private_2 | \
	 1UL << PG_writeback | 1UL << PG_reserved | \
	 1UL << PG_slab	 | 1UL << PG_swapcache | 1UL << PG_active | \
	 1UL << PG_unevictable | __PG_MLOCKED)
710 711 712

/*
 * Flags checked when a page is prepped for return by the page allocator.
713
 * Pages being prepped should not have these flags set.  It they are set,
714
 * there has been a kernel bug or struct page corruption.
715 716 717
 *
 * __PG_HWPOISON is exceptional because it needs to be kept beyond page's
 * alloc-free cycle to prevent from reusing the page.
718
 */
719
#define PAGE_FLAGS_CHECK_AT_PREP	\
720
	(((1UL << NR_PAGEFLAGS) - 1) & ~__PG_HWPOISON)
721

722
#define PAGE_FLAGS_PRIVATE				\
723
	(1UL << PG_private | 1UL << PG_private_2)
724 725 726 727 728 729 730
/**
 * 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.
 */
731 732 733 734 735
static inline int page_has_private(struct page *page)
{
	return !!(page->flags & PAGE_FLAGS_PRIVATE);
}

736 737 738 739
#undef PF_ANY
#undef PF_HEAD
#undef PF_NO_TAIL
#undef PF_NO_COMPOUND
740
#endif /* !__GENERATING_BOUNDS_H */
741

Linus Torvalds's avatar
Linus Torvalds committed
742
#endif	/* PAGE_FLAGS_H */