Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 memory_group;
16struct resource;
17struct vmem_altmap;
18
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.
27 *
28 */
29extern pg_data_t *arch_alloc_nodedata(int nid);
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)
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({ \
44 memblock_alloc(sizeof(*pgdat), SMP_CACHE_BYTES); \
45})
46/*
47 * This definition is just for error path in node hotadd.
48 * For node hotremove, we have to replace this.
49 */
50#define generic_free_nodedata(pgdat) kfree(pgdat)
51
52extern pg_data_t *node_data[];
53static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
54{
55 node_data[nid] = pgdat;
56}
57
58#else /* !CONFIG_NUMA */
59
60/* never called */
61static inline pg_data_t *generic_alloc_nodedata(int nid)
62{
63 BUG();
64 return NULL;
65}
66static inline void generic_free_nodedata(pg_data_t *pgdat)
67{
68}
69static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
70{
71}
72#endif /* CONFIG_NUMA */
73#endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
74
75#ifdef CONFIG_MEMORY_HOTPLUG
76struct page *pfn_to_online_page(unsigned long pfn);
77
78/* Types for control the zone type of onlined and offlined memory */
79enum {
80 /* Offline the memory. */
81 MMOP_OFFLINE = 0,
82 /* Online the memory. Zone depends, see default_zone_for_pfn(). */
83 MMOP_ONLINE,
84 /* Online the memory to ZONE_NORMAL. */
85 MMOP_ONLINE_KERNEL,
86 /* Online the memory to ZONE_MOVABLE. */
87 MMOP_ONLINE_MOVABLE,
88};
89
90/* Flags for add_memory() and friends to specify memory hotplug details. */
91typedef int __bitwise mhp_t;
92
93/* No special request */
94#define MHP_NONE ((__force mhp_t)0)
95/*
96 * Allow merging of the added System RAM resource with adjacent,
97 * mergeable resources. After a successful call to add_memory_resource()
98 * with this flag set, the resource pointer must no longer be used as it
99 * might be stale, or the resource might have changed.
100 */
101#define MHP_MERGE_RESOURCE ((__force mhp_t)BIT(0))
102
103/*
104 * We want memmap (struct page array) to be self contained.
105 * To do so, we will use the beginning of the hot-added range to build
106 * the page tables for the memmap array that describes the entire range.
107 * Only selected architectures support it with SPARSE_VMEMMAP.
108 */
109#define MHP_MEMMAP_ON_MEMORY ((__force mhp_t)BIT(1))
110/*
111 * The nid field specifies a memory group id (mgid) instead. The memory group
112 * implies the node id (nid).
113 */
114#define MHP_NID_IS_MGID ((__force mhp_t)BIT(2))
115
116/*
117 * Extended parameters for memory hotplug:
118 * altmap: alternative allocator for memmap array (optional)
119 * pgprot: page protection flags to apply to newly created page tables
120 * (required)
121 */
122struct mhp_params {
123 struct vmem_altmap *altmap;
124 pgprot_t pgprot;
125};
126
127bool mhp_range_allowed(u64 start, u64 size, bool need_mapping);
128struct range mhp_get_pluggable_range(bool need_mapping);
129
130/*
131 * Zone resizing functions
132 *
133 * Note: any attempt to resize a zone should has pgdat_resize_lock()
134 * zone_span_writelock() both held. This ensure the size of a zone
135 * can't be changed while pgdat_resize_lock() held.
136 */
137static inline unsigned zone_span_seqbegin(struct zone *zone)
138{
139 return read_seqbegin(&zone->span_seqlock);
140}
141static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
142{
143 return read_seqretry(&zone->span_seqlock, iv);
144}
145static inline void zone_span_writelock(struct zone *zone)
146{
147 write_seqlock(&zone->span_seqlock);
148}
149static inline void zone_span_writeunlock(struct zone *zone)
150{
151 write_sequnlock(&zone->span_seqlock);
152}
153static inline void zone_seqlock_init(struct zone *zone)
154{
155 seqlock_init(&zone->span_seqlock);
156}
157extern void adjust_present_page_count(struct page *page,
158 struct memory_group *group,
159 long nr_pages);
160/* VM interface that may be used by firmware interface */
161extern int mhp_init_memmap_on_memory(unsigned long pfn, unsigned long nr_pages,
162 struct zone *zone);
163extern void mhp_deinit_memmap_on_memory(unsigned long pfn, unsigned long nr_pages);
164extern int online_pages(unsigned long pfn, unsigned long nr_pages,
165 struct zone *zone, struct memory_group *group);
166extern void __offline_isolated_pages(unsigned long start_pfn,
167 unsigned long end_pfn);
168
169typedef void (*online_page_callback_t)(struct page *page, unsigned int order);
170
171extern void generic_online_page(struct page *page, unsigned int order);
172extern int set_online_page_callback(online_page_callback_t callback);
173extern int restore_online_page_callback(online_page_callback_t callback);
174
175extern int try_online_node(int nid);
176
177extern int arch_add_memory(int nid, u64 start, u64 size,
178 struct mhp_params *params);
179extern u64 max_mem_size;
180
181extern int mhp_online_type_from_str(const char *str);
182
183/* Default online_type (MMOP_*) when new memory blocks are added. */
184extern int mhp_default_online_type;
185/* If movable_node boot option specified */
186extern bool movable_node_enabled;
187static inline bool movable_node_is_enabled(void)
188{
189 return movable_node_enabled;
190}
191
192extern void arch_remove_memory(u64 start, u64 size, struct vmem_altmap *altmap);
193extern void __remove_pages(unsigned long start_pfn, unsigned long nr_pages,
194 struct vmem_altmap *altmap);
195
196/* reasonably generic interface to expand the physical pages */
197extern int __add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
198 struct mhp_params *params);
199
200#ifndef CONFIG_ARCH_HAS_ADD_PAGES
201static inline int add_pages(int nid, unsigned long start_pfn,
202 unsigned long nr_pages, struct mhp_params *params)
203{
204 return __add_pages(nid, start_pfn, nr_pages, params);
205}
206#else /* ARCH_HAS_ADD_PAGES */
207int add_pages(int nid, unsigned long start_pfn, unsigned long nr_pages,
208 struct mhp_params *params);
209#endif /* ARCH_HAS_ADD_PAGES */
210
211void get_online_mems(void);
212void put_online_mems(void);
213
214void mem_hotplug_begin(void);
215void mem_hotplug_done(void);
216
217#else /* ! CONFIG_MEMORY_HOTPLUG */
218#define pfn_to_online_page(pfn) \
219({ \
220 struct page *___page = NULL; \
221 if (pfn_valid(pfn)) \
222 ___page = pfn_to_page(pfn); \
223 ___page; \
224 })
225
226static inline unsigned zone_span_seqbegin(struct zone *zone)
227{
228 return 0;
229}
230static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
231{
232 return 0;
233}
234static inline void zone_span_writelock(struct zone *zone) {}
235static inline void zone_span_writeunlock(struct zone *zone) {}
236static inline void zone_seqlock_init(struct zone *zone) {}
237
238static inline int try_online_node(int nid)
239{
240 return 0;
241}
242
243static inline void get_online_mems(void) {}
244static inline void put_online_mems(void) {}
245
246static inline void mem_hotplug_begin(void) {}
247static inline void mem_hotplug_done(void) {}
248
249static inline bool movable_node_is_enabled(void)
250{
251 return false;
252}
253#endif /* ! CONFIG_MEMORY_HOTPLUG */
254
255/*
256 * Keep this declaration outside CONFIG_MEMORY_HOTPLUG as some
257 * platforms might override and use arch_get_mappable_range()
258 * for internal non memory hotplug purposes.
259 */
260struct range arch_get_mappable_range(void);
261
262#if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_DEFERRED_STRUCT_PAGE_INIT)
263/*
264 * pgdat resizing functions
265 */
266static inline
267void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
268{
269 spin_lock_irqsave(&pgdat->node_size_lock, *flags);
270}
271static inline
272void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
273{
274 spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
275}
276static inline
277void pgdat_resize_init(struct pglist_data *pgdat)
278{
279 spin_lock_init(&pgdat->node_size_lock);
280}
281#else /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
282/*
283 * Stub functions for when hotplug is off
284 */
285static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
286static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
287static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
288#endif /* !(CONFIG_MEMORY_HOTPLUG || CONFIG_DEFERRED_STRUCT_PAGE_INIT) */
289
290#ifdef CONFIG_MEMORY_HOTREMOVE
291
292extern void try_offline_node(int nid);
293extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages,
294 struct zone *zone, struct memory_group *group);
295extern int remove_memory(u64 start, u64 size);
296extern void __remove_memory(u64 start, u64 size);
297extern int offline_and_remove_memory(u64 start, u64 size);
298
299#else
300static inline void try_offline_node(int nid) {}
301
302static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages,
303 struct zone *zone, struct memory_group *group)
304{
305 return -EINVAL;
306}
307
308static inline int remove_memory(u64 start, u64 size)
309{
310 return -EBUSY;
311}
312
313static inline void __remove_memory(u64 start, u64 size) {}
314#endif /* CONFIG_MEMORY_HOTREMOVE */
315
316extern void set_zone_contiguous(struct zone *zone);
317extern void clear_zone_contiguous(struct zone *zone);
318
319#ifdef CONFIG_MEMORY_HOTPLUG
320extern void __ref free_area_init_core_hotplug(struct pglist_data *pgdat);
321extern int __add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
322extern int add_memory(int nid, u64 start, u64 size, mhp_t mhp_flags);
323extern int add_memory_resource(int nid, struct resource *resource,
324 mhp_t mhp_flags);
325extern int add_memory_driver_managed(int nid, u64 start, u64 size,
326 const char *resource_name,
327 mhp_t mhp_flags);
328extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
329 unsigned long nr_pages,
330 struct vmem_altmap *altmap, int migratetype);
331extern void remove_pfn_range_from_zone(struct zone *zone,
332 unsigned long start_pfn,
333 unsigned long nr_pages);
334extern bool is_memblock_offlined(struct memory_block *mem);
335extern int sparse_add_section(int nid, unsigned long pfn,
336 unsigned long nr_pages, struct vmem_altmap *altmap);
337extern void sparse_remove_section(struct mem_section *ms,
338 unsigned long pfn, unsigned long nr_pages,
339 unsigned long map_offset, struct vmem_altmap *altmap);
340extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
341 unsigned long pnum);
342extern struct zone *zone_for_pfn_range(int online_type, int nid,
343 struct memory_group *group, unsigned long start_pfn,
344 unsigned long nr_pages);
345extern int arch_create_linear_mapping(int nid, u64 start, u64 size,
346 struct mhp_params *params);
347void arch_remove_linear_mapping(u64 start, u64 size);
348extern bool mhp_supports_memmap_on_memory(unsigned long size);
349#endif /* CONFIG_MEMORY_HOTPLUG */
350
351#endif /* __LINUX_MEMORY_HOTPLUG_H */