9d99e7471ade199000dd9001c122c17062c733f2
[linux-2.6.git] / include / linux / page-flags.h
1 /*
2  * Macros for manipulating and testing page->flags
3  */
4
5 #ifndef PAGE_FLAGS_H
6 #define PAGE_FLAGS_H
7
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 */
13
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  *
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.
23  *
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.
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  *
37  * PG_referenced, PG_reclaim are used for page reclaim for anonymous and
38  * file-backed pagecache (see mm/vmscan.c).
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...
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  *
54  */
55
56 /*
57  * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
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 |
65  *  N-1           ^       0
66  *               (NR_PAGEFLAGS)
67  *
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).
71  */
72 enum 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*/
82         PG_arch_1,
83         PG_reserved,
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 */
89 #else
90         PG_compound,            /* A compound page */
91 #endif
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 #endif
100 #ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
101         PG_mlocked,             /* Page is vma mlocked */
102 #endif
103 #ifdef CONFIG_IA64_UNCACHED_ALLOCATOR
104         PG_uncached,            /* Page has been mapped as uncached */
105 #endif
106         __NR_PAGEFLAGS,
107
108         /* Filesystems */
109         PG_checked = PG_owner_priv_1,
110
111         /* XEN */
112         PG_pinned = PG_owner_priv_1,
113         PG_savepinned = PG_dirty,
114
115         /* SLOB */
116         PG_slob_page = PG_active,
117         PG_slob_free = PG_private,
118
119         /* SLUB */
120         PG_slub_frozen = PG_active,
121         PG_slub_debug = PG_error,
122 };
123
124 #ifndef __GENERATING_BOUNDS_H
125
126 /*
127  * Macros to create function definitions for page flags
128  */
129 #define TESTPAGEFLAG(uname, lname)                                      \
130 static inline int Page##uname(struct page *page)                        \
131                         { return test_bit(PG_##lname, &page->flags); }
132
133 #define SETPAGEFLAG(uname, lname)                                       \
134 static inline void SetPage##uname(struct page *page)                    \
135                         { set_bit(PG_##lname, &page->flags); }
136
137 #define CLEARPAGEFLAG(uname, lname)                                     \
138 static inline void ClearPage##uname(struct page *page)                  \
139                         { clear_bit(PG_##lname, &page->flags); }
140
141 #define __SETPAGEFLAG(uname, lname)                                     \
142 static inline void __SetPage##uname(struct page *page)                  \
143                         { __set_bit(PG_##lname, &page->flags); }
144
145 #define __CLEARPAGEFLAG(uname, lname)                                   \
146 static inline void __ClearPage##uname(struct page *page)                \
147                         { __clear_bit(PG_##lname, &page->flags); }
148
149 #define TESTSETFLAG(uname, lname)                                       \
150 static inline int TestSetPage##uname(struct page *page)                 \
151                 { return test_and_set_bit(PG_##lname, &page->flags); }
152
153 #define TESTCLEARFLAG(uname, lname)                                     \
154 static inline int TestClearPage##uname(struct page *page)               \
155                 { return test_and_clear_bit(PG_##lname, &page->flags); }
156
157
158 #define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)               \
159         SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
160
161 #define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)             \
162         __SETPAGEFLAG(uname, lname)  __CLEARPAGEFLAG(uname, lname)
163
164 #define PAGEFLAG_FALSE(uname)                                           \
165 static inline int Page##uname(struct page *page)                        \
166                         { return 0; }
167
168 #define TESTSCFLAG(uname, lname)                                        \
169         TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
170
171 #define SETPAGEFLAG_NOOP(uname)                                         \
172 static inline void SetPage##uname(struct page *page) {  }
173
174 #define CLEARPAGEFLAG_NOOP(uname)                                       \
175 static inline void ClearPage##uname(struct page *page) {  }
176
177 #define __CLEARPAGEFLAG_NOOP(uname)                                     \
178 static inline void __ClearPage##uname(struct page *page) {  }
179
180 #define TESTCLEARFLAG_FALSE(uname)                                      \
181 static inline int TestClearPage##uname(struct page *page) { return 0; }
182
183 struct page;    /* forward declaration */
184
185 TESTPAGEFLAG(Locked, locked) TESTSETFLAG(Locked, locked)
186 PAGEFLAG(Error, error)
187 PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
188 PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
189 PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
190 PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
191         TESTCLEARFLAG(Active, active)
192 __PAGEFLAG(Slab, slab)
193 PAGEFLAG(Checked, checked)              /* Used by some filesystems */
194 PAGEFLAG(Pinned, pinned) TESTSCFLAG(Pinned, pinned)     /* Xen */
195 PAGEFLAG(SavePinned, savepinned);                       /* Xen */
196 PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
197 PAGEFLAG(Private, private) __CLEARPAGEFLAG(Private, private)
198         __SETPAGEFLAG(Private, private)
199 PAGEFLAG(SwapBacked, swapbacked) __CLEARPAGEFLAG(SwapBacked, swapbacked)
200
201 __PAGEFLAG(SlobPage, slob_page)
202 __PAGEFLAG(SlobFree, slob_free)
203
204 __PAGEFLAG(SlubFrozen, slub_frozen)
205 __PAGEFLAG(SlubDebug, slub_debug)
206
207 /*
208  * Only test-and-set exist for PG_writeback.  The unconditional operators are
209  * risky: they bypass page accounting.
210  */
211 TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
212 __PAGEFLAG(Buddy, buddy)
213 PAGEFLAG(MappedToDisk, mappedtodisk)
214
215 /* PG_readahead is only used for file reads; PG_reclaim is only for writes */
216 PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
217 PAGEFLAG(Readahead, reclaim)            /* Reminder to do async read-ahead */
218
219 #ifdef CONFIG_HIGHMEM
220 /*
221  * Must use a macro here due to header dependency issues. page_zone() is not
222  * available at this point.
223  */
224 #define PageHighMem(__p) is_highmem(page_zone(__p))
225 #else
226 PAGEFLAG_FALSE(HighMem)
227 #endif
228
229 #ifdef CONFIG_SWAP
230 PAGEFLAG(SwapCache, swapcache)
231 #else
232 PAGEFLAG_FALSE(SwapCache)
233         SETPAGEFLAG_NOOP(SwapCache) CLEARPAGEFLAG_NOOP(SwapCache)
234 #endif
235
236 #ifdef CONFIG_UNEVICTABLE_LRU
237 PAGEFLAG(Unevictable, unevictable) __CLEARPAGEFLAG(Unevictable, unevictable)
238         TESTCLEARFLAG(Unevictable, unevictable)
239 #else
240 PAGEFLAG_FALSE(Unevictable) TESTCLEARFLAG_FALSE(Unevictable)
241         SETPAGEFLAG_NOOP(Unevictable) CLEARPAGEFLAG_NOOP(Unevictable)
242         __CLEARPAGEFLAG_NOOP(Unevictable)
243 #endif
244
245 #ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
246 #define MLOCK_PAGES 1
247 PAGEFLAG(Mlocked, mlocked) __CLEARPAGEFLAG(Mlocked, mlocked)
248         TESTSCFLAG(Mlocked, mlocked)
249 #else
250 #define MLOCK_PAGES 0
251 PAGEFLAG_FALSE(Mlocked)
252         SETPAGEFLAG_NOOP(Mlocked) TESTCLEARFLAG_FALSE(Mlocked)
253 #endif
254
255 #ifdef CONFIG_IA64_UNCACHED_ALLOCATOR
256 PAGEFLAG(Uncached, uncached)
257 #else
258 PAGEFLAG_FALSE(Uncached)
259 #endif
260
261 static inline int PageUptodate(struct page *page)
262 {
263         int ret = test_bit(PG_uptodate, &(page)->flags);
264
265         /*
266          * Must ensure that the data we read out of the page is loaded
267          * _after_ we've loaded page->flags to check for PageUptodate.
268          * We can skip the barrier if the page is not uptodate, because
269          * we wouldn't be reading anything from it.
270          *
271          * See SetPageUptodate() for the other side of the story.
272          */
273         if (ret)
274                 smp_rmb();
275
276         return ret;
277 }
278
279 static inline void __SetPageUptodate(struct page *page)
280 {
281         smp_wmb();
282         __set_bit(PG_uptodate, &(page)->flags);
283 }
284
285 static inline void SetPageUptodate(struct page *page)
286 {
287 #ifdef CONFIG_S390
288         if (!test_and_set_bit(PG_uptodate, &page->flags))
289                 page_clear_dirty(page);
290 #else
291         /*
292          * Memory barrier must be issued before setting the PG_uptodate bit,
293          * so that all previous stores issued in order to bring the page
294          * uptodate are actually visible before PageUptodate becomes true.
295          *
296          * s390 doesn't need an explicit smp_wmb here because the test and
297          * set bit already provides full barriers.
298          */
299         smp_wmb();
300         set_bit(PG_uptodate, &(page)->flags);
301 #endif
302 }
303
304 CLEARPAGEFLAG(Uptodate, uptodate)
305
306 extern void cancel_dirty_page(struct page *page, unsigned int account_size);
307
308 int test_clear_page_writeback(struct page *page);
309 int test_set_page_writeback(struct page *page);
310
311 static inline void set_page_writeback(struct page *page)
312 {
313         test_set_page_writeback(page);
314 }
315
316 #ifdef CONFIG_PAGEFLAGS_EXTENDED
317 /*
318  * System with lots of page flags available. This allows separate
319  * flags for PageHead() and PageTail() checks of compound pages so that bit
320  * tests can be used in performance sensitive paths. PageCompound is
321  * generally not used in hot code paths.
322  */
323 __PAGEFLAG(Head, head)
324 __PAGEFLAG(Tail, tail)
325
326 static inline int PageCompound(struct page *page)
327 {
328         return page->flags & ((1L << PG_head) | (1L << PG_tail));
329
330 }
331 #else
332 /*
333  * Reduce page flag use as much as possible by overlapping
334  * compound page flags with the flags used for page cache pages. Possible
335  * because PageCompound is always set for compound pages and not for
336  * pages on the LRU and/or pagecache.
337  */
338 TESTPAGEFLAG(Compound, compound)
339 __PAGEFLAG(Head, compound)
340
341 /*
342  * PG_reclaim is used in combination with PG_compound to mark the
343  * head and tail of a compound page. This saves one page flag
344  * but makes it impossible to use compound pages for the page cache.
345  * The PG_reclaim bit would have to be used for reclaim or readahead
346  * if compound pages enter the page cache.
347  *
348  * PG_compound & PG_reclaim     => Tail page
349  * PG_compound & ~PG_reclaim    => Head page
350  */
351 #define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
352
353 static inline int PageTail(struct page *page)
354 {
355         return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
356 }
357
358 static inline void __SetPageTail(struct page *page)
359 {
360         page->flags |= PG_head_tail_mask;
361 }
362
363 static inline void __ClearPageTail(struct page *page)
364 {
365         page->flags &= ~PG_head_tail_mask;
366 }
367
368 #endif /* !PAGEFLAGS_EXTENDED */
369
370 #ifdef CONFIG_UNEVICTABLE_LRU
371 #define __PG_UNEVICTABLE        (1 << PG_unevictable)
372 #else
373 #define __PG_UNEVICTABLE        0
374 #endif
375
376 #ifdef CONFIG_HAVE_MLOCKED_PAGE_BIT
377 #define __PG_MLOCKED            (1 << PG_mlocked)
378 #else
379 #define __PG_MLOCKED            0
380 #endif
381
382 /*
383  * Flags checked when a page is freed.  Pages being freed should not have
384  * these flags set.  It they are, there is a problem.
385  */
386 #define PAGE_FLAGS_CHECK_AT_FREE \
387         (1 << PG_lru   | 1 << PG_private   | 1 << PG_locked | \
388          1 << PG_buddy | 1 << PG_writeback | 1 << PG_reserved | \
389          1 << PG_slab  | 1 << PG_swapcache | 1 << PG_active | \
390          __PG_UNEVICTABLE | __PG_MLOCKED)
391
392 /*
393  * Flags checked when a page is prepped for return by the page allocator.
394  * Pages being prepped should not have any flags set.  It they are set,
395  * there has been a kernel bug or struct page corruption.
396  */
397 #define PAGE_FLAGS_CHECK_AT_PREP        ((1 << NR_PAGEFLAGS) - 1)
398
399 #endif /* !__GENERATING_BOUNDS_H */
400 #endif  /* PAGE_FLAGS_H */