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 struct page *pfn_to_online_page(unsigned long pfn);
  20
  21 /* Types for control the zone type of onlined and offlined memory */
  22 enum {
  23         /* Offline the memory. */
  24         MMOP_OFFLINE = 0,
  25         /* Online the memory. Zone depends, see default_zone_for_pfn(). */
  26         MMOP_ONLINE,
  27         /* Online the memory to ZONE_NORMAL. */
  28         MMOP_ONLINE_KERNEL,
  29         /* Online the memory to ZONE_MOVABLE. */
  30         MMOP_ONLINE_MOVABLE,
  31 };
  32
  33 /* Flags for add_memory() and friends to specify memory hotplug details. */
  34 typedef int __bitwise mhp_t;
  35
  36 /* No special request */
  37 #define MHP_NONE                ((__force mhp_t)0)
  38 /*
  39  * Allow merging of the added System RAM resource with adjacent,
  40  * mergeable resources. After a successful call to add_memory_resource()
  41  * with this flag set, the resource pointer must no longer be used as it
  42  * might be stale, or the resource might have changed.
  43  */
  44 #define MHP_MERGE_RESOURCE      ((__force mhp_t)BIT(0))
  45
  46 /*
  47  * We want memmap (struct page array) to be self contained.
  48  * To do so, we will use the beginning of the hot-added range to build
  49  * the page tables for the memmap array that describes the entire range.
  50  * Only selected architectures support it with SPARSE_VMEMMAP.
  51  */
  52 #define MHP_MEMMAP_ON_MEMORY   ((__force mhp_t)BIT(1))
  53
  54 /*
  55  * Extended parameters for memory hotplug:
  56  * altmap: alternative allocator for memmap array (optional)
  57  * pgprot: page protection flags to apply to newly created page tables
  58  *      (required)
  59  */
  60 struct mhp_params {
  61         struct vmem_altmap *altmap;
  62         pgprot_t pgprot;
  63 };
  64
  65 bool mhp_range_allowed(u64 start, u64 size, bool need_mapping);
  66 struct range mhp_get_pluggable_range(bool need_mapping);
  67
  68 /*
  69  * Zone resizing functions
  70  *
  71  * Note: any attempt to resize a zone should has pgdat_resize_lock()
  72  * zone_span_writelock() both held. This ensure the size of a zone
  73  * can't be changed while pgdat_resize_lock() held.
  74  */
  75 static inline unsigned zone_span_seqbegin(struct zone *zone)
  76 {
  77         return read_seqbegin(&zone->span_seqlock);
  78 }
  79 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
  80 {
  81         return read_seqretry(&zone->span_seqlock, iv);
  82 }
  83 static inline void zone_span_writelock(struct zone *zone)
  84 {
  85         write_seqlock(&zone->span_seqlock);
  86 }
  87 static inline void zone_span_writeunlock(struct zone *zone)
  88 {
  89         write_sequnlock(&zone->span_seqlock);
  90 }
  91 static inline void zone_seqlock_init(struct zone *zone)
  92 {
  93         seqlock_init(&zone->span_seqlock);
  94 }
  95 extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
  96 extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
  97 extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
  98 extern void adjust_present_page_count(struct zone *zone, long nr_pages);
  99 /* VM interface that may be used by firmware interface */
 100 extern int mhp_init_memmap_on_memory(unsigned long pfn, unsigned long nr_pages,
 101                                      struct zone *zone);
 102 extern void mhp_deinit_memmap_on_memory(unsigned long pfn, unsigned long nr_pages);
 103 extern int online_pages(unsigned long pfn, unsigned long nr_pages,
 104                         struct zone *zone);
 105 extern struct zone *test_pages_in_a_zone(unsigned long start_pfn,
 106                                          unsigned long end_pfn);
 107 extern void __offline_isolated_pages(unsigned long start_pfn,
 108                                      unsigned long end_pfn);
 109
 110 typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
 111
 112 extern void generic_online_page(struct page *page, unsigned int order);
 113 extern int set_online_page_callback(online_page_callback_t callback);
 114 extern int restore_online_page_callback(online_page_callback_t callback);
 115
 116 extern int try_online_node(int nid);
 117
 118 extern int arch_add_memory(int nid, u64 start, u64 size,
 119                            struct mhp_params *params);
 120 extern u64 max_mem_size;
 121
 122 extern int mhp_online_type_from_str(const char *str);
 123
 124 /* Default online_type (MMOP_*) when new memory blocks are added. */
 125 extern int mhp_default_online_type;
 126 /* If movable_node boot option specified */
 127 extern bool movable_node_enabled;
 128 static inline bool movable_node_is_enabled(void)
 129 {
 130         return movable_node_enabled;
 131 }
 132
 133 extern void arch_remove_memory(u64 start, u64 size, 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_HAVE_ARCH_NODEDATA_EXTENSION
 153 /*
 154  * For supporting node-hotadd, we have to allocate a new pgdat.
 155  *
 156  * If an arch has generic style NODE_DATA(),
 157  * node_data[nid] = kzalloc() works well. But it depends on the architecture.
 158  *
 159  * In general, generic_alloc_nodedata() is used.
 160  * Now, arch_free_nodedata() is just defined for error path of node_hot_add.
 161  *
 162  */
 163 extern pg_data_t *arch_alloc_nodedata(int nid);
 164 extern void arch_free_nodedata(pg_data_t *pgdat);
 165 extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
 166
 167 #else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 168
 169 #define arch_alloc_nodedata(nid)        generic_alloc_nodedata(nid)
 170 #define arch_free_nodedata(pgdat)       generic_free_nodedata(pgdat)
 171
 172 #ifdef CONFIG_NUMA
 173 /*
 174  * If ARCH_HAS_NODEDATA_EXTENSION=n, this func is used to allocate pgdat.
 175  * XXX: kmalloc_node() can't work well to get new node's memory at this time.
 176  *      Because, pgdat for the new node is not allocated/initialized yet itself.
 177  *      To use new node's memory, more consideration will be necessary.
 178  */
 179 #define generic_alloc_nodedata(nid)                             \
 180 ({                                                              \
 181         kzalloc(sizeof(pg_data_t), GFP_KERNEL);                 \
 182 })
 183 /*
 184  * This definition is just for error path in node hotadd.
 185  * For node hotremove, we have to replace this.
 186  */
 187 #define generic_free_nodedata(pgdat)    kfree(pgdat)
 188
 189 extern pg_data_t *node_data[];
 190 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 191 {
 192         node_data[nid] = pgdat;
 193 }
 194
 195 #else /* !CONFIG_NUMA */
 196
 197 /* never called */
 198 static inline pg_data_t *generic_alloc_nodedata(int nid)
 199 {
 200         BUG();
 201         return NULL;
 202 }
 203 static inline void generic_free_nodedata(pg_data_t *pgdat)
 204 {
 205 }
 206 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
 207 {
 208 }
 209 #endif /* CONFIG_NUMA */
 210 #endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
 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 extern int remove_memory(u64 start, u64 size);
 296 extern void __remove_memory(u64 start, u64 size);
 297 extern int offline_and_remove_memory(u64 start, u64 size);
 298
 299 #else
 300 static inline void try_offline_node(int nid) {}
 301
 302 static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
 303 {
 304         return -EINVAL;
 305 }
 306
 307 static inline int remove_memory(u64 start, u64 size)
 308 {
 309         return -EBUSY;
 310 }
 311
 312 static inline void __remove_memory(u64 start, u64 size) {}
 313 #endif /* CONFIG_MEMORY_HOTREMOVE */
 314
 315 extern void set_zone_contiguous(struct zone *zone);
 316 extern void clear_zone_contiguous(struct zone *zone);
 317
 318 #ifdef CONFIG_MEMORY_HOTPLUG
 319 extern void __ref free_area_init_core_hotplug(int nid);
 320 extern int __add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
 321 extern int add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
 322 extern int add_memory_resource(int nid, struct resource *resource,
 323                                mhp_t mhp_flags);
 324 extern int add_memory_driver_managed(int nid, u64 start, u64 size,
 325                                      const char *resource_name,
 326                                      mhp_t mhp_flags);
 327 extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
 328                                    unsigned long nr_pages,
 329                                    struct vmem_altmap *altmap, int migratetype);
 330 extern void remove_pfn_range_from_zone(struct zone *zone,
 331                                        unsigned long start_pfn,
 332                                        unsigned long nr_pages);
 333 extern bool is_memblock_offlined(struct memory_block *mem);
 334 extern int sparse_add_section(int nid, unsigned long pfn,
 335                 unsigned long nr_pages, struct vmem_altmap *altmap);
 336 extern void sparse_remove_section(struct mem_section *ms,
 337                 unsigned long pfn, unsigned long nr_pages,
 338                 unsigned long map_offset, struct vmem_altmap *altmap);
 339 extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
 340                                           unsigned long pnum);
 341 extern struct zone *zone_for_pfn_range(int online_type, int nid,
 342                 unsigned long start_pfn, unsigned long nr_pages);
 343 extern int arch_create_linear_mapping(int nid, u64 start, u64 size,
 344                                       struct mhp_params *params);
 345 void arch_remove_linear_mapping(u64 start, u64 size);
 346 extern bool mhp_supports_memmap_on_memory(unsigned long size);
 347 #endif /* CONFIG_MEMORY_HOTPLUG */
 348
 349 #endif /* __LINUX_MEMORY_HOTPLUG_H */