[PATCH] mm: page_state opt
[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/percpu.h>
9 #include <linux/cache.h>
10 #include <asm/pgtable.h>
11
12 /*
13  * Various page->flags bits:
14  *
15  * PG_reserved is set for special pages, which can never be swapped out. Some
16  * of them might not even exist (eg empty_bad_page)...
17  *
18  * The PG_private bitflag is set if page->private contains a valid value.
19  *
20  * During disk I/O, PG_locked is used. This bit is set before I/O and
21  * reset when I/O completes. page_waitqueue(page) is a wait queue of all tasks
22  * waiting for the I/O on this page to complete.
23  *
24  * PG_uptodate tells whether the page's contents is valid.  When a read
25  * completes, the page becomes uptodate, unless a disk I/O error happened.
26  *
27  * For choosing which pages to swap out, inode pages carry a PG_referenced bit,
28  * which is set any time the system accesses that page through the (mapping,
29  * index) hash table.  This referenced bit, together with the referenced bit
30  * in the page tables, is used to manipulate page->age and move the page across
31  * the active, inactive_dirty and inactive_clean lists.
32  *
33  * Note that the referenced bit, the page->lru list_head and the active,
34  * inactive_dirty and inactive_clean lists are protected by the
35  * zone->lru_lock, and *NOT* by the usual PG_locked bit!
36  *
37  * PG_error is set to indicate that an I/O error occurred on this page.
38  *
39  * PG_arch_1 is an architecture specific page state bit.  The generic code
40  * guarantees that this bit is cleared for a page when it first is entered into
41  * the page cache.
42  *
43  * PG_highmem pages are not permanently mapped into the kernel virtual address
44  * space, they need to be kmapped separately for doing IO on the pages.  The
45  * struct page (these bits with information) are always mapped into kernel
46  * address space...
47  */
48
49 /*
50  * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
51  * locked- and dirty-page accounting.  The top eight bits of page->flags are
52  * used for page->zone, so putting flag bits there doesn't work.
53  */
54 #define PG_locked                0      /* Page is locked. Don't touch. */
55 #define PG_error                 1
56 #define PG_referenced            2
57 #define PG_uptodate              3
58
59 #define PG_dirty                 4
60 #define PG_lru                   5
61 #define PG_active                6
62 #define PG_slab                  7      /* slab debug (Suparna wants this) */
63
64 #define PG_checked               8      /* kill me in 2.5.<early>. */
65 #define PG_arch_1                9
66 #define PG_reserved             10
67 #define PG_private              11      /* Has something at ->private */
68
69 #define PG_writeback            12      /* Page is under writeback */
70 #define PG_nosave               13      /* Used for system suspend/resume */
71 #define PG_compound             14      /* Part of a compound page */
72 #define PG_swapcache            15      /* Swap page: swp_entry_t in private */
73
74 #define PG_mappedtodisk         16      /* Has blocks allocated on-disk */
75 #define PG_reclaim              17      /* To be reclaimed asap */
76 #define PG_nosave_free          18      /* Free, should not be written */
77 #define PG_uncached             19      /* Page has been mapped as uncached */
78
79 /*
80  * Global page accounting.  One instance per CPU.  Only unsigned longs are
81  * allowed.
82  */
83 struct page_state {
84         unsigned long nr_dirty;         /* Dirty writeable pages */
85         unsigned long nr_writeback;     /* Pages under writeback */
86         unsigned long nr_unstable;      /* NFS unstable pages */
87         unsigned long nr_page_table_pages;/* Pages used for pagetables */
88         unsigned long nr_mapped;        /* mapped into pagetables */
89         unsigned long nr_slab;          /* In slab */
90 #define GET_PAGE_STATE_LAST nr_slab
91
92         /*
93          * The below are zeroed by get_page_state().  Use get_full_page_state()
94          * to add up all these.
95          */
96         unsigned long pgpgin;           /* Disk reads */
97         unsigned long pgpgout;          /* Disk writes */
98         unsigned long pswpin;           /* swap reads */
99         unsigned long pswpout;          /* swap writes */
100
101         unsigned long pgalloc_high;     /* page allocations */
102         unsigned long pgalloc_normal;
103         unsigned long pgalloc_dma32;
104         unsigned long pgalloc_dma;
105
106         unsigned long pgfree;           /* page freeings */
107         unsigned long pgactivate;       /* pages moved inactive->active */
108         unsigned long pgdeactivate;     /* pages moved active->inactive */
109
110         unsigned long pgfault;          /* faults (major+minor) */
111         unsigned long pgmajfault;       /* faults (major only) */
112
113         unsigned long pgrefill_high;    /* inspected in refill_inactive_zone */
114         unsigned long pgrefill_normal;
115         unsigned long pgrefill_dma32;
116         unsigned long pgrefill_dma;
117
118         unsigned long pgsteal_high;     /* total highmem pages reclaimed */
119         unsigned long pgsteal_normal;
120         unsigned long pgsteal_dma32;
121         unsigned long pgsteal_dma;
122
123         unsigned long pgscan_kswapd_high;/* total highmem pages scanned */
124         unsigned long pgscan_kswapd_normal;
125         unsigned long pgscan_kswapd_dma32;
126         unsigned long pgscan_kswapd_dma;
127
128         unsigned long pgscan_direct_high;/* total highmem pages scanned */
129         unsigned long pgscan_direct_normal;
130         unsigned long pgscan_direct_dma32;
131         unsigned long pgscan_direct_dma;
132
133         unsigned long pginodesteal;     /* pages reclaimed via inode freeing */
134         unsigned long slabs_scanned;    /* slab objects scanned */
135         unsigned long kswapd_steal;     /* pages reclaimed by kswapd */
136         unsigned long kswapd_inodesteal;/* reclaimed via kswapd inode freeing */
137         unsigned long pageoutrun;       /* kswapd's calls to page reclaim */
138         unsigned long allocstall;       /* direct reclaim calls */
139
140         unsigned long pgrotated;        /* pages rotated to tail of the LRU */
141         unsigned long nr_bounce;        /* pages for bounce buffers */
142 };
143
144 extern void get_page_state(struct page_state *ret);
145 extern void get_page_state_node(struct page_state *ret, int node);
146 extern void get_full_page_state(struct page_state *ret);
147 extern unsigned long read_page_state_offset(unsigned long offset);
148 extern void mod_page_state_offset(unsigned long offset, unsigned long delta);
149 extern void __mod_page_state_offset(unsigned long offset, unsigned long delta);
150
151 #define read_page_state(member) \
152         read_page_state_offset(offsetof(struct page_state, member))
153
154 #define mod_page_state(member, delta)   \
155         mod_page_state_offset(offsetof(struct page_state, member), (delta))
156
157 #define __mod_page_state(member, delta) \
158         __mod_page_state_offset(offsetof(struct page_state, member), (delta))
159
160 #define inc_page_state(member)          mod_page_state(member, 1UL)
161 #define dec_page_state(member)          mod_page_state(member, 0UL - 1)
162 #define add_page_state(member,delta)    mod_page_state(member, (delta))
163 #define sub_page_state(member,delta)    mod_page_state(member, 0UL - (delta))
164
165 #define __inc_page_state(member)        __mod_page_state(member, 1UL)
166 #define __dec_page_state(member)        __mod_page_state(member, 0UL - 1)
167 #define __add_page_state(member,delta)  __mod_page_state(member, (delta))
168 #define __sub_page_state(member,delta)  __mod_page_state(member, 0UL - (delta))
169
170 #define page_state(member) (*__page_state(offsetof(struct page_state, member)))
171
172 #define state_zone_offset(zone, member)                                 \
173 ({                                                                      \
174         unsigned offset;                                                \
175         if (is_highmem(zone))                                           \
176                 offset = offsetof(struct page_state, member##_high);    \
177         else if (is_normal(zone))                                       \
178                 offset = offsetof(struct page_state, member##_normal);  \
179         else if (is_dma32(zone))                                        \
180                 offset = offsetof(struct page_state, member##_dma32);   \
181         else                                                            \
182                 offset = offsetof(struct page_state, member##_dma);     \
183         offset;                                                         \
184 })
185
186 #define __mod_page_state_zone(zone, member, delta)                      \
187  do {                                                                   \
188         __mod_page_state_offset(state_zone_offset(zone, member), (delta)); \
189  } while (0)
190
191 #define mod_page_state_zone(zone, member, delta)                        \
192  do {                                                                   \
193         mod_page_state_offset(state_zone_offset(zone, member), (delta)); \
194  } while (0)
195
196 /*
197  * Manipulation of page state flags
198  */
199 #define PageLocked(page)                \
200                 test_bit(PG_locked, &(page)->flags)
201 #define SetPageLocked(page)             \
202                 set_bit(PG_locked, &(page)->flags)
203 #define TestSetPageLocked(page)         \
204                 test_and_set_bit(PG_locked, &(page)->flags)
205 #define ClearPageLocked(page)           \
206                 clear_bit(PG_locked, &(page)->flags)
207 #define TestClearPageLocked(page)       \
208                 test_and_clear_bit(PG_locked, &(page)->flags)
209
210 #define PageError(page)         test_bit(PG_error, &(page)->flags)
211 #define SetPageError(page)      set_bit(PG_error, &(page)->flags)
212 #define ClearPageError(page)    clear_bit(PG_error, &(page)->flags)
213
214 #define PageReferenced(page)    test_bit(PG_referenced, &(page)->flags)
215 #define SetPageReferenced(page) set_bit(PG_referenced, &(page)->flags)
216 #define ClearPageReferenced(page)       clear_bit(PG_referenced, &(page)->flags)
217 #define TestClearPageReferenced(page) test_and_clear_bit(PG_referenced, &(page)->flags)
218
219 #define PageUptodate(page)      test_bit(PG_uptodate, &(page)->flags)
220 #ifndef SetPageUptodate
221 #define SetPageUptodate(page)   set_bit(PG_uptodate, &(page)->flags)
222 #endif
223 #define ClearPageUptodate(page) clear_bit(PG_uptodate, &(page)->flags)
224
225 #define PageDirty(page)         test_bit(PG_dirty, &(page)->flags)
226 #define SetPageDirty(page)      set_bit(PG_dirty, &(page)->flags)
227 #define TestSetPageDirty(page)  test_and_set_bit(PG_dirty, &(page)->flags)
228 #define ClearPageDirty(page)    clear_bit(PG_dirty, &(page)->flags)
229 #define __ClearPageDirty(page)  __clear_bit(PG_dirty, &(page)->flags)
230 #define TestClearPageDirty(page) test_and_clear_bit(PG_dirty, &(page)->flags)
231
232 #define SetPageLRU(page)        set_bit(PG_lru, &(page)->flags)
233 #define PageLRU(page)           test_bit(PG_lru, &(page)->flags)
234 #define TestSetPageLRU(page)    test_and_set_bit(PG_lru, &(page)->flags)
235 #define TestClearPageLRU(page)  test_and_clear_bit(PG_lru, &(page)->flags)
236
237 #define PageActive(page)        test_bit(PG_active, &(page)->flags)
238 #define SetPageActive(page)     set_bit(PG_active, &(page)->flags)
239 #define ClearPageActive(page)   clear_bit(PG_active, &(page)->flags)
240 #define TestClearPageActive(page) test_and_clear_bit(PG_active, &(page)->flags)
241 #define TestSetPageActive(page) test_and_set_bit(PG_active, &(page)->flags)
242
243 #define PageSlab(page)          test_bit(PG_slab, &(page)->flags)
244 #define SetPageSlab(page)       set_bit(PG_slab, &(page)->flags)
245 #define ClearPageSlab(page)     clear_bit(PG_slab, &(page)->flags)
246 #define TestClearPageSlab(page) test_and_clear_bit(PG_slab, &(page)->flags)
247 #define TestSetPageSlab(page)   test_and_set_bit(PG_slab, &(page)->flags)
248
249 #ifdef CONFIG_HIGHMEM
250 #define PageHighMem(page)       is_highmem(page_zone(page))
251 #else
252 #define PageHighMem(page)       0 /* needed to optimize away at compile time */
253 #endif
254
255 #define PageChecked(page)       test_bit(PG_checked, &(page)->flags)
256 #define SetPageChecked(page)    set_bit(PG_checked, &(page)->flags)
257 #define ClearPageChecked(page)  clear_bit(PG_checked, &(page)->flags)
258
259 #define PageReserved(page)      test_bit(PG_reserved, &(page)->flags)
260 #define SetPageReserved(page)   set_bit(PG_reserved, &(page)->flags)
261 #define ClearPageReserved(page) clear_bit(PG_reserved, &(page)->flags)
262 #define __ClearPageReserved(page)       __clear_bit(PG_reserved, &(page)->flags)
263
264 #define SetPagePrivate(page)    set_bit(PG_private, &(page)->flags)
265 #define ClearPagePrivate(page)  clear_bit(PG_private, &(page)->flags)
266 #define PagePrivate(page)       test_bit(PG_private, &(page)->flags)
267 #define __SetPagePrivate(page)  __set_bit(PG_private, &(page)->flags)
268 #define __ClearPagePrivate(page) __clear_bit(PG_private, &(page)->flags)
269
270 #define PageWriteback(page)     test_bit(PG_writeback, &(page)->flags)
271 #define SetPageWriteback(page)                                          \
272         do {                                                            \
273                 if (!test_and_set_bit(PG_writeback,                     \
274                                 &(page)->flags))                        \
275                         inc_page_state(nr_writeback);                   \
276         } while (0)
277 #define TestSetPageWriteback(page)                                      \
278         ({                                                              \
279                 int ret;                                                \
280                 ret = test_and_set_bit(PG_writeback,                    \
281                                         &(page)->flags);                \
282                 if (!ret)                                               \
283                         inc_page_state(nr_writeback);                   \
284                 ret;                                                    \
285         })
286 #define ClearPageWriteback(page)                                        \
287         do {                                                            \
288                 if (test_and_clear_bit(PG_writeback,                    \
289                                 &(page)->flags))                        \
290                         dec_page_state(nr_writeback);                   \
291         } while (0)
292 #define TestClearPageWriteback(page)                                    \
293         ({                                                              \
294                 int ret;                                                \
295                 ret = test_and_clear_bit(PG_writeback,                  \
296                                 &(page)->flags);                        \
297                 if (ret)                                                \
298                         dec_page_state(nr_writeback);                   \
299                 ret;                                                    \
300         })
301
302 #define PageNosave(page)        test_bit(PG_nosave, &(page)->flags)
303 #define SetPageNosave(page)     set_bit(PG_nosave, &(page)->flags)
304 #define TestSetPageNosave(page) test_and_set_bit(PG_nosave, &(page)->flags)
305 #define ClearPageNosave(page)           clear_bit(PG_nosave, &(page)->flags)
306 #define TestClearPageNosave(page)       test_and_clear_bit(PG_nosave, &(page)->flags)
307
308 #define PageNosaveFree(page)    test_bit(PG_nosave_free, &(page)->flags)
309 #define SetPageNosaveFree(page) set_bit(PG_nosave_free, &(page)->flags)
310 #define ClearPageNosaveFree(page)               clear_bit(PG_nosave_free, &(page)->flags)
311
312 #define PageMappedToDisk(page)  test_bit(PG_mappedtodisk, &(page)->flags)
313 #define SetPageMappedToDisk(page) set_bit(PG_mappedtodisk, &(page)->flags)
314 #define ClearPageMappedToDisk(page) clear_bit(PG_mappedtodisk, &(page)->flags)
315
316 #define PageReclaim(page)       test_bit(PG_reclaim, &(page)->flags)
317 #define SetPageReclaim(page)    set_bit(PG_reclaim, &(page)->flags)
318 #define ClearPageReclaim(page)  clear_bit(PG_reclaim, &(page)->flags)
319 #define TestClearPageReclaim(page) test_and_clear_bit(PG_reclaim, &(page)->flags)
320
321 #define PageCompound(page)      test_bit(PG_compound, &(page)->flags)
322 #define SetPageCompound(page)   set_bit(PG_compound, &(page)->flags)
323 #define ClearPageCompound(page) clear_bit(PG_compound, &(page)->flags)
324
325 #ifdef CONFIG_SWAP
326 #define PageSwapCache(page)     test_bit(PG_swapcache, &(page)->flags)
327 #define SetPageSwapCache(page)  set_bit(PG_swapcache, &(page)->flags)
328 #define ClearPageSwapCache(page) clear_bit(PG_swapcache, &(page)->flags)
329 #else
330 #define PageSwapCache(page)     0
331 #endif
332
333 #define PageUncached(page)      test_bit(PG_uncached, &(page)->flags)
334 #define SetPageUncached(page)   set_bit(PG_uncached, &(page)->flags)
335 #define ClearPageUncached(page) clear_bit(PG_uncached, &(page)->flags)
336
337 struct page;    /* forward declaration */
338
339 int test_clear_page_dirty(struct page *page);
340 int test_clear_page_writeback(struct page *page);
341 int test_set_page_writeback(struct page *page);
342
343 static inline void clear_page_dirty(struct page *page)
344 {
345         test_clear_page_dirty(page);
346 }
347
348 static inline void set_page_writeback(struct page *page)
349 {
350         test_set_page_writeback(page);
351 }
352
353 #endif  /* PAGE_FLAGS_H */