LXR linux/include/linux/memory

   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
  10struct page;
  11struct zone;
  12struct pglist_data;
  13struct mem_section;
  14struct memory_block;
  15struct 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 ___nr = pfn_to_section_nr(pfn);   \
  27                                                        \
  28        if (___nr < NR_MEM_SECTIONS && online_section_nr(___nr))\
  29                ___page = pfn_to_page(pfn);             \
  30        ___page;                                        \
  31})
  32
  33/*
  34 * Types for free bootmem stored in page->lru.next. These have to be in
  35 * some random range in unsigned long space for debugging purposes.
  36 */
  37enum {
  38        MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE = 12,
  39        SECTION_INFO = MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE,
  40        MIX_SECTION_INFO,
  41        NODE_INFO,
  42        MEMORY_HOTPLUG_MAX_BOOTMEM_TYPE = NODE_INFO,
  43};
  44
  45/* Types for control the zone type of onlined and offlined memory */
  46enum {
  47        MMOP_OFFLINE = -1,
  48        MMOP_ONLINE_KEEP,
  49        MMOP_ONLINE_KERNEL,
  50        MMOP_ONLINE_MOVABLE,
  51};
  52
  53/*
  54 * pgdat resizing functions
  55 */
  56static inline
  57void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
  58{
  59        spin_lock_irqsave(&pgdat->node_size_lock, *flags);
  60}
  61static inline
  62void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
  63{
  64        spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
  65}
  66static inline
  67void pgdat_resize_init(struct pglist_data *pgdat)
  68{
  69        spin_lock_init(&pgdat->node_size_lock);
  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 */
  78static inline unsigned zone_span_seqbegin(struct zone *zone)
  79{
  80        return read_seqbegin(&zone->span_seqlock);
  81}
  82static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
  83{
  84        return read_seqretry(&zone->span_seqlock, iv);
  85}
  86static inline void zone_span_writelock(struct zone *zone)
  87{
  88        write_seqlock(&zone->span_seqlock);
  89}
  90static inline void zone_span_writeunlock(struct zone *zone)
  91{
  92        write_sequnlock(&zone->span_seqlock);
  93}
  94static inline void zone_seqlock_init(struct zone *zone)
  95{
  96        seqlock_init(&zone->span_seqlock);
  97}
  98extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
  99extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
 100extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
 101/* VM interface that may be used by firmware interface */
 102extern int online_pages(unsigned long, unsigned long, int);
 103extern int test_pages_in_a_zone(unsigned long start_pfn, unsigned long end_pfn,
 104        unsigned long *valid_start, unsigned long *valid_end);
 105extern void __offline_isolated_pages(unsigned long, unsigned long);
 106
 107typedef void (*online_page_callback_t)(struct page *page);
 108
 109extern int set_online_page_callback(online_page_callback_t callback);
 110extern int restore_online_page_callback(online_page_callback_t callback);
 111
 112extern void __online_page_set_limits(struct page *page);
 113extern void __online_page_increment_counters(struct page *page);
 114extern void __online_page_free(struct page *page);
 115
 116extern int try_online_node(int nid);
 117
 118extern bool memhp_auto_online;
 119/* If movable_node boot option specified */
 120extern bool movable_node_enabled;
 121static inline bool movable_node_is_enabled(void)
 122{
 123        return movable_node_enabled;
 124}
 125
 126#ifdef CONFIG_MEMORY_HOTREMOVE
 127extern bool is_pageblock_removable_nolock(struct page *page);
 128extern int arch_remove_memory(u64 start, u64 size);
 129extern int __remove_pages(struct zone *zone, unsigned long start_pfn,
 130        unsigned long nr_pages);
 131#endif /* CONFIG_MEMORY_HOTREMOVE */
 132
 133/* reasonably generic interface to expand the physical pages */
 134extern int __add_pages(int nid, unsigned long start_pfn,
 135        unsigned long nr_pages, bool want_memblock);
 136
 137#ifndef CONFIG_ARCH_HAS_ADD_PAGES
 138static inline int add_pages(int nid, unsigned long start_pfn,
 139                            unsigned long nr_pages, bool want_memblock)
 140{
 141        return __add_pages(nid, start_pfn, nr_pages, want_memblock);
 142}
 143#else /* ARCH_HAS_ADD_PAGES */
 144int add_pages(int nid, unsigned long start_pfn,
 145              unsigned long nr_pages, bool want_memblock);
 146#endif /* ARCH_HAS_ADD_PAGES */
 147
 148#ifdef CONFIG_NUMA
 149extern int memory_add_physaddr_to_nid(u64 start);
 150#else
 151static 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 */
 168extern pg_data_t *arch_alloc_nodedata(int nid);
 169extern void arch_free_nodedata(pg_data_t *pgdat);
 170extern 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
 194extern pg_data_t *node_data[];
 195static 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 */
 203static inline pg_data_t *generic_alloc_nodedata(int nid)
 204{
 205        BUG();
 206        return NULL;
 207}
 208static inline void generic_free_nodedata(pg_data_t *pgdat)
 209{
 210}
 211static 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
 218extern void __init register_page_bootmem_info_node(struct pglist_data *pgdat);
 219#else
 220static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 221{
 222}
 223#endif
 224extern void put_page_bootmem(struct page *page);
 225extern void get_page_bootmem(unsigned long ingo, struct page *page,
 226                             unsigned long type);
 227
 228void get_online_mems(void);
 229void put_online_mems(void);
 230
 231void mem_hotplug_begin(void);
 232void mem_hotplug_done(void);
 233
 234extern void set_zone_contiguous(struct zone *zone);
 235extern void clear_zone_contiguous(struct zone *zone);
 236
 237#else /* ! CONFIG_MEMORY_HOTPLUG */
 238#define pfn_to_online_page(pfn)                 \
 239({                                              \
 240        struct page *___page = NULL;            \
 241        if (pfn_valid(pfn))                     \
 242                ___page = pfn_to_page(pfn);     \
 243        ___page;                                \
 244 })
 245
 246/*
 247 * Stub functions for when hotplug is off
 248 */
 249static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
 250static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
 251static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
 252
 253static inline unsigned zone_span_seqbegin(struct zone *zone)
 254{
 255        return 0;
 256}
 257static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
 258{
 259        return 0;
 260}
 261static inline void zone_span_writelock(struct zone *zone) {}
 262static inline void zone_span_writeunlock(struct zone *zone) {}
 263static inline void zone_seqlock_init(struct zone *zone) {}
 264
 265static inline int mhp_notimplemented(const char *func)
 266{
 267        printk(KERN_WARNING "%s() called, with CONFIG_MEMORY_HOTPLUG disabled\n", func);
 268        dump_stack();
 269        return -ENOSYS;
 270}
 271
 272static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
 273{
 274}
 275
 276static inline int try_online_node(int nid)
 277{
 278        return 0;
 279}
 280
 281static inline void get_online_mems(void) {}
 282static inline void put_online_mems(void) {}
 283
 284static inline void mem_hotplug_begin(void) {}
 285static inline void mem_hotplug_done(void) {}
 286
 287static inline bool movable_node_is_enabled(void)
 288{
 289        return false;
 290}
 291#endif /* ! CONFIG_MEMORY_HOTPLUG */
 292
 293#ifdef CONFIG_MEMORY_HOTREMOVE
 294
 295extern bool is_mem_section_removable(unsigned long pfn, unsigned long nr_pages);
 296extern void try_offline_node(int nid);
 297extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
 298extern void remove_memory(int nid, u64 start, u64 size);
 299
 300#else
 301static inline bool is_mem_section_removable(unsigned long pfn,
 302                                        unsigned long nr_pages)
 303{
 304        return false;
 305}
 306
 307static inline void try_offline_node(int nid) {}
 308
 309static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
 310{
 311        return -EINVAL;
 312}
 313
 314static inline void remove_memory(int nid, u64 start, u64 size) {}
 315#endif /* CONFIG_MEMORY_HOTREMOVE */
 316
 317extern int walk_memory_range(unsigned long start_pfn, unsigned long end_pfn,
 318                void *arg, int (*func)(struct memory_block *, void *));
 319extern int add_memory(int nid, u64 start, u64 size);
 320extern int add_memory_resource(int nid, struct resource *resource, bool online);
 321extern int arch_add_memory(int nid, u64 start, u64 size, bool want_memblock);
 322extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
 323                unsigned long nr_pages);
 324extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
 325extern bool is_memblock_offlined(struct memory_block *mem);
 326extern void remove_memory(int nid, u64 start, u64 size);
 327extern int sparse_add_one_section(struct pglist_data *pgdat, unsigned long start_pfn);
 328extern void sparse_remove_one_section(struct zone *zone, struct mem_section *ms,
 329                unsigned long map_offset);
 330extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
 331                                          unsigned long pnum);
 332extern bool allow_online_pfn_range(int nid, unsigned long pfn, unsigned long nr_pages,
 333                int online_type);
 334extern struct zone *zone_for_pfn_range(int online_type, int nid, unsigned start_pfn,
 335                unsigned long nr_pages);
 336#endif /* __LINUX_MEMORY_HOTPLUG_H */
 337