]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/memory_hotplug.h
Merge branch 'pci/microchip'
[mirror_ubuntu-jammy-kernel.git] / include / linux / memory_hotplug.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
208d54e5
DH
2#ifndef __LINUX_MEMORY_HOTPLUG_H
3#define __LINUX_MEMORY_HOTPLUG_H
4
5#include <linux/mmzone.h>
6#include <linux/spinlock.h>
3947be19 7#include <linux/notifier.h>
187f1882 8#include <linux/bug.h>
208d54e5 9
78679302
KH
10struct page;
11struct zone;
12struct pglist_data;
ea01ea93 13struct mem_section;
e90bdb7f 14struct memory_block;
62cedb9f 15struct resource;
24e6d5a5 16struct vmem_altmap;
78679302 17
208d54e5 18#ifdef CONFIG_MEMORY_HOTPLUG
2d070eab
MH
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 */
b13bc351
QC
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; \
2d070eab 34})
04753278
YG
35
36/*
5f24ce5f
AA
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.
04753278 39 */
5f24ce5f
AA
40enum {
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};
04753278 47
4f7c6b49 48/* Types for control the zone type of onlined and offlined memory */
511c2aba 49enum {
956f8b44 50 /* Offline the memory. */
efc978ad 51 MMOP_OFFLINE = 0,
956f8b44
DH
52 /* Online the memory. Zone depends, see default_zone_for_pfn(). */
53 MMOP_ONLINE,
54 /* Online the memory to ZONE_NORMAL. */
4f7c6b49 55 MMOP_ONLINE_KERNEL,
956f8b44 56 /* Online the memory to ZONE_MOVABLE. */
4f7c6b49 57 MMOP_ONLINE_MOVABLE,
511c2aba
LJ
58};
59
b6117199
DH
60/* Flags for add_memory() and friends to specify memory hotplug details. */
61typedef int __bitwise mhp_t;
62
63/* No special request */
64#define MHP_NONE ((__force mhp_t)0)
9ca6551e
DH
65/*
66 * Allow merging of the added System RAM resource with adjacent,
67 * mergeable resources. After a successful call to add_memory_resource()
68 * with this flag set, the resource pointer must no longer be used as it
69 * might be stale, or the resource might have changed.
70 */
71#define MEMHP_MERGE_RESOURCE ((__force mhp_t)BIT(0))
b6117199 72
940519f0 73/*
f5637d3b
LG
74 * Extended parameters for memory hotplug:
75 * altmap: alternative allocator for memmap array (optional)
bfeb022f
LG
76 * pgprot: page protection flags to apply to newly created page tables
77 * (required)
940519f0 78 */
f5637d3b 79struct mhp_params {
940519f0 80 struct vmem_altmap *altmap;
bfeb022f 81 pgprot_t pgprot;
940519f0
MH
82};
83
bdc8cb98
DH
84/*
85 * Zone resizing functions
511c2aba
LJ
86 *
87 * Note: any attempt to resize a zone should has pgdat_resize_lock()
88 * zone_span_writelock() both held. This ensure the size of a zone
89 * can't be changed while pgdat_resize_lock() held.
bdc8cb98
DH
90 */
91static inline unsigned zone_span_seqbegin(struct zone *zone)
92{
93 return read_seqbegin(&zone->span_seqlock);
94}
95static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
96{
97 return read_seqretry(&zone->span_seqlock, iv);
98}
99static inline void zone_span_writelock(struct zone *zone)
100{
101 write_seqlock(&zone->span_seqlock);
102}
103static inline void zone_span_writeunlock(struct zone *zone)
104{
105 write_sequnlock(&zone->span_seqlock);
106}
107static inline void zone_seqlock_init(struct zone *zone)
108{
109 seqlock_init(&zone->span_seqlock);
110}
3947be19
DH
111extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
112extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
113extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
3947be19 114/* VM interface that may be used by firmware interface */
bd5c2344
DH
115extern int online_pages(unsigned long pfn, unsigned long nr_pages,
116 int online_type, int nid);
92917998
DH
117extern struct zone *test_pages_in_a_zone(unsigned long start_pfn,
118 unsigned long end_pfn);
257bea71
DH
119extern void __offline_isolated_pages(unsigned long start_pfn,
120 unsigned long end_pfn);
48e94196 121
a9cd410a 122typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
9d0ad8ca 123
18db1491 124extern void generic_online_page(struct page *page, unsigned int order);
9d0ad8ca
DK
125extern int set_online_page_callback(online_page_callback_t callback);
126extern int restore_online_page_callback(online_page_callback_t callback);
127
01b0f197
TK
128extern int try_online_node(int nid);
129
940519f0 130extern int arch_add_memory(int nid, u64 start, u64 size,
f5637d3b 131 struct mhp_params *params);
357b4da5
JG
132extern u64 max_mem_size;
133
5f47adf7
DH
134extern int memhp_online_type_from_str(const char *str);
135
862919e5
DH
136/* Default online_type (MMOP_*) when new memory blocks are added. */
137extern int memhp_default_online_type;
4932381e
MH
138/* If movable_node boot option specified */
139extern bool movable_node_enabled;
140static inline bool movable_node_is_enabled(void)
141{
142 return movable_node_enabled;
143}
31bc3858 144
ac5c9426
DH
145extern void arch_remove_memory(int nid, u64 start, u64 size,
146 struct vmem_altmap *altmap);
feee6b29
DH
147extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages,
148 struct vmem_altmap *altmap);
49ac8255 149
f1dd2cd1 150/* reasonably generic interface to expand the physical pages */
24e6d5a5 151extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
f5637d3b 152 struct mhp_params *params);
bc02af93 153
3072e413
MH
154#ifndef CONFIG_ARCH_HAS_ADD_PAGES
155static inline int add_pages(int nid, unsigned long start_pfn,
f5637d3b 156 unsigned long nr_pages, struct mhp_params *params)
3072e413 157{
f5637d3b 158 return __add_pages(nid, start_pfn, nr_pages, params);
3072e413
MH
159}
160#else /* ARCH_HAS_ADD_PAGES */
24e6d5a5 161int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
f5637d3b 162 struct mhp_params *params);
3072e413
MH
163#endif /* ARCH_HAS_ADD_PAGES */
164
306d6cbe
YG
165#ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION
166/*
167 * For supporting node-hotadd, we have to allocate a new pgdat.
168 *
169 * If an arch has generic style NODE_DATA(),
170 * node_data[nid] = kzalloc() works well. But it depends on the architecture.
171 *
172 * In general, generic_alloc_nodedata() is used.
173 * Now, arch_free_nodedata() is just defined for error path of node_hot_add.
174 *
175 */
dd0932d9
YG
176extern pg_data_t *arch_alloc_nodedata(int nid);
177extern void arch_free_nodedata(pg_data_t *pgdat);
7049027c 178extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
306d6cbe
YG
179
180#else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
181
182#define arch_alloc_nodedata(nid) generic_alloc_nodedata(nid)
183#define arch_free_nodedata(pgdat) generic_free_nodedata(pgdat)
184
185#ifdef CONFIG_NUMA
186/*
187 * If ARCH_HAS_NODEDATA_EXTENSION=n, this func is used to allocate pgdat.
188 * XXX: kmalloc_node() can't work well to get new node's memory at this time.
189 * Because, pgdat for the new node is not allocated/initialized yet itself.
190 * To use new node's memory, more consideration will be necessary.
191 */
192#define generic_alloc_nodedata(nid) \
193({ \
194 kzalloc(sizeof(pg_data_t), GFP_KERNEL); \
195})
196/*
197 * This definition is just for error path in node hotadd.
198 * For node hotremove, we have to replace this.
199 */
200#define generic_free_nodedata(pgdat) kfree(pgdat)
201
10ad400b
YG
202extern pg_data_t *node_data[];
203static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
204{
205 node_data[nid] = pgdat;
206}
207
306d6cbe
YG
208#else /* !CONFIG_NUMA */
209
210/* never called */
211static inline pg_data_t *generic_alloc_nodedata(int nid)
212{
213 BUG();
214 return NULL;
215}
216static inline void generic_free_nodedata(pg_data_t *pgdat)
217{
218}
10ad400b
YG
219static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
220{
221}
306d6cbe
YG
222#endif /* CONFIG_NUMA */
223#endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
224
46723bfa 225#ifdef CONFIG_HAVE_BOOTMEM_INFO_NODE
7ded384a 226extern void __init register_page_bootmem_info_node(struct pglist_data *pgdat);
46723bfa 227#else
04753278
YG
228static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
229{
230}
04753278 231#endif
46723bfa
YI
232extern void put_page_bootmem(struct page *page);
233extern void get_page_bootmem(unsigned long ingo, struct page *page,
234 unsigned long type);
04753278 235
bfc8c901
VD
236void get_online_mems(void);
237void put_online_mems(void);
20d6c96b 238
30467e0b
DR
239void mem_hotplug_begin(void);
240void mem_hotplug_done(void);
241
208d54e5 242#else /* ! CONFIG_MEMORY_HOTPLUG */
2d070eab
MH
243#define pfn_to_online_page(pfn) \
244({ \
245 struct page *___page = NULL; \
246 if (pfn_valid(pfn)) \
247 ___page = pfn_to_page(pfn); \
248 ___page; \
249 })
250
bdc8cb98
DH
251static inline unsigned zone_span_seqbegin(struct zone *zone)
252{
253 return 0;
254}
255static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
256{
257 return 0;
258}
259static inline void zone_span_writelock(struct zone *zone) {}
260static inline void zone_span_writeunlock(struct zone *zone) {}
261static inline void zone_seqlock_init(struct zone *zone) {}
3947be19 262
04753278
YG
263static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
264{
265}
266
01b0f197
TK
267static inline int try_online_node(int nid)
268{
269 return 0;
270}
271
bfc8c901
VD
272static inline void get_online_mems(void) {}
273static inline void put_online_mems(void) {}
20d6c96b 274
30467e0b
DR
275static inline void mem_hotplug_begin(void) {}
276static inline void mem_hotplug_done(void) {}
277
4932381e
MH
278static inline bool movable_node_is_enabled(void)
279{
280 return false;
281}
bdc8cb98 282#endif /* ! CONFIG_MEMORY_HOTPLUG */
9d99aaa3 283
3a2d7fa8
PT
284#if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT)
285/*
286 * pgdat resizing functions
287 */
288static inline
289void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
290{
291 spin_lock_irqsave(&pgdat->node_size_lock, *flags);
292}
293static inline
294void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
295{
296 spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
297}
298static inline
299void pgdat_resize_init(struct pglist_data *pgdat)
300{
301 spin_lock_init(&pgdat->node_size_lock);
302}
303#else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
304/*
305 * Stub functions for when hotplug is off
306 */
307static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
308static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
309static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
310#endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
311
5c755e9f
BP
312#ifdef CONFIG_MEMORY_HOTREMOVE
313
90b30cdc 314extern void try_offline_node(int nid);
aba6efc4 315extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
eca499ab 316extern int remove_memory(int nid, u64 start, u64 size);
d15e5926 317extern void __remove_memory(int nid, u64 start, u64 size);
08b3acd7 318extern int offline_and_remove_memory(int nid, u64 start, u64 size);
5c755e9f
BP
319
320#else
90b30cdc 321static inline void try_offline_node(int nid) {}
aba6efc4
RW
322
323static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
324{
325 return -EINVAL;
326}
327
eca499ab
PT
328static inline int remove_memory(int nid, u64 start, u64 size)
329{
330 return -EBUSY;
331}
332
d15e5926 333static inline void __remove_memory(int nid, u64 start, u64 size) {}
5c755e9f
BP
334#endif /* CONFIG_MEMORY_HOTREMOVE */
335
aba9817d
BDC
336extern void set_zone_contiguous(struct zone *zone);
337extern void clear_zone_contiguous(struct zone *zone);
338
3a0aaefe 339#ifdef CONFIG_MEMORY_HOTPLUG
03e85f9d 340extern void __ref free_area_init_core_hotplug(int nid);
b6117199
DH
341extern int __add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
342extern int add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
343extern int add_memory_resource(int nid, struct resource *resource,
344 mhp_t mhp_flags);
7b7b2721 345extern int add_memory_driver_managed(int nid, u64 start, u64 size,
b6117199
DH
346 const char *resource_name,
347 mhp_t mhp_flags);
f1dd2cd1 348extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
d882c006
DH
349 unsigned long nr_pages,
350 struct vmem_altmap *altmap, int migratetype);
feee6b29
DH
351extern void remove_pfn_range_from_zone(struct zone *zone,
352 unsigned long start_pfn,
353 unsigned long nr_pages);
6677e3ea 354extern bool is_memblock_offlined(struct memory_block *mem);
7ea62160
DW
355extern int sparse_add_section(int nid, unsigned long pfn,
356 unsigned long nr_pages, struct vmem_altmap *altmap);
ba72b4c8 357extern void sparse_remove_section(struct mem_section *ms,
7ea62160 358 unsigned long pfn, unsigned long nr_pages,
24b6d416 359 unsigned long map_offset, struct vmem_altmap *altmap);
04753278
YG
360extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
361 unsigned long pnum);
e5e68930 362extern struct zone *zone_for_pfn_range(int online_type, int nid, unsigned start_pfn,
c246a213 363 unsigned long nr_pages);
4abb1e5b
DH
364extern int arch_create_linear_mapping(int nid, u64 start, u64 size,
365 struct mhp_params *params);
366void arch_remove_linear_mapping(u64 start, u64 size);
3a0aaefe
DH
367#endif /* CONFIG_MEMORY_HOTPLUG */
368
208d54e5 369#endif /* __LINUX_MEMORY_HOTPLUG_H */