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         PG_compound,            /* A compound page */
  87         PG_swapcache,           /* Swap page: swp_entry_t in private */
  88         PG_mappedtodisk,        /* Has blocks allocated on-disk */
  89         PG_reclaim,             /* To be reclaimed asap */
  90         PG_buddy,               /* Page is free, on buddy lists */
  91
  92 #if (BITS_PER_LONG > 32)
  93 /*
  94  * 64-bit-only flags build down from bit 31
  95  *
  96  * 32 bit  -------------------------------| FIELDS |       FLAGS         |
  97  * 64 bit  |           FIELDS             | ??????         FLAGS         |
  98  *         63                            32                              0
  99  */
 100         PG_uncached = 31,               /* Page has been mapped as uncached */
 101 #endif
 102         __NR_PAGEFLAGS
 103 };
 104
 105 #ifndef __GENERATING_BOUNDS_H
 106
 107 /*
 108  * Macros to create function definitions for page flags
 109  */
 110 #define TESTPAGEFLAG(uname, lname)                                      \
 111 static inline int Page##uname(struct page *page)                        \
 112                         { return test_bit(PG_##lname, &page->flags); }
 113
 114 #define SETPAGEFLAG(uname, lname)                                       \
 115 static inline void SetPage##uname(struct page *page)                    \
 116                         { set_bit(PG_##lname, &page->flags); }
 117
 118 #define CLEARPAGEFLAG(uname, lname)                                     \
 119 static inline void ClearPage##uname(struct page *page)                  \
 120                         { clear_bit(PG_##lname, &page->flags); }
 121
 122 #define __SETPAGEFLAG(uname, lname)                                     \
 123 static inline void __SetPage##uname(struct page *page)                  \
 124                         { __set_bit(PG_##lname, &page->flags); }
 125
 126 #define __CLEARPAGEFLAG(uname, lname)                                   \
 127 static inline void __ClearPage##uname(struct page *page)                \
 128                         { __clear_bit(PG_##lname, &page->flags); }
 129
 130 #define TESTSETFLAG(uname, lname)                                       \
 131 static inline int TestSetPage##uname(struct page *page)                 \
 132                 { return test_and_set_bit(PG_##lname, &page->flags); }
 133
 134 #define TESTCLEARFLAG(uname, lname)                                     \
 135 static inline int TestClearPage##uname(struct page *page)               \
 136                 { return test_and_clear_bit(PG_##lname, &page->flags); }
 137
 138
 139 #define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)               \
 140         SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
 141
 142 #define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)             \
 143         __SETPAGEFLAG(uname, lname)  __CLEARPAGEFLAG(uname, lname)
 144
 145 #define TESTSCFLAG(uname, lname)                                        \
 146         TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
 147
 148 struct page;    /* forward declaration */
 149
 150 PAGEFLAG(Locked, locked) TESTSCFLAG(Locked, locked)
 151 PAGEFLAG(Error, error)
 152 PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
 153 PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
 154 PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
 155 PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
 156 __PAGEFLAG(Slab, slab)
 157 PAGEFLAG(Checked, owner_priv_1)         /* Used by some filesystems */
 158 PAGEFLAG(Pinned, owner_priv_1) TESTSCFLAG(Pinned, owner_priv_1) /* Xen */
 159 PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
 160 PAGEFLAG(Private, private) __CLEARPAGEFLAG(Private, private)
 161         __SETPAGEFLAG(Private, private)
 162
 163 /*
 164  * Only test-and-set exist for PG_writeback.  The unconditional operators are
 165  * risky: they bypass page accounting.
 166  */
 167 TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
 168 __PAGEFLAG(Buddy, buddy)
 169 PAGEFLAG(MappedToDisk, mappedtodisk)
 170
 171 /* PG_readahead is only used for file reads; PG_reclaim is only for writes */
 172 PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
 173 PAGEFLAG(Readahead, reclaim)            /* Reminder to do async read-ahead */
 174
 175 #ifdef CONFIG_HIGHMEM
 176 /*
 177  * Must use a macro here due to header dependency issues. page_zone() is not
 178  * available at this point.
 179  */
 180 #define PageHighMem(__p) is_highmem(page_zone(__p))
 181 #else
 182 static inline int PageHighMem(struct page *page)
 183 {
 184         return 0;
 185 }
 186 #endif
 187
 188 #ifdef CONFIG_SWAP
 189 PAGEFLAG(SwapCache, swapcache)
 190 #else
 191 static inline int PageSwapCache(struct page *page)
 192 {
 193         return 0;
 194 }
 195 #endif
 196
 197 #if (BITS_PER_LONG > 32)
 198 PAGEFLAG(Uncached, uncached)
 199 #endif
 200
 201 static inline int PageUptodate(struct page *page)
 202 {
 203         int ret = test_bit(PG_uptodate, &(page)->flags);
 204
 205         /*
 206          * Must ensure that the data we read out of the page is loaded
 207          * _after_ we've loaded page->flags to check for PageUptodate.
 208          * We can skip the barrier if the page is not uptodate, because
 209          * we wouldn't be reading anything from it.
 210          *
 211          * See SetPageUptodate() for the other side of the story.
 212          */
 213         if (ret)
 214                 smp_rmb();
 215
 216         return ret;
 217 }
 218
 219 static inline void __SetPageUptodate(struct page *page)
 220 {
 221         smp_wmb();
 222         __set_bit(PG_uptodate, &(page)->flags);
 223 #ifdef CONFIG_S390
 224         page_clear_dirty(page);
 225 #endif
 226 }
 227
 228 static inline void SetPageUptodate(struct page *page)
 229 {
 230 #ifdef CONFIG_S390
 231         if (!test_and_set_bit(PG_uptodate, &page->flags))
 232                 page_clear_dirty(page);
 233 #else
 234         /*
 235          * Memory barrier must be issued before setting the PG_uptodate bit,
 236          * so that all previous stores issued in order to bring the page
 237          * uptodate are actually visible before PageUptodate becomes true.
 238          *
 239          * s390 doesn't need an explicit smp_wmb here because the test and
 240          * set bit already provides full barriers.
 241          */
 242         smp_wmb();
 243         set_bit(PG_uptodate, &(page)->flags);
 244 #endif
 245 }
 246
 247 CLEARPAGEFLAG(Uptodate, uptodate)
 248
 249 extern void cancel_dirty_page(struct page *page, unsigned int account_size);
 250
 251 int test_clear_page_writeback(struct page *page);
 252 int test_set_page_writeback(struct page *page);
 253
 254 static inline void set_page_writeback(struct page *page)
 255 {
 256         test_set_page_writeback(page);
 257 }
 258
 259 TESTPAGEFLAG(Compound, compound)
 260 __PAGEFLAG(Head, compound)
 261
 262 /*
 263  * PG_reclaim is used in combination with PG_compound to mark the
 264  * head and tail of a compound page. This saves one page flag
 265  * but makes it impossible to use compound pages for the page cache.
 266  * The PG_reclaim bit would have to be used for reclaim or readahead
 267  * if compound pages enter the page cache.
 268  *
 269  * PG_compound & PG_reclaim     => Tail page
 270  * PG_compound & ~PG_reclaim    => Head page
 271  */
 272 #define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
 273
 274 static inline int PageTail(struct page *page)
 275 {
 276         return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
 277 }
 278
 279 static inline void __SetPageTail(struct page *page)
 280 {
 281         page->flags |= PG_head_tail_mask;
 282 }
 283
 284 static inline void __ClearPageTail(struct page *page)
 285 {
 286         page->flags &= ~PG_head_tail_mask;
 287 }
 288
 289 #endif /* !__GENERATING_BOUNDS_H */
 290 #endif  /* PAGE_FLAGS_H */