]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/page-flags.h
mm: return boolean from page_is_file_cache()
[mirror_ubuntu-artful-kernel.git] / include / linux / page-flags.h
CommitLineData
1da177e4
LT
1/*
2 * Macros for manipulating and testing page->flags
3 */
4
5#ifndef PAGE_FLAGS_H
6#define PAGE_FLAGS_H
7
f886ed44 8#include <linux/types.h>
9223b419 9#ifndef __GENERATING_BOUNDS_H
6d777953 10#include <linux/mm_types.h>
9223b419
CL
11#include <linux/bounds.h>
12#endif /* !__GENERATING_BOUNDS_H */
f886ed44 13
1da177e4
LT
14/*
15 * Various page->flags bits:
16 *
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)...
19 *
da6052f7
NP
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.
1da177e4 23 *
da6052f7
NP
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.
27 *
28 * PG_locked also pins a page in pagecache, and blocks truncation of the file
29 * while it is held.
30 *
31 * page_waitqueue(page) is a wait queue of all tasks waiting for the page
32 * to become unlocked.
1da177e4
LT
33 *
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.
36 *
da6052f7
NP
37 * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
38 * file-backed pagecache (see mm/vmscan.c).
1da177e4
LT
39 *
40 * PG_error is set to indicate that an I/O error occurred on this page.
41 *
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
44 * the page cache.
45 *
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
49 * address space...
da6052f7
NP
50 *
51 * PG_buddy is set to indicate that the page is free and in the buddy system
52 * (see mm/page_alloc.c).
53 *
1da177e4
LT
54 */
55
56/*
57 * Don't use the *_dontuse flags. Use the macros. Otherwise you'll break
91fc8ab3
AW
58 * locked- and dirty-page accounting.
59 *
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.
63 *
64 * | FIELD | ... | FLAGS |
9223b419
CL
65 * N-1 ^ 0
66 * (NR_PAGEFLAGS)
91fc8ab3 67 *
9223b419
CL
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).
1da177e4 71 */
e2683181
CL
72enum pageflags {
73 PG_locked, /* Page is locked. Don't touch. */
74 PG_error,
75 PG_referenced,
76 PG_uptodate,
77 PG_dirty,
78 PG_lru,
79 PG_active,
80 PG_slab,
81 PG_owner_priv_1, /* Owner use. If pagecache, fs may use*/
e2683181
CL
82 PG_arch_1,
83 PG_reserved,
84 PG_private, /* If pagecache, has fs-private data */
266cf658 85 PG_private_2, /* If pagecache, has fs aux data */
e2683181 86 PG_writeback, /* Page is under writeback */
e20b8cca
CL
87#ifdef CONFIG_PAGEFLAGS_EXTENDED
88 PG_head, /* A head page */
89 PG_tail, /* A tail page */
90#else
e2683181 91 PG_compound, /* A compound page */
e20b8cca 92#endif
e2683181
CL
93 PG_swapcache, /* Swap page: swp_entry_t in private */
94 PG_mappedtodisk, /* Has blocks allocated on-disk */
95 PG_reclaim, /* To be reclaimed asap */
e2683181 96 PG_buddy, /* Page is free, on buddy lists */
b2e18538 97 PG_swapbacked, /* Page is backed by RAM/swap */
894bc310 98 PG_unevictable, /* Page is "unevictable" */
33925b25 99#ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
b291f000 100 PG_mlocked, /* Page is vma mlocked */
894bc310 101#endif
46cf98cd 102#ifdef CONFIG_ARCH_USES_PG_UNCACHED
602c4d11 103 PG_uncached, /* Page has been mapped as uncached */
f886ed44 104#endif
0cad47cf
AW
105 __NR_PAGEFLAGS,
106
107 /* Filesystems */
108 PG_checked = PG_owner_priv_1,
109
266cf658
DH
110 /* Two page bits are conscripted by FS-Cache to maintain local caching
111 * state. These bits are set on pages belonging to the netfs's inodes
112 * when those inodes are being locally cached.
113 */
114 PG_fscache = PG_private_2, /* page backed by cache */
115
0cad47cf
AW
116 /* XEN */
117 PG_pinned = PG_owner_priv_1,
118 PG_savepinned = PG_dirty,
8a38082d 119
9023cb7e 120 /* SLOB */
9023cb7e
AW
121 PG_slob_free = PG_private,
122
8a38082d
AW
123 /* SLUB */
124 PG_slub_frozen = PG_active,
125 PG_slub_debug = PG_error,
e2683181 126};
1da177e4 127
9223b419
CL
128#ifndef __GENERATING_BOUNDS_H
129
f94a62e9
CL
130/*
131 * Macros to create function definitions for page flags
132 */
133#define TESTPAGEFLAG(uname, lname) \
134static inline int Page##uname(struct page *page) \
135 { return test_bit(PG_##lname, &page->flags); }
136
137#define SETPAGEFLAG(uname, lname) \
138static inline void SetPage##uname(struct page *page) \
139 { set_bit(PG_##lname, &page->flags); }
140
141#define CLEARPAGEFLAG(uname, lname) \
142static inline void ClearPage##uname(struct page *page) \
143 { clear_bit(PG_##lname, &page->flags); }
144
145#define __SETPAGEFLAG(uname, lname) \
146static inline void __SetPage##uname(struct page *page) \
147 { __set_bit(PG_##lname, &page->flags); }
148
149#define __CLEARPAGEFLAG(uname, lname) \
150static inline void __ClearPage##uname(struct page *page) \
151 { __clear_bit(PG_##lname, &page->flags); }
152
153#define TESTSETFLAG(uname, lname) \
154static inline int TestSetPage##uname(struct page *page) \
155 { return test_and_set_bit(PG_##lname, &page->flags); }
156
157#define TESTCLEARFLAG(uname, lname) \
158static inline int TestClearPage##uname(struct page *page) \
159 { return test_and_clear_bit(PG_##lname, &page->flags); }
160
451ea25d
JW
161#define __TESTCLEARFLAG(uname, lname) \
162static inline int __TestClearPage##uname(struct page *page) \
163 { return __test_and_clear_bit(PG_##lname, &page->flags); }
f94a62e9
CL
164
165#define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
166 SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
167
168#define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname) \
169 __SETPAGEFLAG(uname, lname) __CLEARPAGEFLAG(uname, lname)
170
ec7cade8
CL
171#define PAGEFLAG_FALSE(uname) \
172static inline int Page##uname(struct page *page) \
173 { return 0; }
174
f94a62e9
CL
175#define TESTSCFLAG(uname, lname) \
176 TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
177
8a7a8544
LS
178#define SETPAGEFLAG_NOOP(uname) \
179static inline void SetPage##uname(struct page *page) { }
180
181#define CLEARPAGEFLAG_NOOP(uname) \
182static inline void ClearPage##uname(struct page *page) { }
183
184#define __CLEARPAGEFLAG_NOOP(uname) \
185static inline void __ClearPage##uname(struct page *page) { }
186
187#define TESTCLEARFLAG_FALSE(uname) \
188static inline int TestClearPage##uname(struct page *page) { return 0; }
189
451ea25d
JW
190#define __TESTCLEARFLAG_FALSE(uname) \
191static inline int __TestClearPage##uname(struct page *page) { return 0; }
192
6a1e7f77
CL
193struct page; /* forward declaration */
194
03fb3d2a 195TESTPAGEFLAG(Locked, locked) TESTSETFLAG(Locked, locked)
6a1e7f77
CL
196PAGEFLAG(Error, error)
197PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
198PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
199PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
200PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
894bc310 201 TESTCLEARFLAG(Active, active)
6a1e7f77 202__PAGEFLAG(Slab, slab)
0cad47cf
AW
203PAGEFLAG(Checked, checked) /* Used by some filesystems */
204PAGEFLAG(Pinned, pinned) TESTSCFLAG(Pinned, pinned) /* Xen */
205PAGEFLAG(SavePinned, savepinned); /* Xen */
6a1e7f77 206PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
b2e18538 207PAGEFLAG(SwapBacked, swapbacked) __CLEARPAGEFLAG(SwapBacked, swapbacked)
6a1e7f77 208
9023cb7e
AW
209__PAGEFLAG(SlobFree, slob_free)
210
8a38082d
AW
211__PAGEFLAG(SlubFrozen, slub_frozen)
212__PAGEFLAG(SlubDebug, slub_debug)
213
266cf658
DH
214/*
215 * Private page markings that may be used by the filesystem that owns the page
216 * for its own purposes.
217 * - PG_private and PG_private_2 cause releasepage() and co to be invoked
218 */
219PAGEFLAG(Private, private) __SETPAGEFLAG(Private, private)
220 __CLEARPAGEFLAG(Private, private)
221PAGEFLAG(Private2, private_2) TESTSCFLAG(Private2, private_2)
222PAGEFLAG(OwnerPriv1, owner_priv_1) TESTCLEARFLAG(OwnerPriv1, owner_priv_1)
223
6a1e7f77
CL
224/*
225 * Only test-and-set exist for PG_writeback. The unconditional operators are
226 * risky: they bypass page accounting.
227 */
228TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
229__PAGEFLAG(Buddy, buddy)
230PAGEFLAG(MappedToDisk, mappedtodisk)
231
232/* PG_readahead is only used for file reads; PG_reclaim is only for writes */
233PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
0a128b2b 234PAGEFLAG(Readahead, reclaim) /* Reminder to do async read-ahead */
6a1e7f77
CL
235
236#ifdef CONFIG_HIGHMEM
1da177e4 237/*
6a1e7f77
CL
238 * Must use a macro here due to header dependency issues. page_zone() is not
239 * available at this point.
1da177e4 240 */
0a128b2b 241#define PageHighMem(__p) is_highmem(page_zone(__p))
6a1e7f77 242#else
ec7cade8 243PAGEFLAG_FALSE(HighMem)
6a1e7f77
CL
244#endif
245
246#ifdef CONFIG_SWAP
247PAGEFLAG(SwapCache, swapcache)
248#else
ec7cade8 249PAGEFLAG_FALSE(SwapCache)
6d91add0 250 SETPAGEFLAG_NOOP(SwapCache) CLEARPAGEFLAG_NOOP(SwapCache)
6a1e7f77
CL
251#endif
252
894bc310
LS
253PAGEFLAG(Unevictable, unevictable) __CLEARPAGEFLAG(Unevictable, unevictable)
254 TESTCLEARFLAG(Unevictable, unevictable)
b291f000 255
33925b25 256#ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
b291f000
NP
257#define MLOCK_PAGES 1
258PAGEFLAG(Mlocked, mlocked) __CLEARPAGEFLAG(Mlocked, mlocked)
451ea25d 259 TESTSCFLAG(Mlocked, mlocked) __TESTCLEARFLAG(Mlocked, mlocked)
894bc310 260#else
b291f000 261#define MLOCK_PAGES 0
451ea25d
JW
262PAGEFLAG_FALSE(Mlocked) SETPAGEFLAG_NOOP(Mlocked)
263 TESTCLEARFLAG_FALSE(Mlocked) __TESTCLEARFLAG_FALSE(Mlocked)
894bc310
LS
264#endif
265
46cf98cd 266#ifdef CONFIG_ARCH_USES_PG_UNCACHED
6a1e7f77 267PAGEFLAG(Uncached, uncached)
602c4d11 268#else
ec7cade8 269PAGEFLAG_FALSE(Uncached)
6a1e7f77 270#endif
1da177e4 271
0ed361de
NP
272static inline int PageUptodate(struct page *page)
273{
274 int ret = test_bit(PG_uptodate, &(page)->flags);
275
276 /*
277 * Must ensure that the data we read out of the page is loaded
278 * _after_ we've loaded page->flags to check for PageUptodate.
279 * We can skip the barrier if the page is not uptodate, because
280 * we wouldn't be reading anything from it.
281 *
282 * See SetPageUptodate() for the other side of the story.
283 */
284 if (ret)
285 smp_rmb();
286
287 return ret;
288}
289
290static inline void __SetPageUptodate(struct page *page)
291{
292 smp_wmb();
293 __set_bit(PG_uptodate, &(page)->flags);
0ed361de
NP
294}
295
2dcea57a
HC
296static inline void SetPageUptodate(struct page *page)
297{
0ed361de 298#ifdef CONFIG_S390
2dcea57a 299 if (!test_and_set_bit(PG_uptodate, &page->flags))
6c210482 300 page_clear_dirty(page);
f6ac2354 301#else
0ed361de
NP
302 /*
303 * Memory barrier must be issued before setting the PG_uptodate bit,
304 * so that all previous stores issued in order to bring the page
305 * uptodate are actually visible before PageUptodate becomes true.
306 *
307 * s390 doesn't need an explicit smp_wmb here because the test and
308 * set bit already provides full barriers.
309 */
310 smp_wmb();
311 set_bit(PG_uptodate, &(page)->flags);
1da177e4 312#endif
0ed361de
NP
313}
314
6a1e7f77 315CLEARPAGEFLAG(Uptodate, uptodate)
1da177e4 316
6a1e7f77 317extern void cancel_dirty_page(struct page *page, unsigned int account_size);
d77c2d7c 318
6a1e7f77
CL
319int test_clear_page_writeback(struct page *page);
320int test_set_page_writeback(struct page *page);
1da177e4 321
6a1e7f77
CL
322static inline void set_page_writeback(struct page *page)
323{
324 test_set_page_writeback(page);
325}
1da177e4 326
e20b8cca
CL
327#ifdef CONFIG_PAGEFLAGS_EXTENDED
328/*
329 * System with lots of page flags available. This allows separate
330 * flags for PageHead() and PageTail() checks of compound pages so that bit
331 * tests can be used in performance sensitive paths. PageCompound is
332 * generally not used in hot code paths.
333 */
334__PAGEFLAG(Head, head)
335__PAGEFLAG(Tail, tail)
336
337static inline int PageCompound(struct page *page)
338{
339 return page->flags & ((1L << PG_head) | (1L << PG_tail));
340
341}
342#else
343/*
344 * Reduce page flag use as much as possible by overlapping
345 * compound page flags with the flags used for page cache pages. Possible
346 * because PageCompound is always set for compound pages and not for
347 * pages on the LRU and/or pagecache.
348 */
6a1e7f77
CL
349TESTPAGEFLAG(Compound, compound)
350__PAGEFLAG(Head, compound)
1da177e4 351
d85f3385 352/*
6d777953 353 * PG_reclaim is used in combination with PG_compound to mark the
6a1e7f77
CL
354 * head and tail of a compound page. This saves one page flag
355 * but makes it impossible to use compound pages for the page cache.
356 * The PG_reclaim bit would have to be used for reclaim or readahead
357 * if compound pages enter the page cache.
6d777953
CL
358 *
359 * PG_compound & PG_reclaim => Tail page
360 * PG_compound & ~PG_reclaim => Head page
d85f3385 361 */
6d777953
CL
362#define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
363
6a1e7f77
CL
364static inline int PageTail(struct page *page)
365{
366 return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
367}
6d777953
CL
368
369static inline void __SetPageTail(struct page *page)
370{
371 page->flags |= PG_head_tail_mask;
372}
373
374static inline void __ClearPageTail(struct page *page)
375{
376 page->flags &= ~PG_head_tail_mask;
377}
378
e20b8cca 379#endif /* !PAGEFLAGS_EXTENDED */
dfa7e20c 380
33925b25
DH
381#ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
382#define __PG_MLOCKED (1 << PG_mlocked)
383#else
b291f000 384#define __PG_MLOCKED 0
894bc310
LS
385#endif
386
dfa7e20c
RA
387/*
388 * Flags checked when a page is freed. Pages being freed should not have
389 * these flags set. It they are, there is a problem.
390 */
79f4b7bf 391#define PAGE_FLAGS_CHECK_AT_FREE \
266cf658
DH
392 (1 << PG_lru | 1 << PG_locked | \
393 1 << PG_private | 1 << PG_private_2 | \
394 1 << PG_buddy | 1 << PG_writeback | 1 << PG_reserved | \
395 1 << PG_slab | 1 << PG_swapcache | 1 << PG_active | \
68377659 396 1 << PG_unevictable | __PG_MLOCKED)
dfa7e20c
RA
397
398/*
399 * Flags checked when a page is prepped for return by the page allocator.
79f4b7bf
HD
400 * Pages being prepped should not have any flags set. It they are set,
401 * there has been a kernel bug or struct page corruption.
dfa7e20c 402 */
79f4b7bf 403#define PAGE_FLAGS_CHECK_AT_PREP ((1 << NR_PAGEFLAGS) - 1)
dfa7e20c 404
9223b419 405#endif /* !__GENERATING_BOUNDS_H */
266cf658
DH
406
407/**
408 * page_has_private - Determine if page has private stuff
409 * @page: The page to be checked
410 *
411 * Determine if a page has private stuff, indicating that release routines
412 * should be invoked upon it.
413 */
414#define page_has_private(page) \
415 ((page)->flags & ((1 << PG_private) | \
416 (1 << PG_private_2)))
417
1da177e4 418#endif /* PAGE_FLAGS_H */