]>
git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/page-flags.h
2 * Macros for manipulating and testing page->flags
8 #include <linux/types.h>
9 #ifndef __GENERATING_BOUNDS_H
10 #include <linux/mm_types.h>
11 #include <linux/bounds.h>
12 #endif /* !__GENERATING_BOUNDS_H */
15 * Various page->flags bits:
17 * PG_reserved is set for special pages, which can never be swapped out. Some
18 * of them might not even exist (eg empty_bad_page)...
20 * The PG_private bitflag is set on pagecache pages if they contain filesystem
21 * specific data (which is normally at page->private). It can be used by
22 * private allocations for its own usage.
24 * During initiation of disk I/O, PG_locked is set. This bit is set before I/O
25 * and cleared when writeback _starts_ or when read _completes_. PG_writeback
26 * is set before writeback starts and cleared when it finishes.
28 * PG_locked also pins a page in pagecache, and blocks truncation of the file
31 * page_waitqueue(page) is a wait queue of all tasks waiting for the page
34 * PG_uptodate tells whether the page's contents is valid. When a read
35 * completes, the page becomes uptodate, unless a disk I/O error happened.
37 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
38 * file-backed pagecache (see mm/vmscan.c).
40 * PG_error is set to indicate that an I/O error occurred on this page.
42 * PG_arch_1 is an architecture specific page state bit. The generic code
43 * guarantees that this bit is cleared for a page when it first is entered into
46 * PG_highmem pages are not permanently mapped into the kernel virtual address
47 * space, they need to be kmapped separately for doing IO on the pages. The
48 * struct page (these bits with information) are always mapped into kernel
51 * PG_buddy is set to indicate that the page is free and in the buddy system
52 * (see mm/page_alloc.c).
57 * Don't use the *_dontuse flags. Use the macros. Otherwise you'll break
58 * locked- and dirty-page accounting.
60 * The page flags field is split into two parts, the main flags area
61 * which extends from the low bits upwards, and the fields area which
62 * extends from the high bits downwards.
64 * | FIELD | ... | FLAGS |
68 * The fields area is reserved for fields mapping zone, node (for NUMA) and
69 * SPARSEMEM section (for variants of SPARSEMEM that require section ids like
70 * SPARSEMEM_EXTREME with !SPARSEMEM_VMEMMAP).
73 PG_locked
, /* Page is locked. Don't touch. */
81 PG_owner_priv_1
, /* Owner use. If pagecache, fs may use*/
84 PG_private
, /* If pagecache, has fs-private data */
85 PG_writeback
, /* Page is under writeback */
86 #ifdef CONFIG_PAGEFLAGS_EXTENDED
87 PG_head
, /* A head page */
88 PG_tail
, /* A tail page */
90 PG_compound
, /* A compound page */
92 PG_swapcache
, /* Swap page: swp_entry_t in private */
93 PG_mappedtodisk
, /* Has blocks allocated on-disk */
94 PG_reclaim
, /* To be reclaimed asap */
95 PG_buddy
, /* Page is free, on buddy lists */
96 PG_swapbacked
, /* Page is backed by RAM/swap */
97 #ifdef CONFIG_UNEVICTABLE_LRU
98 PG_unevictable
, /* Page is "unevictable" */
99 PG_mlocked
, /* Page is vma mlocked */
101 #ifdef CONFIG_IA64_UNCACHED_ALLOCATOR
102 PG_uncached
, /* Page has been mapped as uncached */
107 PG_checked
= PG_owner_priv_1
,
110 PG_pinned
= PG_owner_priv_1
,
111 PG_savepinned
= PG_dirty
,
114 PG_slob_page
= PG_active
,
115 PG_slob_free
= PG_private
,
118 PG_slub_frozen
= PG_active
,
119 PG_slub_debug
= PG_error
,
122 #ifndef __GENERATING_BOUNDS_H
125 * Macros to create function definitions for page flags
127 #define TESTPAGEFLAG(uname, lname) \
128 static inline int Page##uname(struct page *page) \
129 { return test_bit(PG_##lname, &page->flags); }
131 #define SETPAGEFLAG(uname, lname) \
132 static inline void SetPage##uname(struct page *page) \
133 { set_bit(PG_##lname, &page->flags); }
135 #define CLEARPAGEFLAG(uname, lname) \
136 static inline void ClearPage##uname(struct page *page) \
137 { clear_bit(PG_##lname, &page->flags); }
139 #define __SETPAGEFLAG(uname, lname) \
140 static inline void __SetPage##uname(struct page *page) \
141 { __set_bit(PG_##lname, &page->flags); }
143 #define __CLEARPAGEFLAG(uname, lname) \
144 static inline void __ClearPage##uname(struct page *page) \
145 { __clear_bit(PG_##lname, &page->flags); }
147 #define TESTSETFLAG(uname, lname) \
148 static inline int TestSetPage##uname(struct page *page) \
149 { return test_and_set_bit(PG_##lname, &page->flags); }
151 #define TESTCLEARFLAG(uname, lname) \
152 static inline int TestClearPage##uname(struct page *page) \
153 { return test_and_clear_bit(PG_##lname, &page->flags); }
156 #define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
157 SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
159 #define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
160 __SETPAGEFLAG(uname, lname) __CLEARPAGEFLAG(uname, lname)
162 #define PAGEFLAG_FALSE(uname) \
163 static inline int Page##uname(struct page *page) \
166 #define TESTSCFLAG(uname, lname) \
167 TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
169 #define SETPAGEFLAG_NOOP(uname) \
170 static inline void SetPage##uname(struct page *page) { }
172 #define CLEARPAGEFLAG_NOOP(uname) \
173 static inline void ClearPage##uname(struct page *page) { }
175 #define __CLEARPAGEFLAG_NOOP(uname) \
176 static inline void __ClearPage##uname(struct page *page) { }
178 #define TESTCLEARFLAG_FALSE(uname) \
179 static inline int TestClearPage##uname(struct page *page) { return 0; }
181 struct page
; /* forward declaration */
183 TESTPAGEFLAG(Locked
, locked
)
184 PAGEFLAG(Error
, error
)
185 PAGEFLAG(Referenced
, referenced
) TESTCLEARFLAG(Referenced
, referenced
)
186 PAGEFLAG(Dirty
, dirty
) TESTSCFLAG(Dirty
, dirty
) __CLEARPAGEFLAG(Dirty
, dirty
)
187 PAGEFLAG(LRU
, lru
) __CLEARPAGEFLAG(LRU
, lru
)
188 PAGEFLAG(Active
, active
) __CLEARPAGEFLAG(Active
, active
)
189 TESTCLEARFLAG(Active
, active
)
190 __PAGEFLAG(Slab
, slab
)
191 PAGEFLAG(Checked
, checked
) /* Used by some filesystems */
192 PAGEFLAG(Pinned
, pinned
) TESTSCFLAG(Pinned
, pinned
) /* Xen */
193 PAGEFLAG(SavePinned
, savepinned
); /* Xen */
194 PAGEFLAG(Reserved
, reserved
) __CLEARPAGEFLAG(Reserved
, reserved
)
195 PAGEFLAG(Private
, private) __CLEARPAGEFLAG(Private
, private)
196 __SETPAGEFLAG(Private
, private)
197 PAGEFLAG(SwapBacked
, swapbacked
) __CLEARPAGEFLAG(SwapBacked
, swapbacked
)
199 __PAGEFLAG(SlobPage
, slob_page
)
200 __PAGEFLAG(SlobFree
, slob_free
)
202 __PAGEFLAG(SlubFrozen
, slub_frozen
)
203 __PAGEFLAG(SlubDebug
, slub_debug
)
206 * Only test-and-set exist for PG_writeback. The unconditional operators are
207 * risky: they bypass page accounting.
209 TESTPAGEFLAG(Writeback
, writeback
) TESTSCFLAG(Writeback
, writeback
)
210 __PAGEFLAG(Buddy
, buddy
)
211 PAGEFLAG(MappedToDisk
, mappedtodisk
)
213 /* PG_readahead is only used for file reads; PG_reclaim is only for writes */
214 PAGEFLAG(Reclaim
, reclaim
) TESTCLEARFLAG(Reclaim
, reclaim
)
215 PAGEFLAG(Readahead
, reclaim
) /* Reminder to do async read-ahead */
217 #ifdef CONFIG_HIGHMEM
219 * Must use a macro here due to header dependency issues. page_zone() is not
220 * available at this point.
222 #define PageHighMem(__p) is_highmem(page_zone(__p))
224 PAGEFLAG_FALSE(HighMem
)
228 PAGEFLAG(SwapCache
, swapcache
)
230 PAGEFLAG_FALSE(SwapCache
)
231 SETPAGEFLAG_NOOP(SwapCache
) CLEARPAGEFLAG_NOOP(SwapCache
)
234 #ifdef CONFIG_UNEVICTABLE_LRU
235 PAGEFLAG(Unevictable
, unevictable
) __CLEARPAGEFLAG(Unevictable
, unevictable
)
236 TESTCLEARFLAG(Unevictable
, unevictable
)
238 #define MLOCK_PAGES 1
239 PAGEFLAG(Mlocked
, mlocked
) __CLEARPAGEFLAG(Mlocked
, mlocked
)
240 TESTSCFLAG(Mlocked
, mlocked
)
244 #define MLOCK_PAGES 0
245 PAGEFLAG_FALSE(Mlocked
)
246 SETPAGEFLAG_NOOP(Mlocked
) TESTCLEARFLAG_FALSE(Mlocked
)
248 PAGEFLAG_FALSE(Unevictable
) TESTCLEARFLAG_FALSE(Unevictable
)
249 SETPAGEFLAG_NOOP(Unevictable
) CLEARPAGEFLAG_NOOP(Unevictable
)
250 __CLEARPAGEFLAG_NOOP(Unevictable
)
253 #ifdef CONFIG_IA64_UNCACHED_ALLOCATOR
254 PAGEFLAG(Uncached
, uncached
)
256 PAGEFLAG_FALSE(Uncached
)
259 static inline int PageUptodate(struct page
*page
)
261 int ret
= test_bit(PG_uptodate
, &(page
)->flags
);
264 * Must ensure that the data we read out of the page is loaded
265 * _after_ we've loaded page->flags to check for PageUptodate.
266 * We can skip the barrier if the page is not uptodate, because
267 * we wouldn't be reading anything from it.
269 * See SetPageUptodate() for the other side of the story.
277 static inline void __SetPageUptodate(struct page
*page
)
280 __set_bit(PG_uptodate
, &(page
)->flags
);
283 static inline void SetPageUptodate(struct page
*page
)
286 if (!test_and_set_bit(PG_uptodate
, &page
->flags
))
287 page_clear_dirty(page
);
290 * Memory barrier must be issued before setting the PG_uptodate bit,
291 * so that all previous stores issued in order to bring the page
292 * uptodate are actually visible before PageUptodate becomes true.
294 * s390 doesn't need an explicit smp_wmb here because the test and
295 * set bit already provides full barriers.
298 set_bit(PG_uptodate
, &(page
)->flags
);
302 CLEARPAGEFLAG(Uptodate
, uptodate
)
304 extern void cancel_dirty_page(struct page
*page
, unsigned int account_size
);
306 int test_clear_page_writeback(struct page
*page
);
307 int test_set_page_writeback(struct page
*page
);
309 static inline void set_page_writeback(struct page
*page
)
311 test_set_page_writeback(page
);
314 #ifdef CONFIG_PAGEFLAGS_EXTENDED
316 * System with lots of page flags available. This allows separate
317 * flags for PageHead() and PageTail() checks of compound pages so that bit
318 * tests can be used in performance sensitive paths. PageCompound is
319 * generally not used in hot code paths.
321 __PAGEFLAG(Head
, head
)
322 __PAGEFLAG(Tail
, tail
)
324 static inline int PageCompound(struct page
*page
)
326 return page
->flags
& ((1L << PG_head
) | (1L << PG_tail
));
331 * Reduce page flag use as much as possible by overlapping
332 * compound page flags with the flags used for page cache pages. Possible
333 * because PageCompound is always set for compound pages and not for
334 * pages on the LRU and/or pagecache.
336 TESTPAGEFLAG(Compound
, compound
)
337 __PAGEFLAG(Head
, compound
)
340 * PG_reclaim is used in combination with PG_compound to mark the
341 * head and tail of a compound page. This saves one page flag
342 * but makes it impossible to use compound pages for the page cache.
343 * The PG_reclaim bit would have to be used for reclaim or readahead
344 * if compound pages enter the page cache.
346 * PG_compound & PG_reclaim => Tail page
347 * PG_compound & ~PG_reclaim => Head page
349 #define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
351 static inline int PageTail(struct page
*page
)
353 return ((page
->flags
& PG_head_tail_mask
) == PG_head_tail_mask
);
356 static inline void __SetPageTail(struct page
*page
)
358 page
->flags
|= PG_head_tail_mask
;
361 static inline void __ClearPageTail(struct page
*page
)
363 page
->flags
&= ~PG_head_tail_mask
;
366 #endif /* !PAGEFLAGS_EXTENDED */
368 #ifdef CONFIG_UNEVICTABLE_LRU
369 #define __PG_UNEVICTABLE (1 << PG_unevictable)
370 #define __PG_MLOCKED (1 << PG_mlocked)
372 #define __PG_UNEVICTABLE 0
373 #define __PG_MLOCKED 0
377 * Flags checked when a page is freed. Pages being freed should not have
378 * these flags set. It they are, there is a problem.
380 #define PAGE_FLAGS_CHECK_AT_FREE \
381 (1 << PG_lru | 1 << PG_private | 1 << PG_locked | \
382 1 << PG_buddy | 1 << PG_writeback | 1 << PG_reserved | \
383 1 << PG_slab | 1 << PG_swapcache | 1 << PG_active | \
384 __PG_UNEVICTABLE | __PG_MLOCKED)
387 * Flags checked when a page is prepped for return by the page allocator.
388 * Pages being prepped should not have any flags set. It they are set,
389 * there has been a kernel bug or struct page corruption.
391 #define PAGE_FLAGS_CHECK_AT_PREP ((1 << NR_PAGEFLAGS) - 1)
393 #endif /* !__GENERATING_BOUNDS_H */
394 #endif /* PAGE_FLAGS_H */