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