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