Merge tag 'mm-hotfixes-stable-2023-05-03-16-27' of git://git.kernel.org/pub/scm/linux...
[linux-block.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;
836809ec 14struct memory_group;
62cedb9f 15struct resource;
24e6d5a5 16struct vmem_altmap;
e3246d8f 17struct dev_pagemap;
78679302 18
e930d999
MH
19#ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION
20/*
21 * For supporting node-hotadd, we have to allocate a new pgdat.
22 *
23 * If an arch has generic style NODE_DATA(),
24 * node_data[nid] = kzalloc() works well. But it depends on the architecture.
25 *
26 * In general, generic_alloc_nodedata() is used.
e930d999
MH
27 *
28 */
29extern pg_data_t *arch_alloc_nodedata(int nid);
e930d999
MH
30extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
31
32#else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
33
34#define arch_alloc_nodedata(nid) generic_alloc_nodedata(nid)
e930d999
MH
35
36#ifdef CONFIG_NUMA
37/*
38 * XXX: node aware allocation can't work well to get new node's memory at this time.
39 * Because, pgdat for the new node is not allocated/initialized yet itself.
40 * To use new node's memory, more consideration will be necessary.
41 */
42#define generic_alloc_nodedata(nid) \
43({ \
09f49dca 44 memblock_alloc(sizeof(*pgdat), SMP_CACHE_BYTES); \
e930d999 45})
e930d999
MH
46
47extern pg_data_t *node_data[];
48static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
49{
50 node_data[nid] = pgdat;
51}
52
53#else /* !CONFIG_NUMA */
54
55/* never called */
56static inline pg_data_t *generic_alloc_nodedata(int nid)
57{
58 BUG();
59 return NULL;
60}
e930d999
MH
61static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
62{
63}
64#endif /* CONFIG_NUMA */
65#endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
66
208d54e5 67#ifdef CONFIG_MEMORY_HOTPLUG
9f605f26 68struct page *pfn_to_online_page(unsigned long pfn);
04753278 69
4f7c6b49 70/* Types for control the zone type of onlined and offlined memory */
511c2aba 71enum {
956f8b44 72 /* Offline the memory. */
efc978ad 73 MMOP_OFFLINE = 0,
956f8b44
DH
74 /* Online the memory. Zone depends, see default_zone_for_pfn(). */
75 MMOP_ONLINE,
76 /* Online the memory to ZONE_NORMAL. */
4f7c6b49 77 MMOP_ONLINE_KERNEL,
956f8b44 78 /* Online the memory to ZONE_MOVABLE. */
4f7c6b49 79 MMOP_ONLINE_MOVABLE,
511c2aba
LJ
80};
81
b6117199
DH
82/* Flags for add_memory() and friends to specify memory hotplug details. */
83typedef int __bitwise mhp_t;
84
85/* No special request */
86#define MHP_NONE ((__force mhp_t)0)
9ca6551e
DH
87/*
88 * Allow merging of the added System RAM resource with adjacent,
89 * mergeable resources. After a successful call to add_memory_resource()
90 * with this flag set, the resource pointer must no longer be used as it
91 * might be stale, or the resource might have changed.
92 */
26011267 93#define MHP_MERGE_RESOURCE ((__force mhp_t)BIT(0))
b6117199 94
a08a2ae3
OS
95/*
96 * We want memmap (struct page array) to be self contained.
97 * To do so, we will use the beginning of the hot-added range to build
98 * the page tables for the memmap array that describes the entire range.
99 * Only selected architectures support it with SPARSE_VMEMMAP.
100 */
101#define MHP_MEMMAP_ON_MEMORY ((__force mhp_t)BIT(1))
028fc57a
DH
102/*
103 * The nid field specifies a memory group id (mgid) instead. The memory group
104 * implies the node id (nid).
105 */
106#define MHP_NID_IS_MGID ((__force mhp_t)BIT(2))
a08a2ae3 107
940519f0 108/*
f5637d3b
LG
109 * Extended parameters for memory hotplug:
110 * altmap: alternative allocator for memmap array (optional)
bfeb022f
LG
111 * pgprot: page protection flags to apply to newly created page tables
112 * (required)
940519f0 113 */
f5637d3b 114struct mhp_params {
940519f0 115 struct vmem_altmap *altmap;
bfeb022f 116 pgprot_t pgprot;
e3246d8f 117 struct dev_pagemap *pgmap;
940519f0
MH
118};
119
bca3feaa
AK
120bool mhp_range_allowed(u64 start, u64 size, bool need_mapping);
121struct range mhp_get_pluggable_range(bool need_mapping);
122
bdc8cb98
DH
123/*
124 * Zone resizing functions
511c2aba
LJ
125 *
126 * Note: any attempt to resize a zone should has pgdat_resize_lock()
127 * zone_span_writelock() both held. This ensure the size of a zone
128 * can't be changed while pgdat_resize_lock() held.
bdc8cb98
DH
129 */
130static inline unsigned zone_span_seqbegin(struct zone *zone)
131{
132 return read_seqbegin(&zone->span_seqlock);
133}
134static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
135{
136 return read_seqretry(&zone->span_seqlock, iv);
137}
138static inline void zone_span_writelock(struct zone *zone)
139{
140 write_seqlock(&zone->span_seqlock);
141}
142static inline void zone_span_writeunlock(struct zone *zone)
143{
144 write_sequnlock(&zone->span_seqlock);
145}
146static inline void zone_seqlock_init(struct zone *zone)
147{
148 seqlock_init(&zone->span_seqlock);
149}
836809ec
DH
150extern void adjust_present_page_count(struct page *page,
151 struct memory_group *group,
152 long nr_pages);
3947be19 153/* VM interface that may be used by firmware interface */
a08a2ae3
OS
154extern int mhp_init_memmap_on_memory(unsigned long pfn, unsigned long nr_pages,
155 struct zone *zone);
156extern void mhp_deinit_memmap_on_memory(unsigned long pfn, unsigned long nr_pages);
bd5c2344 157extern int online_pages(unsigned long pfn, unsigned long nr_pages,
836809ec 158 struct zone *zone, struct memory_group *group);
257bea71
DH
159extern void __offline_isolated_pages(unsigned long start_pfn,
160 unsigned long end_pfn);
48e94196 161
a9cd410a 162typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
9d0ad8ca 163
18db1491 164extern void generic_online_page(struct page *page, unsigned int order);
9d0ad8ca
DK
165extern int set_online_page_callback(online_page_callback_t callback);
166extern int restore_online_page_callback(online_page_callback_t callback);
167
01b0f197
TK
168extern int try_online_node(int nid);
169
940519f0 170extern int arch_add_memory(int nid, u64 start, u64 size,
f5637d3b 171 struct mhp_params *params);
357b4da5
JG
172extern u64 max_mem_size;
173
1adf8b46 174extern int mhp_online_type_from_str(const char *str);
5f47adf7 175
862919e5 176/* Default online_type (MMOP_*) when new memory blocks are added. */
1adf8b46 177extern int mhp_default_online_type;
4932381e
MH
178/* If movable_node boot option specified */
179extern bool movable_node_enabled;
180static inline bool movable_node_is_enabled(void)
181{
182 return movable_node_enabled;
183}
31bc3858 184
65a2aa5f 185extern void arch_remove_memory(u64 start, u64 size, struct vmem_altmap *altmap);
feee6b29
DH
186extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages,
187 struct vmem_altmap *altmap);
49ac8255 188
f1dd2cd1 189/* reasonably generic interface to expand the physical pages */
24e6d5a5 190extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
f5637d3b 191 struct mhp_params *params);
bc02af93 192
3072e413
MH
193#ifndef CONFIG_ARCH_HAS_ADD_PAGES
194static inline int add_pages(int nid, unsigned long start_pfn,
f5637d3b 195 unsigned long nr_pages, struct mhp_params *params)
3072e413 196{
f5637d3b 197 return __add_pages(nid, start_pfn, nr_pages, params);
3072e413
MH
198}
199#else /* ARCH_HAS_ADD_PAGES */
24e6d5a5 200int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
f5637d3b 201 struct mhp_params *params);
3072e413
MH
202#endif /* ARCH_HAS_ADD_PAGES */
203
bfc8c901
VD
204void get_online_mems(void);
205void put_online_mems(void);
20d6c96b 206
30467e0b
DR
207void mem_hotplug_begin(void);
208void mem_hotplug_done(void);
209
b4a0215e
KW
210/* See kswapd_is_running() */
211static inline void pgdat_kswapd_lock(pg_data_t *pgdat)
212{
213 mutex_lock(&pgdat->kswapd_lock);
214}
215
216static inline void pgdat_kswapd_unlock(pg_data_t *pgdat)
217{
218 mutex_unlock(&pgdat->kswapd_lock);
219}
220
221static inline void pgdat_kswapd_lock_init(pg_data_t *pgdat)
222{
223 mutex_init(&pgdat->kswapd_lock);
224}
225
208d54e5 226#else /* ! CONFIG_MEMORY_HOTPLUG */
2d070eab
MH
227#define pfn_to_online_page(pfn) \
228({ \
229 struct page *___page = NULL; \
230 if (pfn_valid(pfn)) \
231 ___page = pfn_to_page(pfn); \
232 ___page; \
233 })
234
bdc8cb98
DH
235static inline unsigned zone_span_seqbegin(struct zone *zone)
236{
237 return 0;
238}
239static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
240{
241 return 0;
242}
243static inline void zone_span_writelock(struct zone *zone) {}
244static inline void zone_span_writeunlock(struct zone *zone) {}
245static inline void zone_seqlock_init(struct zone *zone) {}
3947be19 246
01b0f197
TK
247static inline int try_online_node(int nid)
248{
249 return 0;
250}
251
bfc8c901
VD
252static inline void get_online_mems(void) {}
253static inline void put_online_mems(void) {}
20d6c96b 254
30467e0b
DR
255static inline void mem_hotplug_begin(void) {}
256static inline void mem_hotplug_done(void) {}
257
4932381e
MH
258static inline bool movable_node_is_enabled(void)
259{
260 return false;
261}
b4a0215e
KW
262
263static inline void pgdat_kswapd_lock(pg_data_t *pgdat) {}
264static inline void pgdat_kswapd_unlock(pg_data_t *pgdat) {}
265static inline void pgdat_kswapd_lock_init(pg_data_t *pgdat) {}
bdc8cb98 266#endif /* ! CONFIG_MEMORY_HOTPLUG */
9d99aaa3 267
bca3feaa
AK
268/*
269 * Keep this declaration outside CONFIG_MEMORY_HOTPLUG as some
270 * platforms might override and use arch_get_mappable_range()
271 * for internal non memory hotplug purposes.
272 */
273struct range arch_get_mappable_range(void);
274
3a2d7fa8
PT
275#if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT)
276/*
277 * pgdat resizing functions
278 */
279static inline
280void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
281{
282 spin_lock_irqsave(&pgdat->node_size_lock, *flags);
283}
284static inline
285void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
286{
287 spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
288}
289static inline
290void pgdat_resize_init(struct pglist_data *pgdat)
291{
292 spin_lock_init(&pgdat->node_size_lock);
293}
294#else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
295/*
296 * Stub functions for when hotplug is off
297 */
298static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
299static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
300static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
301#endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
302
5c755e9f
BP
303#ifdef CONFIG_MEMORY_HOTREMOVE
304
90b30cdc 305extern void try_offline_node(int nid);
836809ec 306extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages,
395f6081 307 struct zone *zone, struct memory_group *group);
e1c158e4
DH
308extern int remove_memory(u64 start, u64 size);
309extern void __remove_memory(u64 start, u64 size);
310extern int offline_and_remove_memory(u64 start, u64 size);
5c755e9f
BP
311
312#else
90b30cdc 313static inline void try_offline_node(int nid) {}
aba6efc4 314
836809ec 315static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages,
395f6081 316 struct zone *zone, struct memory_group *group)
aba6efc4
RW
317{
318 return -EINVAL;
319}
320
e1c158e4 321static inline int remove_memory(u64 start, u64 size)
eca499ab
PT
322{
323 return -EBUSY;
324}
325
e1c158e4 326static inline void __remove_memory(u64 start, u64 size) {}
5c755e9f
BP
327#endif /* CONFIG_MEMORY_HOTREMOVE */
328
aba9817d
BDC
329extern void set_zone_contiguous(struct zone *zone);
330extern void clear_zone_contiguous(struct zone *zone);
331
3a0aaefe 332#ifdef CONFIG_MEMORY_HOTPLUG
70b5b46a 333extern void __ref free_area_init_core_hotplug(struct pglist_data *pgdat);
b6117199
DH
334extern int __add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
335extern int add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
336extern int add_memory_resource(int nid, struct resource *resource,
337 mhp_t mhp_flags);
7b7b2721 338extern int add_memory_driver_managed(int nid, u64 start, u64 size,
b6117199
DH
339 const char *resource_name,
340 mhp_t mhp_flags);
f1dd2cd1 341extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
d882c006
DH
342 unsigned long nr_pages,
343 struct vmem_altmap *altmap, int migratetype);
feee6b29
DH
344extern void remove_pfn_range_from_zone(struct zone *zone,
345 unsigned long start_pfn,
346 unsigned long nr_pages);
7ea62160 347extern int sparse_add_section(int nid, unsigned long pfn,
e3246d8f
JM
348 unsigned long nr_pages, struct vmem_altmap *altmap,
349 struct dev_pagemap *pgmap);
ba72b4c8 350extern void sparse_remove_section(struct mem_section *ms,
7ea62160 351 unsigned long pfn, unsigned long nr_pages,
24b6d416 352 unsigned long map_offset, struct vmem_altmap *altmap);
04753278
YG
353extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
354 unsigned long pnum);
7cf209ba 355extern struct zone *zone_for_pfn_range(int online_type, int nid,
445fcf7c
DH
356 struct memory_group *group, unsigned long start_pfn,
357 unsigned long nr_pages);
4abb1e5b
DH
358extern int arch_create_linear_mapping(int nid, u64 start, u64 size,
359 struct mhp_params *params);
360void arch_remove_linear_mapping(u64 start, u64 size);
a08a2ae3 361extern bool mhp_supports_memmap_on_memory(unsigned long size);
3a0aaefe
DH
362#endif /* CONFIG_MEMORY_HOTPLUG */
363
208d54e5 364#endif /* __LINUX_MEMORY_HOTPLUG_H */