2 * Macros for manipulating and testing page->flags
8 #include <linux/types.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 */
17 * Various page->flags bits:
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)...
22 * 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.
26 * 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.
30 * PG_locked also pins a page in pagecache, and blocks truncation of the file
33 * page_waitqueue(page) is a wait queue of all tasks waiting for the page
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.
39 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
40 * file-backed pagecache (see mm/vmscan.c).
42 * PG_error is set to indicate that an I/O error occurred on this page.
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
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
53 * 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!
59 * Don't use the *_dontuse flags. Use the macros. Otherwise you'll break
60 * locked- and dirty-page accounting.
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.
66 * | FIELD | ... | FLAGS |
70 * 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).
75 PG_locked
, /* Page is locked. Don't touch. */
83 PG_owner_priv_1
, /* Owner use. If pagecache, fs may use*/
86 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 #ifdef CONFIG_PAGEFLAGS_EXTENDED
90 PG_head
, /* A head page */
91 PG_tail
, /* A tail page */
93 PG_compound
, /* A compound page */
95 PG_swapcache
, /* Swap page: swp_entry_t in private */
96 PG_mappedtodisk
, /* Has blocks allocated on-disk */
97 PG_reclaim
, /* To be reclaimed asap */
98 PG_swapbacked
, /* Page is backed by RAM/swap */
99 PG_unevictable
, /* Page is "unevictable" */
101 PG_mlocked
, /* Page is vma mlocked */
103 #ifdef CONFIG_ARCH_USES_PG_UNCACHED
104 PG_uncached
, /* Page has been mapped as uncached */
106 #ifdef CONFIG_MEMORY_FAILURE
107 PG_hwpoison
, /* hardware poisoned page. Don't touch */
109 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
115 PG_checked
= PG_owner_priv_1
,
117 /* Two page bits are conscripted by FS-Cache to maintain local caching
118 * state. These bits are set on pages belonging to the netfs's inodes
119 * when those inodes are being locally cached.
121 PG_fscache
= PG_private_2
, /* page backed by cache */
124 /* Pinned in Xen as a read-only pagetable page. */
125 PG_pinned
= PG_owner_priv_1
,
126 /* Pinned as part of domain save (see xen_mm_pin_all()). */
127 PG_savepinned
= PG_dirty
,
128 /* Has a grant mapping of another (foreign) domain's page. */
129 PG_foreign
= PG_owner_priv_1
,
132 PG_slob_free
= PG_private
,
135 #ifndef __GENERATING_BOUNDS_H
138 * Macros to create function definitions for page flags
140 #define TESTPAGEFLAG(uname, lname) \
141 static inline int Page##uname(const struct page *page) \
142 { return test_bit(PG_##lname, &page->flags); }
144 #define SETPAGEFLAG(uname, lname) \
145 static inline void SetPage##uname(struct page *page) \
146 { set_bit(PG_##lname, &page->flags); }
148 #define CLEARPAGEFLAG(uname, lname) \
149 static inline void ClearPage##uname(struct page *page) \
150 { clear_bit(PG_##lname, &page->flags); }
152 #define __SETPAGEFLAG(uname, lname) \
153 static inline void __SetPage##uname(struct page *page) \
154 { __set_bit(PG_##lname, &page->flags); }
156 #define __CLEARPAGEFLAG(uname, lname) \
157 static inline void __ClearPage##uname(struct page *page) \
158 { __clear_bit(PG_##lname, &page->flags); }
160 #define TESTSETFLAG(uname, lname) \
161 static inline int TestSetPage##uname(struct page *page) \
162 { return test_and_set_bit(PG_##lname, &page->flags); }
164 #define TESTCLEARFLAG(uname, lname) \
165 static inline int TestClearPage##uname(struct page *page) \
166 { return test_and_clear_bit(PG_##lname, &page->flags); }
168 #define __TESTCLEARFLAG(uname, lname) \
169 static inline int __TestClearPage##uname(struct page *page) \
170 { return __test_and_clear_bit(PG_##lname, &page->flags); }
172 #define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
173 SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
175 #define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
176 __SETPAGEFLAG(uname, lname) __CLEARPAGEFLAG(uname, lname)
178 #define TESTSCFLAG(uname, lname) \
179 TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
181 #define TESTPAGEFLAG_FALSE(uname) \
182 static inline int Page##uname(const struct page *page) { return 0; }
184 #define SETPAGEFLAG_NOOP(uname) \
185 static inline void SetPage##uname(struct page *page) { }
187 #define CLEARPAGEFLAG_NOOP(uname) \
188 static inline void ClearPage##uname(struct page *page) { }
190 #define __CLEARPAGEFLAG_NOOP(uname) \
191 static inline void __ClearPage##uname(struct page *page) { }
193 #define TESTSETFLAG_FALSE(uname) \
194 static inline int TestSetPage##uname(struct page *page) { return 0; }
196 #define TESTCLEARFLAG_FALSE(uname) \
197 static inline int TestClearPage##uname(struct page *page) { return 0; }
199 #define __TESTCLEARFLAG_FALSE(uname) \
200 static inline int __TestClearPage##uname(struct page *page) { return 0; }
202 #define PAGEFLAG_FALSE(uname) TESTPAGEFLAG_FALSE(uname) \
203 SETPAGEFLAG_NOOP(uname) CLEARPAGEFLAG_NOOP(uname)
205 #define TESTSCFLAG_FALSE(uname) \
206 TESTSETFLAG_FALSE(uname) TESTCLEARFLAG_FALSE(uname)
208 struct page
; /* forward declaration */
210 TESTPAGEFLAG(Locked
, locked
)
211 PAGEFLAG(Error
, error
) TESTCLEARFLAG(Error
, error
)
212 PAGEFLAG(Referenced
, referenced
) TESTCLEARFLAG(Referenced
, referenced
)
213 __SETPAGEFLAG(Referenced
, referenced
)
214 PAGEFLAG(Dirty
, dirty
) TESTSCFLAG(Dirty
, dirty
) __CLEARPAGEFLAG(Dirty
, dirty
)
215 PAGEFLAG(LRU
, lru
) __CLEARPAGEFLAG(LRU
, lru
)
216 PAGEFLAG(Active
, active
) __CLEARPAGEFLAG(Active
, active
)
217 TESTCLEARFLAG(Active
, active
)
218 __PAGEFLAG(Slab
, slab
)
219 PAGEFLAG(Checked
, checked
) /* Used by some filesystems */
220 PAGEFLAG(Pinned
, pinned
) TESTSCFLAG(Pinned
, pinned
) /* Xen */
221 PAGEFLAG(SavePinned
, savepinned
); /* Xen */
222 PAGEFLAG(Foreign
, foreign
); /* Xen */
223 PAGEFLAG(Reserved
, reserved
) __CLEARPAGEFLAG(Reserved
, reserved
)
224 PAGEFLAG(SwapBacked
, swapbacked
) __CLEARPAGEFLAG(SwapBacked
, swapbacked
)
225 __SETPAGEFLAG(SwapBacked
, swapbacked
)
227 __PAGEFLAG(SlobFree
, slob_free
)
230 * Private page markings that may be used by the filesystem that owns the page
231 * for its own purposes.
232 * - PG_private and PG_private_2 cause releasepage() and co to be invoked
234 PAGEFLAG(Private
, private) __SETPAGEFLAG(Private
, private)
235 __CLEARPAGEFLAG(Private
, private)
236 PAGEFLAG(Private2
, private_2
) TESTSCFLAG(Private2
, private_2
)
237 PAGEFLAG(OwnerPriv1
, owner_priv_1
) TESTCLEARFLAG(OwnerPriv1
, owner_priv_1
)
240 * Only test-and-set exist for PG_writeback. The unconditional operators are
241 * risky: they bypass page accounting.
243 TESTPAGEFLAG(Writeback
, writeback
) TESTSCFLAG(Writeback
, writeback
)
244 PAGEFLAG(MappedToDisk
, mappedtodisk
)
246 /* PG_readahead is only used for reads; PG_reclaim is only for writes */
247 PAGEFLAG(Reclaim
, reclaim
) TESTCLEARFLAG(Reclaim
, reclaim
)
248 PAGEFLAG(Readahead
, reclaim
) TESTCLEARFLAG(Readahead
, reclaim
)
250 #ifdef CONFIG_HIGHMEM
252 * Must use a macro here due to header dependency issues. page_zone() is not
253 * available at this point.
255 #define PageHighMem(__p) is_highmem(page_zone(__p))
257 PAGEFLAG_FALSE(HighMem
)
261 PAGEFLAG(SwapCache
, swapcache
)
263 PAGEFLAG_FALSE(SwapCache
)
266 PAGEFLAG(Unevictable
, unevictable
) __CLEARPAGEFLAG(Unevictable
, unevictable
)
267 TESTCLEARFLAG(Unevictable
, unevictable
)
270 PAGEFLAG(Mlocked
, mlocked
) __CLEARPAGEFLAG(Mlocked
, mlocked
)
271 TESTSCFLAG(Mlocked
, mlocked
) __TESTCLEARFLAG(Mlocked
, mlocked
)
273 PAGEFLAG_FALSE(Mlocked
) __CLEARPAGEFLAG_NOOP(Mlocked
)
274 TESTSCFLAG_FALSE(Mlocked
) __TESTCLEARFLAG_FALSE(Mlocked
)
277 #ifdef CONFIG_ARCH_USES_PG_UNCACHED
278 PAGEFLAG(Uncached
, uncached
)
280 PAGEFLAG_FALSE(Uncached
)
283 #ifdef CONFIG_MEMORY_FAILURE
284 PAGEFLAG(HWPoison
, hwpoison
)
285 TESTSCFLAG(HWPoison
, hwpoison
)
286 #define __PG_HWPOISON (1UL << PG_hwpoison)
288 PAGEFLAG_FALSE(HWPoison
)
289 #define __PG_HWPOISON 0
292 u64
stable_page_flags(struct page
*page
);
294 static inline int PageUptodate(struct page
*page
)
296 int ret
= test_bit(PG_uptodate
, &(page
)->flags
);
299 * Must ensure that the data we read out of the page is loaded
300 * _after_ we've loaded page->flags to check for PageUptodate.
301 * We can skip the barrier if the page is not uptodate, because
302 * we wouldn't be reading anything from it.
304 * See SetPageUptodate() for the other side of the story.
312 static inline void __SetPageUptodate(struct page
*page
)
315 __set_bit(PG_uptodate
, &(page
)->flags
);
318 static inline void SetPageUptodate(struct page
*page
)
321 * Memory barrier must be issued before setting the PG_uptodate bit,
322 * so that all previous stores issued in order to bring the page
323 * uptodate are actually visible before PageUptodate becomes true.
326 set_bit(PG_uptodate
, &(page
)->flags
);
329 CLEARPAGEFLAG(Uptodate
, uptodate
)
331 extern void cancel_dirty_page(struct page
*page
, unsigned int account_size
);
333 int test_clear_page_writeback(struct page
*page
);
334 int __test_set_page_writeback(struct page
*page
, bool keep_write
);
336 #define test_set_page_writeback(page) \
337 __test_set_page_writeback(page, false)
338 #define test_set_page_writeback_keepwrite(page) \
339 __test_set_page_writeback(page, true)
341 static inline void set_page_writeback(struct page
*page
)
343 test_set_page_writeback(page
);
346 static inline void set_page_writeback_keepwrite(struct page
*page
)
348 test_set_page_writeback_keepwrite(page
);
351 #ifdef CONFIG_PAGEFLAGS_EXTENDED
353 * System with lots of page flags available. This allows separate
354 * flags for PageHead() and PageTail() checks of compound pages so that bit
355 * tests can be used in performance sensitive paths. PageCompound is
356 * generally not used in hot code paths except arch/powerpc/mm/init_64.c
357 * and arch/powerpc/kvm/book3s_64_vio_hv.c which use it to detect huge pages
358 * and avoid handling those in real mode.
360 __PAGEFLAG(Head
, head
) CLEARPAGEFLAG(Head
, head
)
361 __PAGEFLAG(Tail
, tail
)
363 static inline int PageCompound(struct page
*page
)
365 return page
->flags
& ((1L << PG_head
) | (1L << PG_tail
));
368 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
369 static inline void ClearPageCompound(struct page
*page
)
371 BUG_ON(!PageHead(page
));
376 #define PG_head_mask ((1L << PG_head))
380 * Reduce page flag use as much as possible by overlapping
381 * compound page flags with the flags used for page cache pages. Possible
382 * because PageCompound is always set for compound pages and not for
383 * pages on the LRU and/or pagecache.
385 TESTPAGEFLAG(Compound
, compound
)
386 __SETPAGEFLAG(Head
, compound
) __CLEARPAGEFLAG(Head
, compound
)
389 * PG_reclaim is used in combination with PG_compound to mark the
390 * head and tail of a compound page. This saves one page flag
391 * but makes it impossible to use compound pages for the page cache.
392 * The PG_reclaim bit would have to be used for reclaim or readahead
393 * if compound pages enter the page cache.
395 * PG_compound & PG_reclaim => Tail page
396 * PG_compound & ~PG_reclaim => Head page
398 #define PG_head_mask ((1L << PG_compound))
399 #define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
401 static inline int PageHead(struct page
*page
)
403 return ((page
->flags
& PG_head_tail_mask
) == PG_head_mask
);
406 static inline int PageTail(struct page
*page
)
408 return ((page
->flags
& PG_head_tail_mask
) == PG_head_tail_mask
);
411 static inline void __SetPageTail(struct page
*page
)
413 page
->flags
|= PG_head_tail_mask
;
416 static inline void __ClearPageTail(struct page
*page
)
418 page
->flags
&= ~PG_head_tail_mask
;
421 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
422 static inline void ClearPageCompound(struct page
*page
)
424 BUG_ON((page
->flags
& PG_head_tail_mask
) != (1 << PG_compound
));
425 clear_bit(PG_compound
, &page
->flags
);
429 #endif /* !PAGEFLAGS_EXTENDED */
431 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
433 * PageHuge() only returns true for hugetlbfs pages, but not for
434 * normal or transparent huge pages.
436 * PageTransHuge() returns true for both transparent huge and
437 * hugetlbfs pages, but not normal pages. PageTransHuge() can only be
438 * called only in the core VM paths where hugetlbfs pages can't exist.
440 static inline int PageTransHuge(struct page
*page
)
442 VM_BUG_ON_PAGE(PageTail(page
), page
);
443 return PageHead(page
);
447 * PageTransCompound returns true for both transparent huge pages
448 * and hugetlbfs pages, so it should only be called when it's known
449 * that hugetlbfs pages aren't involved.
451 static inline int PageTransCompound(struct page
*page
)
453 return PageCompound(page
);
457 * PageTransTail returns true for both transparent huge pages
458 * and hugetlbfs pages, so it should only be called when it's known
459 * that hugetlbfs pages aren't involved.
461 static inline int PageTransTail(struct page
*page
)
463 return PageTail(page
);
468 static inline int PageTransHuge(struct page
*page
)
473 static inline int PageTransCompound(struct page
*page
)
478 static inline int PageTransTail(struct page
*page
)
485 * If network-based swap is enabled, sl*b must keep track of whether pages
486 * were allocated from pfmemalloc reserves.
488 static inline int PageSlabPfmemalloc(struct page
*page
)
490 VM_BUG_ON_PAGE(!PageSlab(page
), page
);
491 return PageActive(page
);
494 static inline void SetPageSlabPfmemalloc(struct page
*page
)
496 VM_BUG_ON_PAGE(!PageSlab(page
), page
);
500 static inline void __ClearPageSlabPfmemalloc(struct page
*page
)
502 VM_BUG_ON_PAGE(!PageSlab(page
), page
);
503 __ClearPageActive(page
);
506 static inline void ClearPageSlabPfmemalloc(struct page
*page
)
508 VM_BUG_ON_PAGE(!PageSlab(page
), page
);
509 ClearPageActive(page
);
513 #define __PG_MLOCKED (1 << PG_mlocked)
515 #define __PG_MLOCKED 0
518 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
519 #define __PG_COMPOUND_LOCK (1 << PG_compound_lock)
521 #define __PG_COMPOUND_LOCK 0
525 * Flags checked when a page is freed. Pages being freed should not have
526 * these flags set. It they are, there is a problem.
528 #define PAGE_FLAGS_CHECK_AT_FREE \
529 (1 << PG_lru | 1 << PG_locked | \
530 1 << PG_private | 1 << PG_private_2 | \
531 1 << PG_writeback | 1 << PG_reserved | \
532 1 << PG_slab | 1 << PG_swapcache | 1 << PG_active | \
533 1 << PG_unevictable | __PG_MLOCKED | __PG_HWPOISON | \
537 * Flags checked when a page is prepped for return by the page allocator.
538 * Pages being prepped should not have any flags set. It they are set,
539 * there has been a kernel bug or struct page corruption.
541 #define PAGE_FLAGS_CHECK_AT_PREP ((1 << NR_PAGEFLAGS) - 1)
543 #define PAGE_FLAGS_PRIVATE \
544 (1 << PG_private | 1 << PG_private_2)
546 * page_has_private - Determine if page has private stuff
547 * @page: The page to be checked
549 * Determine if a page has private stuff, indicating that release routines
550 * should be invoked upon it.
552 static inline int page_has_private(struct page
*page
)
554 return !!(page
->flags
& PAGE_FLAGS_PRIVATE
);
557 #endif /* !__GENERATING_BOUNDS_H */
559 #endif /* PAGE_FLAGS_H */
This page took 0.055302 seconds and 5 git commands to generate.