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 <generated/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  * PG_hwpoison indicates that a page got corrupted in hardware and contains
  55  * data with incorrect ECC bits that triggered a machine check. Accessing is
  56  * not safe since it may cause another machine check. Don't touch!
  57  */
  58
  59 /*
  60  * Don't use the *_dontuse flags.  Use the macros.  Otherwise you'll break
  61  * locked- and dirty-page accounting.
  62  *
  63  * The page flags field is split into two parts, the main flags area
  64  * which extends from the low bits upwards, and the fields area which
  65  * extends from the high bits downwards.
  66  *
  67  *  | FIELD | ... | FLAGS |
  68  *  N-1           ^       0
  69  *               (NR_PAGEFLAGS)
  70  *
  71  * The fields area is reserved for fields mapping zone, node (for NUMA) and
  72  * SPARSEMEM section (for variants of SPARSEMEM that require section ids like
  73  * SPARSEMEM_EXTREME with !SPARSEMEM_VMEMMAP).
  74  */
  75 enum pageflags {
  76         PG_locked,              /* Page is locked. Don't touch. */
  77         PG_error,
  78         PG_referenced,
  79         PG_uptodate,
  80         PG_dirty,
  81         PG_lru,
  82         PG_active,
  83         PG_slab,
  84         PG_owner_priv_1,        /* Owner use. If pagecache, fs may use*/
  85         PG_arch_1,
  86         PG_reserved,
  87         PG_private,             /* If pagecache, has fs-private data */
  88         PG_private_2,           /* If pagecache, has fs aux data */
  89         PG_writeback,           /* Page is under writeback */
  90 #ifdef CONFIG_PAGEFLAGS_EXTENDED
  91         PG_head,                /* A head page */
  92         PG_tail,                /* A tail page */
  93 #else
  94         PG_compound,            /* A compound page */
  95 #endif
  96         PG_swapcache,           /* Swap page: swp_entry_t in private */
  97         PG_mappedtodisk,        /* Has blocks allocated on-disk */
  98         PG_reclaim,             /* To be reclaimed asap */
  99         PG_buddy,               /* Page is free, on buddy lists */
 100         PG_swapbacked,          /* Page is backed by RAM/swap */
 101         PG_unevictable,         /* Page is "unevictable"  */
 102 #ifdef CONFIG_MMU
 103         PG_mlocked,             /* Page is vma mlocked */
 104 #endif
 105 #ifdef CONFIG_ARCH_USES_PG_UNCACHED
 106         PG_uncached,            /* Page has been mapped as uncached */
 107 #endif
 108 #ifdef CONFIG_MEMORY_FAILURE
 109         PG_hwpoison,            /* hardware poisoned page. Don't touch */
 110 #endif
 111         __NR_PAGEFLAGS,
 112
 113         /* Filesystems */
 114         PG_checked = PG_owner_priv_1,
 115
 116         /* Two page bits are conscripted by FS-Cache to maintain local caching
 117          * state.  These bits are set on pages belonging to the netfs's inodes
 118          * when those inodes are being locally cached.
 119          */
 120         PG_fscache = PG_private_2,      /* page backed by cache */
 121
 122         /* XEN */
 123         PG_pinned = PG_owner_priv_1,
 124         PG_savepinned = PG_dirty,
 125
 126         /* SLOB */
 127         PG_slob_free = PG_private,
 128
 129         /* SLUB */
 130         PG_slub_frozen = PG_active,
 131 };
 132
 133 #ifndef __GENERATING_BOUNDS_H
 134
 135 /*
 136  * Macros to create function definitions for page flags
 137  */
 138 #define TESTPAGEFLAG(uname, lname)                                      \
 139 static inline int Page##uname(struct page *page)                        \
 140                         { return test_bit(PG_##lname, &page->flags); }
 141
 142 #define SETPAGEFLAG(uname, lname)                                       \
 143 static inline void SetPage##uname(struct page *page)                    \
 144                         { set_bit(PG_##lname, &page->flags); }
 145
 146 #define CLEARPAGEFLAG(uname, lname)                                     \
 147 static inline void ClearPage##uname(struct page *page)                  \
 148                         { clear_bit(PG_##lname, &page->flags); }
 149
 150 #define __SETPAGEFLAG(uname, lname)                                     \
 151 static inline void __SetPage##uname(struct page *page)                  \
 152                         { __set_bit(PG_##lname, &page->flags); }
 153
 154 #define __CLEARPAGEFLAG(uname, lname)                                   \
 155 static inline void __ClearPage##uname(struct page *page)                \
 156                         { __clear_bit(PG_##lname, &page->flags); }
 157
 158 #define TESTSETFLAG(uname, lname)                                       \
 159 static inline int TestSetPage##uname(struct page *page)                 \
 160                 { return test_and_set_bit(PG_##lname, &page->flags); }
 161
 162 #define TESTCLEARFLAG(uname, lname)                                     \
 163 static inline int TestClearPage##uname(struct page *page)               \
 164                 { return test_and_clear_bit(PG_##lname, &page->flags); }
 165
 166 #define __TESTCLEARFLAG(uname, lname)                                   \
 167 static inline int __TestClearPage##uname(struct page *page)             \
 168                 { return __test_and_clear_bit(PG_##lname, &page->flags); }
 169
 170 #define PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)               \
 171         SETPAGEFLAG(uname, lname) CLEARPAGEFLAG(uname, lname)
 172
 173 #define __PAGEFLAG(uname, lname) TESTPAGEFLAG(uname, lname)             \
 174         __SETPAGEFLAG(uname, lname)  __CLEARPAGEFLAG(uname, lname)
 175
 176 #define PAGEFLAG_FALSE(uname)                                           \
 177 static inline int Page##uname(struct page *page)                        \
 178                         { return 0; }
 179
 180 #define TESTSCFLAG(uname, lname)                                        \
 181         TESTSETFLAG(uname, lname) TESTCLEARFLAG(uname, lname)
 182
 183 #define SETPAGEFLAG_NOOP(uname)                                         \
 184 static inline void SetPage##uname(struct page *page) {  }
 185
 186 #define CLEARPAGEFLAG_NOOP(uname)                                       \
 187 static inline void ClearPage##uname(struct page *page) {  }
 188
 189 #define __CLEARPAGEFLAG_NOOP(uname)                                     \
 190 static inline void __ClearPage##uname(struct page *page) {  }
 191
 192 #define TESTCLEARFLAG_FALSE(uname)                                      \
 193 static inline int TestClearPage##uname(struct page *page) { return 0; }
 194
 195 #define __TESTCLEARFLAG_FALSE(uname)                                    \
 196 static inline int __TestClearPage##uname(struct page *page) { return 0; }
 197
 198 struct page;    /* forward declaration */
 199
 200 TESTPAGEFLAG(Locked, locked) TESTSETFLAG(Locked, locked)
 201 PAGEFLAG(Error, error)
 202 PAGEFLAG(Referenced, referenced) TESTCLEARFLAG(Referenced, referenced)
 203 PAGEFLAG(Dirty, dirty) TESTSCFLAG(Dirty, dirty) __CLEARPAGEFLAG(Dirty, dirty)
 204 PAGEFLAG(LRU, lru) __CLEARPAGEFLAG(LRU, lru)
 205 PAGEFLAG(Active, active) __CLEARPAGEFLAG(Active, active)
 206         TESTCLEARFLAG(Active, active)
 207 __PAGEFLAG(Slab, slab)
 208 PAGEFLAG(Checked, checked)              /* Used by some filesystems */
 209 PAGEFLAG(Pinned, pinned) TESTSCFLAG(Pinned, pinned)     /* Xen */
 210 PAGEFLAG(SavePinned, savepinned);                       /* Xen */
 211 PAGEFLAG(Reserved, reserved) __CLEARPAGEFLAG(Reserved, reserved)
 212 PAGEFLAG(SwapBacked, swapbacked) __CLEARPAGEFLAG(SwapBacked, swapbacked)
 213
 214 __PAGEFLAG(SlobFree, slob_free)
 215
 216 __PAGEFLAG(SlubFrozen, slub_frozen)
 217
 218 /*
 219  * Private page markings that may be used by the filesystem that owns the page
 220  * for its own purposes.
 221  * - PG_private and PG_private_2 cause releasepage() and co to be invoked
 222  */
 223 PAGEFLAG(Private, private) __SETPAGEFLAG(Private, private)
 224         __CLEARPAGEFLAG(Private, private)
 225 PAGEFLAG(Private2, private_2) TESTSCFLAG(Private2, private_2)
 226 PAGEFLAG(OwnerPriv1, owner_priv_1) TESTCLEARFLAG(OwnerPriv1, owner_priv_1)
 227
 228 /*
 229  * Only test-and-set exist for PG_writeback.  The unconditional operators are
 230  * risky: they bypass page accounting.
 231  */
 232 TESTPAGEFLAG(Writeback, writeback) TESTSCFLAG(Writeback, writeback)
 233 __PAGEFLAG(Buddy, buddy)
 234 PAGEFLAG(MappedToDisk, mappedtodisk)
 235
 236 /* PG_readahead is only used for file reads; PG_reclaim is only for writes */
 237 PAGEFLAG(Reclaim, reclaim) TESTCLEARFLAG(Reclaim, reclaim)
 238 PAGEFLAG(Readahead, reclaim)            /* Reminder to do async read-ahead */
 239
 240 #ifdef CONFIG_HIGHMEM
 241 /*
 242  * Must use a macro here due to header dependency issues. page_zone() is not
 243  * available at this point.
 244  */
 245 #define PageHighMem(__p) is_highmem(page_zone(__p))
 246 #else
 247 PAGEFLAG_FALSE(HighMem)
 248 #endif
 249
 250 #ifdef CONFIG_SWAP
 251 PAGEFLAG(SwapCache, swapcache)
 252 #else
 253 PAGEFLAG_FALSE(SwapCache)
 254         SETPAGEFLAG_NOOP(SwapCache) CLEARPAGEFLAG_NOOP(SwapCache)
 255 #endif
 256
 257 PAGEFLAG(Unevictable, unevictable) __CLEARPAGEFLAG(Unevictable, unevictable)
 258         TESTCLEARFLAG(Unevictable, unevictable)
 259
 260 #ifdef CONFIG_MMU
 261 PAGEFLAG(Mlocked, mlocked) __CLEARPAGEFLAG(Mlocked, mlocked)
 262         TESTSCFLAG(Mlocked, mlocked) __TESTCLEARFLAG(Mlocked, mlocked)
 263 #else
 264 PAGEFLAG_FALSE(Mlocked) SETPAGEFLAG_NOOP(Mlocked)
 265         TESTCLEARFLAG_FALSE(Mlocked) __TESTCLEARFLAG_FALSE(Mlocked)
 266 #endif
 267
 268 #ifdef CONFIG_ARCH_USES_PG_UNCACHED
 269 PAGEFLAG(Uncached, uncached)
 270 #else
 271 PAGEFLAG_FALSE(Uncached)
 272 #endif
 273
 274 #ifdef CONFIG_MEMORY_FAILURE
 275 PAGEFLAG(HWPoison, hwpoison)
 276 TESTSCFLAG(HWPoison, hwpoison)
 277 #define __PG_HWPOISON (1UL << PG_hwpoison)
 278 #else
 279 PAGEFLAG_FALSE(HWPoison)
 280 #define __PG_HWPOISON 0
 281 #endif
 282
 283 u64 stable_page_flags(struct page *page);
 284
 285 static inline int PageUptodate(struct page *page)
 286 {
 287         int ret = test_bit(PG_uptodate, &(page)->flags);
 288
 289         /*
 290          * Must ensure that the data we read out of the page is loaded
 291          * _after_ we've loaded page->flags to check for PageUptodate.
 292          * We can skip the barrier if the page is not uptodate, because
 293          * we wouldn't be reading anything from it.
 294          *
 295          * See SetPageUptodate() for the other side of the story.
 296          */
 297         if (ret)
 298                 smp_rmb();
 299
 300         return ret;
 301 }
 302
 303 static inline void __SetPageUptodate(struct page *page)
 304 {
 305         smp_wmb();
 306         __set_bit(PG_uptodate, &(page)->flags);
 307 }
 308
 309 static inline void SetPageUptodate(struct page *page)
 310 {
 311 #ifdef CONFIG_S390
 312         if (!test_and_set_bit(PG_uptodate, &page->flags))
 313                 page_clear_dirty(page);
 314 #else
 315         /*
 316          * Memory barrier must be issued before setting the PG_uptodate bit,
 317          * so that all previous stores issued in order to bring the page
 318          * uptodate are actually visible before PageUptodate becomes true.
 319          *
 320          * s390 doesn't need an explicit smp_wmb here because the test and
 321          * set bit already provides full barriers.
 322          */
 323         smp_wmb();
 324         set_bit(PG_uptodate, &(page)->flags);
 325 #endif
 326 }
 327
 328 CLEARPAGEFLAG(Uptodate, uptodate)
 329
 330 extern void cancel_dirty_page(struct page *page, unsigned int account_size);
 331
 332 int test_clear_page_writeback(struct page *page);
 333 int test_set_page_writeback(struct page *page);
 334
 335 static inline void set_page_writeback(struct page *page)
 336 {
 337         test_set_page_writeback(page);
 338 }
 339
 340 #ifdef CONFIG_PAGEFLAGS_EXTENDED
 341 /*
 342  * System with lots of page flags available. This allows separate
 343  * flags for PageHead() and PageTail() checks of compound pages so that bit
 344  * tests can be used in performance sensitive paths. PageCompound is
 345  * generally not used in hot code paths.
 346  */
 347 __PAGEFLAG(Head, head)
 348 __PAGEFLAG(Tail, tail)
 349
 350 static inline int PageCompound(struct page *page)
 351 {
 352         return page->flags & ((1L << PG_head) | (1L << PG_tail));
 353
 354 }
 355 #else
 356 /*
 357  * Reduce page flag use as much as possible by overlapping
 358  * compound page flags with the flags used for page cache pages. Possible
 359  * because PageCompound is always set for compound pages and not for
 360  * pages on the LRU and/or pagecache.
 361  */
 362 TESTPAGEFLAG(Compound, compound)
 363 __PAGEFLAG(Head, compound)
 364
 365 /*
 366  * PG_reclaim is used in combination with PG_compound to mark the
 367  * head and tail of a compound page. This saves one page flag
 368  * but makes it impossible to use compound pages for the page cache.
 369  * The PG_reclaim bit would have to be used for reclaim or readahead
 370  * if compound pages enter the page cache.
 371  *
 372  * PG_compound & PG_reclaim     => Tail page
 373  * PG_compound & ~PG_reclaim    => Head page
 374  */
 375 #define PG_head_tail_mask ((1L << PG_compound) | (1L << PG_reclaim))
 376
 377 static inline int PageTail(struct page *page)
 378 {
 379         return ((page->flags & PG_head_tail_mask) == PG_head_tail_mask);
 380 }
 381
 382 static inline void __SetPageTail(struct page *page)
 383 {
 384         page->flags |= PG_head_tail_mask;
 385 }
 386
 387 static inline void __ClearPageTail(struct page *page)
 388 {
 389         page->flags &= ~PG_head_tail_mask;
 390 }
 391
 392 #endif /* !PAGEFLAGS_EXTENDED */
 393
 394 #ifdef CONFIG_MMU
 395 #define __PG_MLOCKED            (1 << PG_mlocked)
 396 #else
 397 #define __PG_MLOCKED            0
 398 #endif
 399
 400 /*
 401  * Flags checked when a page is freed.  Pages being freed should not have
 402  * these flags set.  It they are, there is a problem.
 403  */
 404 #define PAGE_FLAGS_CHECK_AT_FREE \
 405         (1 << PG_lru     | 1 << PG_locked    | \
 406          1 << PG_private | 1 << PG_private_2 | \
 407          1 << PG_buddy   | 1 << PG_writeback | 1 << PG_reserved | \
 408          1 << PG_slab    | 1 << PG_swapcache | 1 << PG_active | \
 409          1 << PG_unevictable | __PG_MLOCKED | __PG_HWPOISON)
 410
 411 /*
 412  * Flags checked when a page is prepped for return by the page allocator.
 413  * Pages being prepped should not have any flags set.  It they are set,
 414  * there has been a kernel bug or struct page corruption.
 415  */
 416 #define PAGE_FLAGS_CHECK_AT_PREP        ((1 << NR_PAGEFLAGS) - 1)
 417
 418 #define PAGE_FLAGS_PRIVATE                              \
 419         (1 << PG_private | 1 << PG_private_2)
 420 /**
 421  * page_has_private - Determine if page has private stuff
 422  * @page: The page to be checked
 423  *
 424  * Determine if a page has private stuff, indicating that release routines
 425  * should be invoked upon it.
 426  */
 427 static inline int page_has_private(struct page *page)
 428 {
 429         return !!(page->flags & PAGE_FLAGS_PRIVATE);
 430 }
 431
 432 #endif /* !__GENERATING_BOUNDS_H */
 433
 434 #endif  /* PAGE_FLAGS_H */