include/linux/swapops.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_SWAPOPS_H
   3 #define _LINUX_SWAPOPS_H
   4
   5 #include <linux/radix-tree.h>
   6 #include <linux/bug.h>
   7 #include <linux/mm_types.h>
   8
   9 #ifdef CONFIG_MMU
  10
  11 /*
  12  * swapcache pages are stored in the swapper_space radix tree.  We want to
  13  * get good packing density in that tree, so the index should be dense in
  14  * the low-order bits.
  15  *
  16  * We arrange the `type' and `offset' fields so that `type' is at the seven
  17  * high-order bits of the swp_entry_t and `offset' is right-aligned in the
  18  * remaining bits.  Although `type' itself needs only five bits, we allow for
  19  * shmem/tmpfs to shift it all up a further two bits: see swp_to_radix_entry().
  20  *
  21  * swp_entry_t's are *never* stored anywhere in their arch-dependent format.
  22  */
  23 #define SWP_TYPE_SHIFT  (BITS_PER_XA_VALUE - MAX_SWAPFILES_SHIFT)
  24 #define SWP_OFFSET_MASK ((1UL << SWP_TYPE_SHIFT) - 1)
  25
  26 /* Clear all flags but only keep swp_entry_t related information */
  27 static inline pte_t pte_swp_clear_flags(pte_t pte)
  28 {
  29         if (pte_swp_soft_dirty(pte))
  30                 pte = pte_swp_clear_soft_dirty(pte);
  31         if (pte_swp_uffd_wp(pte))
  32                 pte = pte_swp_clear_uffd_wp(pte);
  33         return pte;
  34 }
  35
  36 /*
  37  * Store a type+offset into a swp_entry_t in an arch-independent format
  38  */
  39 static inline swp_entry_t swp_entry(unsigned long type, pgoff_t offset)
  40 {
  41         swp_entry_t ret;
  42
  43         ret.val = (type << SWP_TYPE_SHIFT) | (offset & SWP_OFFSET_MASK);
  44         return ret;
  45 }
  46
  47 /*
  48  * Extract the `type' field from a swp_entry_t.  The swp_entry_t is in
  49  * arch-independent format
  50  */
  51 static inline unsigned swp_type(swp_entry_t entry)
  52 {
  53         return (entry.val >> SWP_TYPE_SHIFT);
  54 }
  55
  56 /*
  57  * Extract the `offset' field from a swp_entry_t.  The swp_entry_t is in
  58  * arch-independent format
  59  */
  60 static inline pgoff_t swp_offset(swp_entry_t entry)
  61 {
  62         return entry.val & SWP_OFFSET_MASK;
  63 }
  64
  65 /* check whether a pte points to a swap entry */
  66 static inline int is_swap_pte(pte_t pte)
  67 {
  68         return !pte_none(pte) && !pte_present(pte);
  69 }
  70
  71 /*
  72  * Convert the arch-dependent pte representation of a swp_entry_t into an
  73  * arch-independent swp_entry_t.
  74  */
  75 static inline swp_entry_t pte_to_swp_entry(pte_t pte)
  76 {
  77         swp_entry_t arch_entry;
  78
  79         pte = pte_swp_clear_flags(pte);
  80         arch_entry = __pte_to_swp_entry(pte);
  81         return swp_entry(__swp_type(arch_entry), __swp_offset(arch_entry));
  82 }
  83
  84 /*
  85  * Convert the arch-independent representation of a swp_entry_t into the
  86  * arch-dependent pte representation.
  87  */
  88 static inline pte_t swp_entry_to_pte(swp_entry_t entry)
  89 {
  90         swp_entry_t arch_entry;
  91
  92         arch_entry = __swp_entry(swp_type(entry), swp_offset(entry));
  93         return __swp_entry_to_pte(arch_entry);
  94 }
  95
  96 static inline swp_entry_t radix_to_swp_entry(void *arg)
  97 {
  98         swp_entry_t entry;
  99
 100         entry.val = xa_to_value(arg);
 101         return entry;
 102 }
 103
 104 static inline void *swp_to_radix_entry(swp_entry_t entry)
 105 {
 106         return xa_mk_value(entry.val);
 107 }
 108
 109 #if IS_ENABLED(CONFIG_DEVICE_PRIVATE)
 110 static inline swp_entry_t make_readable_device_private_entry(pgoff_t offset)
 111 {
 112         return swp_entry(SWP_DEVICE_READ, offset);
 113 }
 114
 115 static inline swp_entry_t make_writable_device_private_entry(pgoff_t offset)
 116 {
 117         return swp_entry(SWP_DEVICE_WRITE, offset);
 118 }
 119
 120 static inline bool is_device_private_entry(swp_entry_t entry)
 121 {
 122         int type = swp_type(entry);
 123         return type == SWP_DEVICE_READ || type == SWP_DEVICE_WRITE;
 124 }
 125
 126 static inline bool is_writable_device_private_entry(swp_entry_t entry)
 127 {
 128         return unlikely(swp_type(entry) == SWP_DEVICE_WRITE);
 129 }
 130 #else /* CONFIG_DEVICE_PRIVATE */
 131 static inline swp_entry_t make_readable_device_private_entry(pgoff_t offset)
 132 {
 133         return swp_entry(0, 0);
 134 }
 135
 136 static inline swp_entry_t make_writable_device_private_entry(pgoff_t offset)
 137 {
 138         return swp_entry(0, 0);
 139 }
 140
 141 static inline bool is_device_private_entry(swp_entry_t entry)
 142 {
 143         return false;
 144 }
 145
 146 static inline bool is_writable_device_private_entry(swp_entry_t entry)
 147 {
 148         return false;
 149 }
 150 #endif /* CONFIG_DEVICE_PRIVATE */
 151
 152 #ifdef CONFIG_MIGRATION
 153 static inline int is_migration_entry(swp_entry_t entry)
 154 {
 155         return unlikely(swp_type(entry) == SWP_MIGRATION_READ ||
 156                         swp_type(entry) == SWP_MIGRATION_WRITE);
 157 }
 158
 159 static inline int is_writable_migration_entry(swp_entry_t entry)
 160 {
 161         return unlikely(swp_type(entry) == SWP_MIGRATION_WRITE);
 162 }
 163
 164 static inline swp_entry_t make_readable_migration_entry(pgoff_t offset)
 165 {
 166         return swp_entry(SWP_MIGRATION_READ, offset);
 167 }
 168
 169 static inline swp_entry_t make_writable_migration_entry(pgoff_t offset)
 170 {
 171         return swp_entry(SWP_MIGRATION_WRITE, offset);
 172 }
 173
 174 extern void __migration_entry_wait(struct mm_struct *mm, pte_t *ptep,
 175                                         spinlock_t *ptl);
 176 extern void migration_entry_wait(struct mm_struct *mm, pmd_t *pmd,
 177                                         unsigned long address);
 178 extern void migration_entry_wait_huge(struct vm_area_struct *vma,
 179                 struct mm_struct *mm, pte_t *pte);
 180 #else
 181 static inline swp_entry_t make_readable_migration_entry(pgoff_t offset)
 182 {
 183         return swp_entry(0, 0);
 184 }
 185
 186 static inline swp_entry_t make_writable_migration_entry(pgoff_t offset)
 187 {
 188         return swp_entry(0, 0);
 189 }
 190
 191 static inline int is_migration_entry(swp_entry_t swp)
 192 {
 193         return 0;
 194 }
 195
 196 static inline void __migration_entry_wait(struct mm_struct *mm, pte_t *ptep,
 197                                         spinlock_t *ptl) { }
 198 static inline void migration_entry_wait(struct mm_struct *mm, pmd_t *pmd,
 199                                          unsigned long address) { }
 200 static inline void migration_entry_wait_huge(struct vm_area_struct *vma,
 201                 struct mm_struct *mm, pte_t *pte) { }
 202 static inline int is_writable_migration_entry(swp_entry_t entry)
 203 {
 204         return 0;
 205 }
 206
 207 #endif
 208
 209 static inline struct page *pfn_swap_entry_to_page(swp_entry_t entry)
 210 {
 211         struct page *p = pfn_to_page(swp_offset(entry));
 212
 213         /*
 214          * Any use of migration entries may only occur while the
 215          * corresponding page is locked
 216          */
 217         BUG_ON(is_migration_entry(entry) && !PageLocked(p));
 218
 219         return p;
 220 }
 221
 222 /*
 223  * A pfn swap entry is a special type of swap entry that always has a pfn stored
 224  * in the swap offset. They are used to represent unaddressable device memory
 225  * and to restrict access to a page undergoing migration.
 226  */
 227 static inline bool is_pfn_swap_entry(swp_entry_t entry)
 228 {
 229         return is_migration_entry(entry) || is_device_private_entry(entry);
 230 }
 231
 232 struct page_vma_mapped_walk;
 233
 234 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
 235 extern void set_pmd_migration_entry(struct page_vma_mapped_walk *pvmw,
 236                 struct page *page);
 237
 238 extern void remove_migration_pmd(struct page_vma_mapped_walk *pvmw,
 239                 struct page *new);
 240
 241 extern void pmd_migration_entry_wait(struct mm_struct *mm, pmd_t *pmd);
 242
 243 static inline swp_entry_t pmd_to_swp_entry(pmd_t pmd)
 244 {
 245         swp_entry_t arch_entry;
 246
 247         if (pmd_swp_soft_dirty(pmd))
 248                 pmd = pmd_swp_clear_soft_dirty(pmd);
 249         if (pmd_swp_uffd_wp(pmd))
 250                 pmd = pmd_swp_clear_uffd_wp(pmd);
 251         arch_entry = __pmd_to_swp_entry(pmd);
 252         return swp_entry(__swp_type(arch_entry), __swp_offset(arch_entry));
 253 }
 254
 255 static inline pmd_t swp_entry_to_pmd(swp_entry_t entry)
 256 {
 257         swp_entry_t arch_entry;
 258
 259         arch_entry = __swp_entry(swp_type(entry), swp_offset(entry));
 260         return __swp_entry_to_pmd(arch_entry);
 261 }
 262
 263 static inline int is_pmd_migration_entry(pmd_t pmd)
 264 {
 265         return !pmd_present(pmd) && is_migration_entry(pmd_to_swp_entry(pmd));
 266 }
 267 #else
 268 static inline void set_pmd_migration_entry(struct page_vma_mapped_walk *pvmw,
 269                 struct page *page)
 270 {
 271         BUILD_BUG();
 272 }
 273
 274 static inline void remove_migration_pmd(struct page_vma_mapped_walk *pvmw,
 275                 struct page *new)
 276 {
 277         BUILD_BUG();
 278 }
 279
 280 static inline void pmd_migration_entry_wait(struct mm_struct *m, pmd_t *p) { }
 281
 282 static inline swp_entry_t pmd_to_swp_entry(pmd_t pmd)
 283 {
 284         return swp_entry(0, 0);
 285 }
 286
 287 static inline pmd_t swp_entry_to_pmd(swp_entry_t entry)
 288 {
 289         return __pmd(0);
 290 }
 291
 292 static inline int is_pmd_migration_entry(pmd_t pmd)
 293 {
 294         return 0;
 295 }
 296 #endif
 297
 298 #ifdef CONFIG_MEMORY_FAILURE
 299
 300 extern atomic_long_t num_poisoned_pages __read_mostly;
 301
 302 /*
 303  * Support for hardware poisoned pages
 304  */
 305 static inline swp_entry_t make_hwpoison_entry(struct page *page)
 306 {
 307         BUG_ON(!PageLocked(page));
 308         return swp_entry(SWP_HWPOISON, page_to_pfn(page));
 309 }
 310
 311 static inline int is_hwpoison_entry(swp_entry_t entry)
 312 {
 313         return swp_type(entry) == SWP_HWPOISON;
 314 }
 315
 316 static inline unsigned long hwpoison_entry_to_pfn(swp_entry_t entry)
 317 {
 318         return swp_offset(entry);
 319 }
 320
 321 static inline void num_poisoned_pages_inc(void)
 322 {
 323         atomic_long_inc(&num_poisoned_pages);
 324 }
 325
 326 static inline void num_poisoned_pages_dec(void)
 327 {
 328         atomic_long_dec(&num_poisoned_pages);
 329 }
 330
 331 #else
 332
 333 static inline swp_entry_t make_hwpoison_entry(struct page *page)
 334 {
 335         return swp_entry(0, 0);
 336 }
 337
 338 static inline int is_hwpoison_entry(swp_entry_t swp)
 339 {
 340         return 0;
 341 }
 342
 343 static inline void num_poisoned_pages_inc(void)
 344 {
 345 }
 346 #endif
 347
 348 #if defined(CONFIG_MEMORY_FAILURE) || defined(CONFIG_MIGRATION) || \
 349     defined(CONFIG_DEVICE_PRIVATE)
 350 static inline int non_swap_entry(swp_entry_t entry)
 351 {
 352         return swp_type(entry) >= MAX_SWAPFILES;
 353 }
 354 #else
 355 static inline int non_swap_entry(swp_entry_t entry)
 356 {
 357         return 0;
 358 }
 359 #endif
 360
 361 #endif /* CONFIG_MMU */
 362 #endif /* _LINUX_SWAPOPS_H */