include/linux/swapops.h

   1 #ifndef _LINUX_SWAPOPS_H
   2 #define _LINUX_SWAPOPS_H
   3
   4 #include <linux/radix-tree.h>
   5
   6 /*
   7  * swapcache pages are stored in the swapper_space radix tree.  We want to
   8  * get good packing density in that tree, so the index should be dense in
   9  * the low-order bits.
  10  *
  11  * We arrange the `type' and `offset' fields so that `type' is at the seven
  12  * high-order bits of the swp_entry_t and `offset' is right-aligned in the
  13  * remaining bits.  Although `type' itself needs only five bits, we allow for
  14  * shmem/tmpfs to shift it all up a further two bits: see swp_to_radix_entry().
  15  *
  16  * swp_entry_t's are *never* stored anywhere in their arch-dependent format.
  17  */
  18 #define SWP_TYPE_SHIFT(e)       ((sizeof(e.val) * 8) - \
  19                         (MAX_SWAPFILES_SHIFT + RADIX_TREE_EXCEPTIONAL_SHIFT))
  20 #define SWP_OFFSET_MASK(e)      ((1UL << SWP_TYPE_SHIFT(e)) - 1)
  21
  22 /*
  23  * Store a type+offset into a swp_entry_t in an arch-independent format
  24  */
  25 static inline swp_entry_t swp_entry(unsigned long type, pgoff_t offset)
  26 {
  27         swp_entry_t ret;
  28
  29         ret.val = (type << SWP_TYPE_SHIFT(ret)) |
  30                         (offset & SWP_OFFSET_MASK(ret));
  31         return ret;
  32 }
  33
  34 /*
  35  * Extract the `type' field from a swp_entry_t.  The swp_entry_t is in
  36  * arch-independent format
  37  */
  38 static inline unsigned swp_type(swp_entry_t entry)
  39 {
  40         return (entry.val >> SWP_TYPE_SHIFT(entry));
  41 }
  42
  43 /*
  44  * Extract the `offset' field from a swp_entry_t.  The swp_entry_t is in
  45  * arch-independent format
  46  */
  47 static inline pgoff_t swp_offset(swp_entry_t entry)
  48 {
  49         return entry.val & SWP_OFFSET_MASK(entry);
  50 }
  51
  52 #ifdef CONFIG_MMU
  53 /* check whether a pte points to a swap entry */
  54 static inline int is_swap_pte(pte_t pte)
  55 {
  56         return !pte_none(pte) && !pte_present(pte) && !pte_file(pte);
  57 }
  58 #endif
  59
  60 /*
  61  * Convert the arch-dependent pte representation of a swp_entry_t into an
  62  * arch-independent swp_entry_t.
  63  */
  64 static inline swp_entry_t pte_to_swp_entry(pte_t pte)
  65 {
  66         swp_entry_t arch_entry;
  67
  68         BUG_ON(pte_file(pte));
  69         arch_entry = __pte_to_swp_entry(pte);
  70         return swp_entry(__swp_type(arch_entry), __swp_offset(arch_entry));
  71 }
  72
  73 /*
  74  * Convert the arch-independent representation of a swp_entry_t into the
  75  * arch-dependent pte representation.
  76  */
  77 static inline pte_t swp_entry_to_pte(swp_entry_t entry)
  78 {
  79         swp_entry_t arch_entry;
  80
  81         arch_entry = __swp_entry(swp_type(entry), swp_offset(entry));
  82         BUG_ON(pte_file(__swp_entry_to_pte(arch_entry)));
  83         return __swp_entry_to_pte(arch_entry);
  84 }
  85
  86 static inline swp_entry_t radix_to_swp_entry(void *arg)
  87 {
  88         swp_entry_t entry;
  89
  90         entry.val = (unsigned long)arg >> RADIX_TREE_EXCEPTIONAL_SHIFT;
  91         return entry;
  92 }
  93
  94 static inline void *swp_to_radix_entry(swp_entry_t entry)
  95 {
  96         unsigned long value;
  97
  98         value = entry.val << RADIX_TREE_EXCEPTIONAL_SHIFT;
  99         return (void *)(value | RADIX_TREE_EXCEPTIONAL_ENTRY);
 100 }
 101
 102 #ifdef CONFIG_MIGRATION
 103 static inline swp_entry_t make_migration_entry(struct page *page, int write)
 104 {
 105         BUG_ON(!PageLocked(page));
 106         return swp_entry(write ? SWP_MIGRATION_WRITE : SWP_MIGRATION_READ,
 107                         page_to_pfn(page));
 108 }
 109
 110 static inline int is_migration_entry(swp_entry_t entry)
 111 {
 112         return unlikely(swp_type(entry) == SWP_MIGRATION_READ ||
 113                         swp_type(entry) == SWP_MIGRATION_WRITE);
 114 }
 115
 116 static inline int is_write_migration_entry(swp_entry_t entry)
 117 {
 118         return unlikely(swp_type(entry) == SWP_MIGRATION_WRITE);
 119 }
 120
 121 static inline struct page *migration_entry_to_page(swp_entry_t entry)
 122 {
 123         struct page *p = pfn_to_page(swp_offset(entry));
 124         /*
 125          * Any use of migration entries may only occur while the
 126          * corresponding page is locked
 127          */
 128         BUG_ON(!PageLocked(p));
 129         return p;
 130 }
 131
 132 static inline void make_migration_entry_read(swp_entry_t *entry)
 133 {
 134         *entry = swp_entry(SWP_MIGRATION_READ, swp_offset(*entry));
 135 }
 136
 137 extern void migration_entry_wait(struct mm_struct *mm, pmd_t *pmd,
 138                                         unsigned long address);
 139 extern void migration_entry_wait_huge(struct mm_struct *mm, pte_t *pte);
 140 #else
 141
 142 #define make_migration_entry(page, write) swp_entry(0, 0)
 143 static inline int is_migration_entry(swp_entry_t swp)
 144 {
 145         return 0;
 146 }
 147 #define migration_entry_to_page(swp) NULL
 148 static inline void make_migration_entry_read(swp_entry_t *entryp) { }
 149 static inline void migration_entry_wait(struct mm_struct *mm, pmd_t *pmd,
 150                                          unsigned long address) { }
 151 static inline void migration_entry_wait_huge(struct mm_struct *mm,
 152                                         pte_t *pte) { }
 153 static inline int is_write_migration_entry(swp_entry_t entry)
 154 {
 155         return 0;
 156 }
 157
 158 #endif
 159
 160 #ifdef CONFIG_MEMORY_FAILURE
 161 /*
 162  * Support for hardware poisoned pages
 163  */
 164 static inline swp_entry_t make_hwpoison_entry(struct page *page)
 165 {
 166         BUG_ON(!PageLocked(page));
 167         return swp_entry(SWP_HWPOISON, page_to_pfn(page));
 168 }
 169
 170 static inline int is_hwpoison_entry(swp_entry_t entry)
 171 {
 172         return swp_type(entry) == SWP_HWPOISON;
 173 }
 174 #else
 175
 176 static inline swp_entry_t make_hwpoison_entry(struct page *page)
 177 {
 178         return swp_entry(0, 0);
 179 }
 180
 181 static inline int is_hwpoison_entry(swp_entry_t swp)
 182 {
 183         return 0;
 184 }
 185 #endif
 186
 187 #if defined(CONFIG_MEMORY_FAILURE) || defined(CONFIG_MIGRATION)
 188 static inline int non_swap_entry(swp_entry_t entry)
 189 {
 190         return swp_type(entry) >= MAX_SWAPFILES;
 191 }
 192 #else
 193 static inline int non_swap_entry(swp_entry_t entry)
 194 {
 195         return 0;
 196 }
 197 #endif
 198
 199 #endif /* _LINUX_SWAPOPS_H */