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 = -1,
  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  * Restrictions for the memory hotplug:
  62  * flags:  MHP_ flags
  63  * altmap: alternative allocator for memmap array
  64  */
  65 struct mhp_restrictions {
  66         unsigned long flags;
  67         struct vmem_altmap *altmap;
  68 };
  69
  70 /*
  71  * Zone resizing functions
  72  *
  73  * Note: any attempt to resize a zone should has pgdat_resize_lock()
  74  * zone_span_writelock() both held. This ensure the size of a zone
  75  * can't be changed while pgdat_resize_lock() held.
  76  */
  77 static inline unsigned zone_span_seqbegin(struct zone *zone)
  78 {
  79         return read_seqbegin(&zone->span_seqlock);
  80 }
  81 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
  82 {
  83         return read_seqretry(&zone->span_seqlock, iv);
  84 }
  85 static inline void zone_span_writelock(struct zone *zone)
  86 {
  87         write_seqlock(&zone->span_seqlock);
  88 }
  89 static inline void zone_span_writeunlock(struct zone *zone)
  90 {
  91         write_sequnlock(&zone->span_seqlock);
  92 }
  93 static inline void zone_seqlock_init(struct zone *zone)
  94 {
  95         seqlock_init(&zone->span_seqlock);
  96 }
  97 extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
  98 extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
  99 extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
 100 /* VM interface that may be used by firmware interface */
 101 extern int online_pages(unsigned long pfn, unsigned long nr_pages,
 102                         int online_type, int nid);
 103 extern struct zone *test_pages_in_a_zone(unsigned long start_pfn,
 104                                          unsigned long end_pfn);
 105 extern unsigned long __offline_isolated_pages(unsigned long start_pfn,
 106                                                 unsigned long end_pfn);
 107
 108 typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
 109
 110 extern void generic_online_page(struct page *page, unsigned int order);
 111 extern int set_online_page_callback(online_page_callback_t callback);
 112 extern int restore_online_page_callback(online_page_callback_t callback);
 113
 114 extern int try_online_node(int nid);
 115
 116 extern int arch_add_memory(int nid, u64 start, u64 size,
 117                         struct mhp_restrictions *restrictions);
 118 extern u64 max_mem_size;
 119
 120 extern bool memhp_auto_online;
 121 /* If movable_node boot option specified */
 122 extern bool movable_node_enabled;
 123 static inline bool movable_node_is_enabled(void)
 124 {
 125         return movable_node_enabled;
 126 }
 127
 128 extern void arch_remove_memory(int nid, u64 start, u64 size,
 129                                struct vmem_altmap *altmap);
 130 extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages,
 131                            struct vmem_altmap *altmap);
 132
 133 /* reasonably generic interface to expand the physical pages */
 134 extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
 135                        struct mhp_restrictions *restrictions);
 136
 137 #ifndef CONFIG_ARCH_HAS_ADD_PAGES
 138 static inline int add_pages(int nid, unsigned long start_pfn,
 139                 unsigned long nr_pages, struct mhp_restrictions *restrictions)
 140 {
 141         return __add_pages(nid, start_pfn, nr_pages, restrictions);
 142 }
 143 #else /* ARCH_HAS_ADD_PAGES */
 144 int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
 145               struct mhp_restrictions *restrictions);
 146 #endif /* ARCH_HAS_ADD_PAGES */
 147
 148 #ifdef CONFIG_NUMA
 149 extern int memory_add_physaddr_to_nid(u64 start);
 150 #else
 151 static inline int memory_add_physaddr_to_nid(u64 start)
 152 {
 153         return 0;
 154 }
 155 #endif
 156
 157 #ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION
 158 /*
 159  * For supporting node-hotadd, we have to allocate a new pgdat.
 160  *
 161  * If an arch has generic style NODE_DATA(),
 162  * node_data[nid] = kzalloc() works well. But it depends on the architecture.
 163  *
 164  * In general, generic_alloc_nodedata() is used.
 165  * Now, arch_free_nodedata() is just defined for error path of node_hot_add.
 166  *
 167  */
 168 extern pg_data_t *arch_alloc_nodedata(int nid);
 169 extern void arch_free_nodedata(pg_data_t *pgdat);
 170 extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
 171
 172 #else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 173
 174 #define arch_alloc_nodedata(nid)        generic_alloc_nodedata(nid)
 175 #define arch_free_nodedata(pgdat)       generic_free_nodedata(pgdat)
 176
 177 #ifdef CONFIG_NUMA
 178 /*
 179  * If ARCH_HAS_NODEDATA_EXTENSION=n, this func is used to allocate pgdat.
 180  * XXX: kmalloc_node() can't work well to get new node's memory at this time.
 181  *      Because, pgdat for the new node is not allocated/initialized yet itself.
 182  *      To use new node's memory, more consideration will be necessary.
 183  */
 184 #define generic_alloc_nodedata(nid)                             \
 185 ({                                                              \
 186         kzalloc(sizeof(pg_data_t), GFP_KERNEL);                 \
 187 })
 188 /*
 189  * This definition is just for error path in node hotadd.
 190  * For node hotremove, we have to replace this.
 191  */
 192 #define generic_free_nodedata(pgdat)    kfree(pgdat)
 193
 194 extern pg_data_t *node_data[];
 195 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 196 {
 197         node_data[nid] = pgdat;
 198 }
 199
 200 #else /* !CONFIG_NUMA */
 201
 202 /* never called */
 203 static inline pg_data_t *generic_alloc_nodedata(int nid)
 204 {
 205         BUG();
 206         return NULL;
 207 }
 208 static inline void generic_free_nodedata(pg_data_t *pgdat)
 209 {
 210 }
 211 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 212 {
 213 }
 214 #endif /* CONFIG_NUMA */
 215 #endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 216
 217 #ifdef CONFIG_HAVE_BOOTMEM_INFO_NODE
 218 extern void __init register_page_bootmem_info_node(struct pglist_data *pgdat);
 219 #else
 220 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 221 {
 222 }
 223 #endif
 224 extern void put_page_bootmem(struct page *page);
 225 extern void get_page_bootmem(unsigned long ingo, struct page *page,
 226                              unsigned long type);
 227
 228 void get_online_mems(void);
 229 void put_online_mems(void);
 230
 231 void mem_hotplug_begin(void);
 232 void mem_hotplug_done(void);
 233
 234 #else /* ! CONFIG_MEMORY_HOTPLUG */
 235 #define pfn_to_online_page(pfn)                 \
 236 ({                                              \
 237         struct page *___page = NULL;            \
 238         if (pfn_valid(pfn))                     \
 239                 ___page = pfn_to_page(pfn);     \
 240         ___page;                                \
 241  })
 242
 243 static inline unsigned zone_span_seqbegin(struct zone *zone)
 244 {
 245         return 0;
 246 }
 247 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
 248 {
 249         return 0;
 250 }
 251 static inline void zone_span_writelock(struct zone *zone) {}
 252 static inline void zone_span_writeunlock(struct zone *zone) {}
 253 static inline void zone_seqlock_init(struct zone *zone) {}
 254
 255 static inline int mhp_notimplemented(const char *func)
 256 {
 257         printk(KERN_WARNING "%s() called, with CONFIG_MEMORY_HOTPLUG disabled\n", func);
 258         dump_stack();
 259         return -ENOSYS;
 260 }
 261
 262 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 263 {
 264 }
 265
 266 static inline int try_online_node(int nid)
 267 {
 268         return 0;
 269 }
 270
 271 static inline void get_online_mems(void) {}
 272 static inline void put_online_mems(void) {}
 273
 274 static inline void mem_hotplug_begin(void) {}
 275 static inline void mem_hotplug_done(void) {}
 276
 277 static inline bool movable_node_is_enabled(void)
 278 {
 279         return false;
 280 }
 281 #endif /* ! CONFIG_MEMORY_HOTPLUG */
 282
 283 #if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT)
 284 /*
 285  * pgdat resizing functions
 286  */
 287 static inline
 288 void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
 289 {
 290         spin_lock_irqsave(&pgdat->node_size_lock, *flags);
 291 }
 292 static inline
 293 void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
 294 {
 295         spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
 296 }
 297 static inline
 298 void pgdat_resize_init(struct pglist_data *pgdat)
 299 {
 300         spin_lock_init(&pgdat->node_size_lock);
 301 }
 302 #else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
 303 /*
 304  * Stub functions for when hotplug is off
 305  */
 306 static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
 307 static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
 308 static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
 309 #endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
 310
 311 #ifdef CONFIG_MEMORY_HOTREMOVE
 312
 313 extern bool is_mem_section_removable(unsigned long pfn, unsigned long nr_pages);
 314 extern void try_offline_node(int nid);
 315 extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
 316 extern int remove_memory(int nid, u64 start, u64 size);
 317 extern void __remove_memory(int nid, u64 start, u64 size);
 318
 319 #else
 320 static inline bool is_mem_section_removable(unsigned long pfn,
 321                                         unsigned long nr_pages)
 322 {
 323         return false;
 324 }
 325
 326 static inline void try_offline_node(int nid) {}
 327
 328 static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
 329 {
 330         return -EINVAL;
 331 }
 332
 333 static inline int remove_memory(int nid, u64 start, u64 size)
 334 {
 335         return -EBUSY;
 336 }
 337
 338 static inline void __remove_memory(int nid, u64 start, u64 size) {}
 339 #endif /* CONFIG_MEMORY_HOTREMOVE */
 340
 341 extern void set_zone_contiguous(struct zone *zone);
 342 extern void clear_zone_contiguous(struct zone *zone);
 343
 344 extern void __ref free_area_init_core_hotplug(int nid);
 345 extern int __add_memory(int nid, u64 start, u64 size);
 346 extern int add_memory(int nid, u64 start, u64 size);
 347 extern int add_memory_resource(int nid, struct resource *resource);
 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 */