1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __LINUX_MEMORY_HOTPLUG_H 3 #define __LINUX_MEMORY_HOTPLUG_H 4 5 #include <linux/mmzone.h> 6 #include <linux/spinlock.h> 7 #include <linux/notifier.h> 8 #include <linux/bug.h> 9 10 struct page; 11 struct zone; 12 struct pglist_data; 13 struct mem_section; 14 struct memory_group; 15 struct resource; 16 struct vmem_altmap; 17 struct dev_pagemap; 18 19 #ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION 20 /* 21 * For supporting node-hotadd, we have to allocate a new pgdat. 22 * 23 * If an arch has generic style NODE_DATA(), 24 * node_data[nid] = kzalloc() works well. But it depends on the architecture. 25 * 26 * In general, generic_alloc_nodedata() is used. 27 * 28 */ 29 extern pg_data_t *arch_alloc_nodedata(int nid); 30 extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat); 31 32 #else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */ 33 34 #define arch_alloc_nodedata(nid) generic_alloc_nodedata(nid) 35 36 #ifdef CONFIG_NUMA 37 /* 38 * XXX: node aware allocation can't work well to get new node's memory at this time. 39 * Because, pgdat for the new node is not allocated/initialized yet itself. 40 * To use new node's memory, more consideration will be necessary. 41 */ 42 #define generic_alloc_nodedata(nid) \ 43 ({ \ 44 memblock_alloc(sizeof(*pgdat), SMP_CACHE_BYTES); \ 45 }) 46 /* 47 * This definition is just for error path in node hotadd. 48 * For node hotremove, we have to replace this. 49 */ 50 #define generic_free_nodedata(pgdat) kfree(pgdat) 51 52 extern pg_data_t *node_data[]; 53 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat) 54 { 55 node_data[nid] = pgdat; 56 } 57 58 #else /* !CONFIG_NUMA */ 59 60 /* never called */ 61 static inline pg_data_t *generic_alloc_nodedata(int nid) 62 { 63 BUG(); 64 return NULL; 65 } 66 static inline void generic_free_nodedata(pg_data_t *pgdat) 67 { 68 } 69 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat) 70 { 71 } 72 #endif /* CONFIG_NUMA */ 73 #endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */ 74 75 #ifdef CONFIG_MEMORY_HOTPLUG 76 struct page *pfn_to_online_page(unsigned long pfn); 77 78 /* Types for control the zone type of onlined and offlined memory */ 79 enum { 80 /* Offline the memory. */ 81 MMOP_OFFLINE = 0, 82 /* Online the memory. Zone depends, see default_zone_for_pfn(). */ 83 MMOP_ONLINE, 84 /* Online the memory to ZONE_NORMAL. */ 85 MMOP_ONLINE_KERNEL, 86 /* Online the memory to ZONE_MOVABLE. */ 87 MMOP_ONLINE_MOVABLE, 88 }; 89 90 /* Flags for add_memory() and friends to specify memory hotplug details. */ 91 typedef int __bitwise mhp_t; 92 93 /* No special request */ 94 #define MHP_NONE ((__force mhp_t)0) 95 /* 96 * Allow merging of the added System RAM resource with adjacent, 97 * mergeable resources. After a successful call to add_memory_resource() 98 * with this flag set, the resource pointer must no longer be used as it 99 * might be stale, or the resource might have changed. 100 */ 101 #define MHP_MERGE_RESOURCE ((__force mhp_t)BIT(0)) 102 103 /* 104 * We want memmap (struct page array) to be self contained. 105 * To do so, we will use the beginning of the hot-added range to build 106 * the page tables for the memmap array that describes the entire range. 107 * Only selected architectures support it with SPARSE_VMEMMAP. 108 */ 109 #define MHP_MEMMAP_ON_MEMORY ((__force mhp_t)BIT(1)) 110 /* 111 * The nid field specifies a memory group id (mgid) instead. The memory group 112 * implies the node id (nid). 113 */ 114 #define MHP_NID_IS_MGID ((__force mhp_t)BIT(2)) 115 116 /* 117 * Extended parameters for memory hotplug: 118 * altmap: alternative allocator for memmap array (optional) 119 * pgprot: page protection flags to apply to newly created page tables 120 * (required) 121 */ 122 struct mhp_params { 123 struct vmem_altmap *altmap; 124 pgprot_t pgprot; 125 struct dev_pagemap *pgmap; 126 }; 127 128 bool mhp_range_allowed(u64 start, u64 size, bool need_mapping); 129 struct range mhp_get_pluggable_range(bool need_mapping); 130 131 /* 132 * Zone resizing functions 133 * 134 * Note: any attempt to resize a zone should has pgdat_resize_lock() 135 * zone_span_writelock() both held. This ensure the size of a zone 136 * can't be changed while pgdat_resize_lock() held. 137 */ 138 static inline unsigned zone_span_seqbegin(struct zone *zone) 139 { 140 return read_seqbegin(&zone->span_seqlock); 141 } 142 static inline int zone_span_seqretry(struct zone *zone, unsigned iv) 143 { 144 return read_seqretry(&zone->span_seqlock, iv); 145 } 146 static inline void zone_span_writelock(struct zone *zone) 147 { 148 write_seqlock(&zone->span_seqlock); 149 } 150 static inline void zone_span_writeunlock(struct zone *zone) 151 { 152 write_sequnlock(&zone->span_seqlock); 153 } 154 static inline void zone_seqlock_init(struct zone *zone) 155 { 156 seqlock_init(&zone->span_seqlock); 157 } 158 extern void adjust_present_page_count(struct page *page, 159 struct memory_group *group, 160 long nr_pages); 161 /* VM interface that may be used by firmware interface */ 162 extern int mhp_init_memmap_on_memory(unsigned long pfn, unsigned long nr_pages, 163 struct zone *zone); 164 extern void mhp_deinit_memmap_on_memory(unsigned long pfn, unsigned long nr_pages); 165 extern int online_pages(unsigned long pfn, unsigned long nr_pages, 166 struct zone *zone, struct memory_group *group); 167 extern void __offline_isolated_pages(unsigned long start_pfn, 168 unsigned long end_pfn); 169 170 typedef void (*online_page_callback_t)(struct page *page, unsigned int order); 171 172 extern void generic_online_page(struct page *page, unsigned int order); 173 extern int set_online_page_callback(online_page_callback_t callback); 174 extern int restore_online_page_callback(online_page_callback_t callback); 175 176 extern int try_online_node(int nid); 177 178 extern int arch_add_memory(int nid, u64 start, u64 size, 179 struct mhp_params *params); 180 extern u64 max_mem_size; 181 182 extern int mhp_online_type_from_str(const char *str); 183 184 /* Default online_type (MMOP_*) when new memory blocks are added. */ 185 extern int mhp_default_online_type; 186 /* If movable_node boot option specified */ 187 extern bool movable_node_enabled; 188 static inline bool movable_node_is_enabled(void) 189 { 190 return movable_node_enabled; 191 } 192 193 extern void arch_remove_memory(u64 start, u64 size, struct vmem_altmap *altmap); 194 extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages, 195 struct vmem_altmap *altmap); 196 197 /* reasonably generic interface to expand the physical pages */ 198 extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages, 199 struct mhp_params *params); 200 201 #ifndef CONFIG_ARCH_HAS_ADD_PAGES 202 static inline int add_pages(int nid, unsigned long start_pfn, 203 unsigned long nr_pages, struct mhp_params *params) 204 { 205 return __add_pages(nid, start_pfn, nr_pages, params); 206 } 207 #else /* ARCH_HAS_ADD_PAGES */ 208 int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages, 209 struct mhp_params *params); 210 #endif /* ARCH_HAS_ADD_PAGES */ 211 212 void get_online_mems(void); 213 void put_online_mems(void); 214 215 void mem_hotplug_begin(void); 216 void mem_hotplug_done(void); 217 218 #else /* ! CONFIG_MEMORY_HOTPLUG */ 219 #define pfn_to_online_page(pfn) \ 220 ({ \ 221 struct page *___page = NULL; \ 222 if (pfn_valid(pfn)) \ 223 ___page = pfn_to_page(pfn); \ 224 ___page; \ 225 }) 226 227 static inline unsigned zone_span_seqbegin(struct zone *zone) 228 { 229 return 0; 230 } 231 static inline int zone_span_seqretry(struct zone *zone, unsigned iv) 232 { 233 return 0; 234 } 235 static inline void zone_span_writelock(struct zone *zone) {} 236 static inline void zone_span_writeunlock(struct zone *zone) {} 237 static inline void zone_seqlock_init(struct zone *zone) {} 238 239 static inline int try_online_node(int nid) 240 { 241 return 0; 242 } 243 244 static inline void get_online_mems(void) {} 245 static inline void put_online_mems(void) {} 246 247 static inline void mem_hotplug_begin(void) {} 248 static inline void mem_hotplug_done(void) {} 249 250 static inline bool movable_node_is_enabled(void) 251 { 252 return false; 253 } 254 #endif /* ! CONFIG_MEMORY_HOTPLUG */ 255 256 /* 257 * Keep this declaration outside CONFIG_MEMORY_HOTPLUG as some 258 * platforms might override and use arch_get_mappable_range() 259 * for internal non memory hotplug purposes. 260 */ 261 struct range arch_get_mappable_range(void); 262 263 #if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT) 264 /* 265 * pgdat resizing functions 266 */ 267 static inline 268 void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags) 269 { 270 spin_lock_irqsave(&pgdat->node_size_lock, *flags); 271 } 272 static inline 273 void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags) 274 { 275 spin_unlock_irqrestore(&pgdat->node_size_lock, *flags); 276 } 277 static inline 278 void pgdat_resize_init(struct pglist_data *pgdat) 279 { 280 spin_lock_init(&pgdat->node_size_lock); 281 } 282 #else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */ 283 /* 284 * Stub functions for when hotplug is off 285 */ 286 static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {} 287 static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {} 288 static inline void pgdat_resize_init(struct pglist_data *pgdat) {} 289 #endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */ 290 291 #ifdef CONFIG_MEMORY_HOTREMOVE 292 293 extern void try_offline_node(int nid); 294 extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages, 295 struct zone *zone, struct memory_group *group); 296 extern int remove_memory(u64 start, u64 size); 297 extern void __remove_memory(u64 start, u64 size); 298 extern int offline_and_remove_memory(u64 start, u64 size); 299 300 #else 301 static inline void try_offline_node(int nid) {} 302 303 static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages, 304 struct zone *zone, struct memory_group *group) 305 { 306 return -EINVAL; 307 } 308 309 static inline int remove_memory(u64 start, u64 size) 310 { 311 return -EBUSY; 312 } 313 314 static inline void __remove_memory(u64 start, u64 size) {} 315 #endif /* CONFIG_MEMORY_HOTREMOVE */ 316 317 extern void set_zone_contiguous(struct zone *zone); 318 extern void clear_zone_contiguous(struct zone *zone); 319 320 #ifdef CONFIG_MEMORY_HOTPLUG 321 extern void __ref free_area_init_core_hotplug(struct pglist_data *pgdat); 322 extern int __add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags); 323 extern int add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags); 324 extern int add_memory_resource(int nid, struct resource *resource, 325 mhp_t mhp_flags); 326 extern int add_memory_driver_managed(int nid, u64 start, u64 size, 327 const char *resource_name, 328 mhp_t mhp_flags); 329 extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn, 330 unsigned long nr_pages, 331 struct vmem_altmap *altmap, int migratetype); 332 extern void remove_pfn_range_from_zone(struct zone *zone, 333 unsigned long start_pfn, 334 unsigned long nr_pages); 335 extern int sparse_add_section(int nid, unsigned long pfn, 336 unsigned long nr_pages, struct vmem_altmap *altmap, 337 struct dev_pagemap *pgmap); 338 extern void sparse_remove_section(struct mem_section *ms, 339 unsigned long pfn, unsigned long nr_pages, 340 unsigned long map_offset, struct vmem_altmap *altmap); 341 extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map, 342 unsigned long pnum); 343 extern struct zone *zone_for_pfn_range(int online_type, int nid, 344 struct memory_group *group, unsigned long start_pfn, 345 unsigned long nr_pages); 346 extern int arch_create_linear_mapping(int nid, u64 start, u64 size, 347 struct mhp_params *params); 348 void arch_remove_linear_mapping(u64 start, u64 size); 349 extern bool mhp_supports_memmap_on_memory(unsigned long size); 350 #endif /* CONFIG_MEMORY_HOTPLUG */ 351 352 #endif /* __LINUX_MEMORY_HOTPLUG_H */ 353