1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_MIGRATE_H 3 #define _LINUX_MIGRATE_H 4 5 #include <linux/mm.h> 6 #include <linux/mempolicy.h> 7 #include <linux/migrate_mode.h> 8 #include <linux/hugetlb.h> 9 10 typedef struct page *new_page_t(struct page *page, unsigned long private); 11 typedef void free_page_t(struct page *page, unsigned long private); 12 13 struct migration_target_control; 14 15 /* 16 * Return values from addresss_space_operations.migratepage(): 17 * - negative errno on page migration failure; 18 * - zero on page migration success; 19 */ 20 #define MIGRATEPAGE_SUCCESS 0 21 22 /** 23 * struct movable_operations - Driver page migration 24 * @isolate_page: 25 * The VM calls this function to prepare the page to be moved. The page 26 * is locked and the driver should not unlock it. The driver should 27 * return ``true`` if the page is movable and ``false`` if it is not 28 * currently movable. After this function returns, the VM uses the 29 * page->lru field, so the driver must preserve any information which 30 * is usually stored here. 31 * 32 * @migrate_page: 33 * After isolation, the VM calls this function with the isolated 34 * @src page. The driver should copy the contents of the 35 * @src page to the @dst page and set up the fields of @dst page. 36 * Both pages are locked. 37 * If page migration is successful, the driver should call 38 * __ClearPageMovable(@src) and return MIGRATEPAGE_SUCCESS. 39 * If the driver cannot migrate the page at the moment, it can return 40 * -EAGAIN. The VM interprets this as a temporary migration failure and 41 * will retry it later. Any other error value is a permanent migration 42 * failure and migration will not be retried. 43 * The driver shouldn't touch the @src->lru field while in the 44 * migrate_page() function. It may write to @dst->lru. 45 * 46 * @putback_page: 47 * If migration fails on the isolated page, the VM informs the driver 48 * that the page is no longer a candidate for migration by calling 49 * this function. The driver should put the isolated page back into 50 * its own data structure. 51 */ 52 struct movable_operations { 53 bool (*isolate_page)(struct page *, isolate_mode_t); 54 int (*migrate_page)(struct page *dst, struct page *src, 55 enum migrate_mode); 56 void (*putback_page)(struct page *); 57 }; 58 59 /* Defined in mm/debug.c: */ 60 extern const char *migrate_reason_names[MR_TYPES]; 61 62 #ifdef CONFIG_MIGRATION 63 64 extern void putback_movable_pages(struct list_head *l); 65 int migrate_folio(struct address_space *mapping, struct folio *dst, 66 struct folio *src, enum migrate_mode mode); 67 extern int migrate_pages(struct list_head *l, new_page_t new, free_page_t free, 68 unsigned long private, enum migrate_mode mode, int reason, 69 unsigned int *ret_succeeded); 70 extern struct page *alloc_migration_target(struct page *page, unsigned long private); 71 extern int isolate_movable_page(struct page *page, isolate_mode_t mode); 72 73 int migrate_huge_page_move_mapping(struct address_space *mapping, 74 struct folio *dst, struct folio *src); 75 void migration_entry_wait_on_locked(swp_entry_t entry, pte_t *ptep, 76 spinlock_t *ptl); 77 void folio_migrate_flags(struct folio *newfolio, struct folio *folio); 78 void folio_migrate_copy(struct folio *newfolio, struct folio *folio); 79 int folio_migrate_mapping(struct address_space *mapping, 80 struct folio *newfolio, struct folio *folio, int extra_count); 81 82 #else 83 84 static inline void putback_movable_pages(struct list_head *l) {} 85 static inline int migrate_pages(struct list_head *l, new_page_t new, 86 free_page_t free, unsigned long private, enum migrate_mode mode, 87 int reason, unsigned int *ret_succeeded) 88 { return -ENOSYS; } 89 static inline struct page *alloc_migration_target(struct page *page, 90 unsigned long private) 91 { return NULL; } 92 static inline int isolate_movable_page(struct page *page, isolate_mode_t mode) 93 { return -EBUSY; } 94 95 static inline int migrate_huge_page_move_mapping(struct address_space *mapping, 96 struct folio *dst, struct folio *src) 97 { 98 return -ENOSYS; 99 } 100 101 #endif /* CONFIG_MIGRATION */ 102 103 #ifdef CONFIG_COMPACTION 104 bool PageMovable(struct page *page); 105 void __SetPageMovable(struct page *page, const struct movable_operations *ops); 106 void __ClearPageMovable(struct page *page); 107 #else 108 static inline bool PageMovable(struct page *page) { return false; } 109 static inline void __SetPageMovable(struct page *page, 110 const struct movable_operations *ops) 111 { 112 } 113 static inline void __ClearPageMovable(struct page *page) 114 { 115 } 116 #endif 117 118 static inline bool folio_test_movable(struct folio *folio) 119 { 120 return PageMovable(&folio->page); 121 } 122 123 static inline 124 const struct movable_operations *page_movable_ops(struct page *page) 125 { 126 VM_BUG_ON(!__PageMovable(page)); 127 128 return (const struct movable_operations *) 129 ((unsigned long)page->mapping - PAGE_MAPPING_MOVABLE); 130 } 131 132 #ifdef CONFIG_NUMA_BALANCING 133 extern int migrate_misplaced_page(struct page *page, 134 struct vm_area_struct *vma, int node); 135 #else 136 static inline int migrate_misplaced_page(struct page *page, 137 struct vm_area_struct *vma, int node) 138 { 139 return -EAGAIN; /* can't migrate now */ 140 } 141 #endif /* CONFIG_NUMA_BALANCING */ 142 143 #ifdef CONFIG_MIGRATION 144 145 /* 146 * Watch out for PAE architecture, which has an unsigned long, and might not 147 * have enough bits to store all physical address and flags. So far we have 148 * enough room for all our flags. 149 */ 150 #define MIGRATE_PFN_VALID (1UL << 0) 151 #define MIGRATE_PFN_MIGRATE (1UL << 1) 152 #define MIGRATE_PFN_WRITE (1UL << 3) 153 #define MIGRATE_PFN_SHIFT 6 154 155 static inline struct page *migrate_pfn_to_page(unsigned long mpfn) 156 { 157 if (!(mpfn & MIGRATE_PFN_VALID)) 158 return NULL; 159 return pfn_to_page(mpfn >> MIGRATE_PFN_SHIFT); 160 } 161 162 static inline unsigned long migrate_pfn(unsigned long pfn) 163 { 164 return (pfn << MIGRATE_PFN_SHIFT) | MIGRATE_PFN_VALID; 165 } 166 167 enum migrate_vma_direction { 168 MIGRATE_VMA_SELECT_SYSTEM = 1 << 0, 169 MIGRATE_VMA_SELECT_DEVICE_PRIVATE = 1 << 1, 170 MIGRATE_VMA_SELECT_DEVICE_COHERENT = 1 << 2, 171 }; 172 173 struct migrate_vma { 174 struct vm_area_struct *vma; 175 /* 176 * Both src and dst array must be big enough for 177 * (end - start) >> PAGE_SHIFT entries. 178 * 179 * The src array must not be modified by the caller after 180 * migrate_vma_setup(), and must not change the dst array after 181 * migrate_vma_pages() returns. 182 */ 183 unsigned long *dst; 184 unsigned long *src; 185 unsigned long cpages; 186 unsigned long npages; 187 unsigned long start; 188 unsigned long end; 189 190 /* 191 * Set to the owner value also stored in page->pgmap->owner for 192 * migrating out of device private memory. The flags also need to 193 * be set to MIGRATE_VMA_SELECT_DEVICE_PRIVATE. 194 * The caller should always set this field when using mmu notifier 195 * callbacks to avoid device MMU invalidations for device private 196 * pages that are not being migrated. 197 */ 198 void *pgmap_owner; 199 unsigned long flags; 200 }; 201 202 int migrate_vma_setup(struct migrate_vma *args); 203 void migrate_vma_pages(struct migrate_vma *migrate); 204 void migrate_vma_finalize(struct migrate_vma *migrate); 205 #endif /* CONFIG_MIGRATION */ 206 207 #endif /* _LINUX_MIGRATE_H */ 208