include/linux/memory_hotplug.h

   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_block;
  15 struct resource;
  16 struct vmem_altmap;
  17
  18 #ifdef CONFIG_MEMORY_HOTPLUG
  19 /*
  20  * Return page for the valid pfn only if the page is online. All pfn
  21  * walkers which rely on the fully initialized page->flags and others
  22  * should use this rather than pfn_valid && pfn_to_page
  23  */
  24 #define pfn_to_online_page(pfn)                                    \
  25 ({                                                                 \
  26         struct page *___page = NULL;                               \
  27         unsigned long ___pfn = pfn;                                \
  28         unsigned long ___nr = pfn_to_section_nr(___pfn);           \
  29                                                                    \
  30         if (___nr < NR_MEM_SECTIONS && online_section_nr(___nr) && \
  31             pfn_valid_within(___pfn))                              \
  32                 ___page = pfn_to_page(___pfn);                     \
  33         ___page;                                                   \
  34 })
  35
  36 /*
  37  * Types for free bootmem stored in page->lru.next. These have to be in
  38  * some random range in unsigned long space for debugging purposes.
  39  */
  40 enum {
  41         MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE = 12,
  42         SECTION_INFO = MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE,
  43         MIX_SECTION_INFO,
  44         NODE_INFO,
  45         MEMORY_HOTPLUG_MAX_BOOTMEM_TYPE = NODE_INFO,
  46 };
  47
  48 /* Types for control the zone type of onlined and offlined memory */
  49 enum {
  50         /* Offline the memory. */
  51         MMOP_OFFLINE = 0,
  52         /* Online the memory. Zone depends, see default_zone_for_pfn(). */
  53         MMOP_ONLINE,
  54         /* Online the memory to ZONE_NORMAL. */
  55         MMOP_ONLINE_KERNEL,
  56         /* Online the memory to ZONE_MOVABLE. */
  57         MMOP_ONLINE_MOVABLE,
  58 };
  59
  60 /*
  61  * Extended parameters for memory hotplug:
  62  * altmap: alternative allocator for memmap array (optional)
  63  * pgprot: page protection flags to apply to newly created page tables
  64  *      (required)
  65  */
  66 struct mhp_params {
  67         struct vmem_altmap *altmap;
  68         pgprot_t pgprot;
  69 };
  70
  71 /*
  72  * Zone resizing functions
  73  *
  74  * Note: any attempt to resize a zone should has pgdat_resize_lock()
  75  * zone_span_writelock() both held. This ensure the size of a zone
  76  * can't be changed while pgdat_resize_lock() held.
  77  */
  78 static inline unsigned zone_span_seqbegin(struct zone *zone)
  79 {
  80         return read_seqbegin(&zone->span_seqlock);
  81 }
  82 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
  83 {
  84         return read_seqretry(&zone->span_seqlock, iv);
  85 }
  86 static inline void zone_span_writelock(struct zone *zone)
  87 {
  88         write_seqlock(&zone->span_seqlock);
  89 }
  90 static inline void zone_span_writeunlock(struct zone *zone)
  91 {
  92         write_sequnlock(&zone->span_seqlock);
  93 }
  94 static inline void zone_seqlock_init(struct zone *zone)
  95 {
  96         seqlock_init(&zone->span_seqlock);
  97 }
  98 extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
  99 extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
 100 extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
 101 /* VM interface that may be used by firmware interface */
 102 extern int online_pages(unsigned long pfn, unsigned long nr_pages,
 103                         int online_type, int nid);
 104 extern struct zone *test_pages_in_a_zone(unsigned long start_pfn,
 105                                          unsigned long end_pfn);
 106 extern unsigned long __offline_isolated_pages(unsigned long start_pfn,
 107                                                 unsigned long end_pfn);
 108
 109 typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
 110
 111 extern void generic_online_page(struct page *page, unsigned int order);
 112 extern int set_online_page_callback(online_page_callback_t callback);
 113 extern int restore_online_page_callback(online_page_callback_t callback);
 114
 115 extern int try_online_node(int nid);
 116
 117 extern int arch_add_memory(int nid, u64 start, u64 size,
 118                            struct mhp_params *params);
 119 extern u64 max_mem_size;
 120
 121 extern int memhp_online_type_from_str(const char *str);
 122
 123 /* Default online_type (MMOP_*) when new memory blocks are added. */
 124 extern int memhp_default_online_type;
 125 /* If movable_node boot option specified */
 126 extern bool movable_node_enabled;
 127 static inline bool movable_node_is_enabled(void)
 128 {
 129         return movable_node_enabled;
 130 }
 131
 132 extern void arch_remove_memory(int nid, u64 start, u64 size,
 133                                struct vmem_altmap *altmap);
 134 extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages,
 135                            struct vmem_altmap *altmap);
 136
 137 /* reasonably generic interface to expand the physical pages */
 138 extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
 139                        struct mhp_params *params);
 140
 141 #ifndef CONFIG_ARCH_HAS_ADD_PAGES
 142 static inline int add_pages(int nid, unsigned long start_pfn,
 143                 unsigned long nr_pages, struct mhp_params *params)
 144 {
 145         return __add_pages(nid, start_pfn, nr_pages, params);
 146 }
 147 #else /* ARCH_HAS_ADD_PAGES */
 148 int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
 149               struct mhp_params *params);
 150 #endif /* ARCH_HAS_ADD_PAGES */
 151
 152 #ifdef CONFIG_NUMA
 153 extern int memory_add_physaddr_to_nid(u64 start);
 154 #else
 155 static inline int memory_add_physaddr_to_nid(u64 start)
 156 {
 157         return 0;
 158 }
 159 #endif
 160
 161 #ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION
 162 /*
 163  * For supporting node-hotadd, we have to allocate a new pgdat.
 164  *
 165  * If an arch has generic style NODE_DATA(),
 166  * node_data[nid] = kzalloc() works well. But it depends on the architecture.
 167  *
 168  * In general, generic_alloc_nodedata() is used.
 169  * Now, arch_free_nodedata() is just defined for error path of node_hot_add.
 170  *
 171  */
 172 extern pg_data_t *arch_alloc_nodedata(int nid);
 173 extern void arch_free_nodedata(pg_data_t *pgdat);
 174 extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
 175
 176 #else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 177
 178 #define arch_alloc_nodedata(nid)        generic_alloc_nodedata(nid)
 179 #define arch_free_nodedata(pgdat)       generic_free_nodedata(pgdat)
 180
 181 #ifdef CONFIG_NUMA
 182 /*
 183  * If ARCH_HAS_NODEDATA_EXTENSION=n, this func is used to allocate pgdat.
 184  * XXX: kmalloc_node() can't work well to get new node's memory at this time.
 185  *      Because, pgdat for the new node is not allocated/initialized yet itself.
 186  *      To use new node's memory, more consideration will be necessary.
 187  */
 188 #define generic_alloc_nodedata(nid)                             \
 189 ({                                                              \
 190         kzalloc(sizeof(pg_data_t), GFP_KERNEL);                 \
 191 })
 192 /*
 193  * This definition is just for error path in node hotadd.
 194  * For node hotremove, we have to replace this.
 195  */
 196 #define generic_free_nodedata(pgdat)    kfree(pgdat)
 197
 198 extern pg_data_t *node_data[];
 199 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 200 {
 201         node_data[nid] = pgdat;
 202 }
 203
 204 #else /* !CONFIG_NUMA */
 205
 206 /* never called */
 207 static inline pg_data_t *generic_alloc_nodedata(int nid)
 208 {
 209         BUG();
 210         return NULL;
 211 }
 212 static inline void generic_free_nodedata(pg_data_t *pgdat)
 213 {
 214 }
 215 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 216 {
 217 }
 218 #endif /* CONFIG_NUMA */
 219 #endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 220
 221 #ifdef CONFIG_HAVE_BOOTMEM_INFO_NODE
 222 extern void __init register_page_bootmem_info_node(struct pglist_data *pgdat);
 223 #else
 224 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 225 {
 226 }
 227 #endif
 228 extern void put_page_bootmem(struct page *page);
 229 extern void get_page_bootmem(unsigned long ingo, struct page *page,
 230                              unsigned long type);
 231
 232 void get_online_mems(void);
 233 void put_online_mems(void);
 234
 235 void mem_hotplug_begin(void);
 236 void mem_hotplug_done(void);
 237
 238 #else /* ! CONFIG_MEMORY_HOTPLUG */
 239 #define pfn_to_online_page(pfn)                 \
 240 ({                                              \
 241         struct page *___page = NULL;            \
 242         if (pfn_valid(pfn))                     \
 243                 ___page = pfn_to_page(pfn);     \
 244         ___page;                                \
 245  })
 246
 247 static inline unsigned zone_span_seqbegin(struct zone *zone)
 248 {
 249         return 0;
 250 }
 251 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
 252 {
 253         return 0;
 254 }
 255 static inline void zone_span_writelock(struct zone *zone) {}
 256 static inline void zone_span_writeunlock(struct zone *zone) {}
 257 static inline void zone_seqlock_init(struct zone *zone) {}
 258
 259 static inline int mhp_notimplemented(const char *func)
 260 {
 261         printk(KERN_WARNING "%s() called, with CONFIG_MEMORY_HOTPLUG disabled\n", func);
 262         dump_stack();
 263         return -ENOSYS;
 264 }
 265
 266 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 267 {
 268 }
 269
 270 static inline int try_online_node(int nid)
 271 {
 272         return 0;
 273 }
 274
 275 static inline void get_online_mems(void) {}
 276 static inline void put_online_mems(void) {}
 277
 278 static inline void mem_hotplug_begin(void) {}
 279 static inline void mem_hotplug_done(void) {}
 280
 281 static inline bool movable_node_is_enabled(void)
 282 {
 283         return false;
 284 }
 285 #endif /* ! CONFIG_MEMORY_HOTPLUG */
 286
 287 #if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT)
 288 /*
 289  * pgdat resizing functions
 290  */
 291 static inline
 292 void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
 293 {
 294         spin_lock_irqsave(&pgdat->node_size_lock, *flags);
 295 }
 296 static inline
 297 void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
 298 {
 299         spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
 300 }
 301 static inline
 302 void pgdat_resize_init(struct pglist_data *pgdat)
 303 {
 304         spin_lock_init(&pgdat->node_size_lock);
 305 }
 306 #else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
 307 /*
 308  * Stub functions for when hotplug is off
 309  */
 310 static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
 311 static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
 312 static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
 313 #endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
 314
 315 #ifdef CONFIG_MEMORY_HOTREMOVE
 316
 317 extern void try_offline_node(int nid);
 318 extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
 319 extern int remove_memory(int nid, u64 start, u64 size);
 320 extern void __remove_memory(int nid, u64 start, u64 size);
 321 extern int offline_and_remove_memory(int nid, u64 start, u64 size);
 322
 323 #else
 324 static inline void try_offline_node(int nid) {}
 325
 326 static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
 327 {
 328         return -EINVAL;
 329 }
 330
 331 static inline int remove_memory(int nid, u64 start, u64 size)
 332 {
 333         return -EBUSY;
 334 }
 335
 336 static inline void __remove_memory(int nid, u64 start, u64 size) {}
 337 #endif /* CONFIG_MEMORY_HOTREMOVE */
 338
 339 extern void set_zone_contiguous(struct zone *zone);
 340 extern void clear_zone_contiguous(struct zone *zone);
 341
 342 extern void __ref free_area_init_core_hotplug(int nid);
 343 extern int __add_memory(int nid, u64 start, u64 size);
 344 extern int add_memory(int nid, u64 start, u64 size);
 345 extern int add_memory_resource(int nid, struct resource *resource);
 346 extern int add_memory_driver_managed(int nid, u64 start, u64 size,
 347                                      const char *resource_name);
 348 extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
 349                 unsigned long nr_pages, struct vmem_altmap *altmap);
 350 extern void remove_pfn_range_from_zone(struct zone *zone,
 351                                        unsigned long start_pfn,
 352                                        unsigned long nr_pages);
 353 extern bool is_memblock_offlined(struct memory_block *mem);
 354 extern int sparse_add_section(int nid, unsigned long pfn,
 355                 unsigned long nr_pages, struct vmem_altmap *altmap);
 356 extern void sparse_remove_section(struct mem_section *ms,
 357                 unsigned long pfn, unsigned long nr_pages,
 358                 unsigned long map_offset, struct vmem_altmap *altmap);
 359 extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
 360                                           unsigned long pnum);
 361 extern bool allow_online_pfn_range(int nid, unsigned long pfn, unsigned long nr_pages,
 362                 int online_type);
 363 extern struct zone *zone_for_pfn_range(int online_type, int nid, unsigned start_pfn,
 364                 unsigned long nr_pages);
 365 #endif /* __LINUX_MEMORY_HOTPLUG_H */