xref: /linux-6.15/include/linux/memory_hotplug.h (revision 9d64fc08)
1 #ifndef __LINUX_MEMORY_HOTPLUG_H
2 #define __LINUX_MEMORY_HOTPLUG_H
3 
4 #include <linux/mmzone.h>
5 #include <linux/spinlock.h>
6 #include <linux/notifier.h>
7 #include <linux/bug.h>
8 
9 struct page;
10 struct zone;
11 struct pglist_data;
12 struct mem_section;
13 struct memory_block;
14 struct resource;
15 
16 #ifdef CONFIG_MEMORY_HOTPLUG
17 /*
18  * Return page for the valid pfn only if the page is online. All pfn
19  * walkers which rely on the fully initialized page->flags and others
20  * should use this rather than pfn_valid && pfn_to_page
21  */
22 #define pfn_to_online_page(pfn)				\
23 ({							\
24 	struct page *___page = NULL;			\
25 	unsigned long ___nr = pfn_to_section_nr(pfn);	\
26 							\
27 	if (___nr < NR_MEM_SECTIONS && online_section_nr(___nr))\
28 		___page = pfn_to_page(pfn);		\
29 	___page;					\
30 })
31 
32 /*
33  * Types for free bootmem stored in page->lru.next. These have to be in
34  * some random range in unsigned long space for debugging purposes.
35  */
36 enum {
37 	MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE = 12,
38 	SECTION_INFO = MEMORY_HOTPLUG_MIN_BOOTMEM_TYPE,
39 	MIX_SECTION_INFO,
40 	NODE_INFO,
41 	MEMORY_HOTPLUG_MAX_BOOTMEM_TYPE = NODE_INFO,
42 };
43 
44 /* Types for control the zone type of onlined and offlined memory */
45 enum {
46 	MMOP_OFFLINE = -1,
47 	MMOP_ONLINE_KEEP,
48 	MMOP_ONLINE_KERNEL,
49 	MMOP_ONLINE_MOVABLE,
50 };
51 
52 /*
53  * pgdat resizing functions
54  */
55 static inline
56 void pgdat_resize_lock(struct pglist_data *pgdat, unsigned long *flags)
57 {
58 	spin_lock_irqsave(&pgdat->node_size_lock, *flags);
59 }
60 static inline
61 void pgdat_resize_unlock(struct pglist_data *pgdat, unsigned long *flags)
62 {
63 	spin_unlock_irqrestore(&pgdat->node_size_lock, *flags);
64 }
65 static inline
66 void pgdat_resize_init(struct pglist_data *pgdat)
67 {
68 	spin_lock_init(&pgdat->node_size_lock);
69 }
70 /*
71  * Zone resizing functions
72  *
73  * Note: any attempt to resize a zone should has pgdat_resize_lock()
74  * zone_span_writelock() both held. This ensure the size of a zone
75  * can't be changed while pgdat_resize_lock() held.
76  */
77 static inline unsigned zone_span_seqbegin(struct zone *zone)
78 {
79 	return read_seqbegin(&zone->span_seqlock);
80 }
81 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
82 {
83 	return read_seqretry(&zone->span_seqlock, iv);
84 }
85 static inline void zone_span_writelock(struct zone *zone)
86 {
87 	write_seqlock(&zone->span_seqlock);
88 }
89 static inline void zone_span_writeunlock(struct zone *zone)
90 {
91 	write_sequnlock(&zone->span_seqlock);
92 }
93 static inline void zone_seqlock_init(struct zone *zone)
94 {
95 	seqlock_init(&zone->span_seqlock);
96 }
97 extern int zone_grow_free_lists(struct zone *zone, unsigned long new_nr_pages);
98 extern int zone_grow_waitqueues(struct zone *zone, unsigned long nr_pages);
99 extern int add_one_highpage(struct page *page, int pfn, int bad_ppro);
100 /* VM interface that may be used by firmware interface */
101 extern int online_pages(unsigned long, unsigned long, int);
102 extern int test_pages_in_a_zone(unsigned long start_pfn, unsigned long end_pfn,
103 	unsigned long *valid_start, unsigned long *valid_end);
104 extern void __offline_isolated_pages(unsigned long, unsigned long);
105 
106 typedef void (*online_page_callback_t)(struct page *page);
107 
108 extern int set_online_page_callback(online_page_callback_t callback);
109 extern int restore_online_page_callback(online_page_callback_t callback);
110 
111 extern void __online_page_set_limits(struct page *page);
112 extern void __online_page_increment_counters(struct page *page);
113 extern void __online_page_free(struct page *page);
114 
115 extern int try_online_node(int nid);
116 
117 extern bool memhp_auto_online;
118 /* If movable_node boot option specified */
119 extern bool movable_node_enabled;
120 static inline bool movable_node_is_enabled(void)
121 {
122 	return movable_node_enabled;
123 }
124 
125 #ifdef CONFIG_MEMORY_HOTREMOVE
126 extern bool is_pageblock_removable_nolock(struct page *page);
127 extern int arch_remove_memory(u64 start, u64 size);
128 extern int __remove_pages(struct zone *zone, unsigned long start_pfn,
129 	unsigned long nr_pages);
130 #endif /* CONFIG_MEMORY_HOTREMOVE */
131 
132 /* reasonably generic interface to expand the physical pages */
133 extern int __add_pages(int nid, unsigned long start_pfn,
134 	unsigned long nr_pages, bool want_memblock);
135 
136 #ifndef CONFIG_ARCH_HAS_ADD_PAGES
137 static inline int add_pages(int nid, unsigned long start_pfn,
138 			    unsigned long nr_pages, bool want_memblock)
139 {
140 	return __add_pages(nid, start_pfn, nr_pages, want_memblock);
141 }
142 #else /* ARCH_HAS_ADD_PAGES */
143 int add_pages(int nid, unsigned long start_pfn,
144 	      unsigned long nr_pages, bool want_memblock);
145 #endif /* ARCH_HAS_ADD_PAGES */
146 
147 #ifdef CONFIG_NUMA
148 extern int memory_add_physaddr_to_nid(u64 start);
149 #else
150 static inline int memory_add_physaddr_to_nid(u64 start)
151 {
152 	return 0;
153 }
154 #endif
155 
156 #ifdef CONFIG_HAVE_ARCH_NODEDATA_EXTENSION
157 /*
158  * For supporting node-hotadd, we have to allocate a new pgdat.
159  *
160  * If an arch has generic style NODE_DATA(),
161  * node_data[nid] = kzalloc() works well. But it depends on the architecture.
162  *
163  * In general, generic_alloc_nodedata() is used.
164  * Now, arch_free_nodedata() is just defined for error path of node_hot_add.
165  *
166  */
167 extern pg_data_t *arch_alloc_nodedata(int nid);
168 extern void arch_free_nodedata(pg_data_t *pgdat);
169 extern void arch_refresh_nodedata(int nid, pg_data_t *pgdat);
170 
171 #else /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
172 
173 #define arch_alloc_nodedata(nid)	generic_alloc_nodedata(nid)
174 #define arch_free_nodedata(pgdat)	generic_free_nodedata(pgdat)
175 
176 #ifdef CONFIG_NUMA
177 /*
178  * If ARCH_HAS_NODEDATA_EXTENSION=n, this func is used to allocate pgdat.
179  * XXX: kmalloc_node() can't work well to get new node's memory at this time.
180  *	Because, pgdat for the new node is not allocated/initialized yet itself.
181  *	To use new node's memory, more consideration will be necessary.
182  */
183 #define generic_alloc_nodedata(nid)				\
184 ({								\
185 	kzalloc(sizeof(pg_data_t), GFP_KERNEL);			\
186 })
187 /*
188  * This definition is just for error path in node hotadd.
189  * For node hotremove, we have to replace this.
190  */
191 #define generic_free_nodedata(pgdat)	kfree(pgdat)
192 
193 extern pg_data_t *node_data[];
194 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
195 {
196 	node_data[nid] = pgdat;
197 }
198 
199 #else /* !CONFIG_NUMA */
200 
201 /* never called */
202 static inline pg_data_t *generic_alloc_nodedata(int nid)
203 {
204 	BUG();
205 	return NULL;
206 }
207 static inline void generic_free_nodedata(pg_data_t *pgdat)
208 {
209 }
210 static inline void arch_refresh_nodedata(int nid, pg_data_t *pgdat)
211 {
212 }
213 #endif /* CONFIG_NUMA */
214 #endif /* CONFIG_HAVE_ARCH_NODEDATA_EXTENSION */
215 
216 #ifdef CONFIG_HAVE_BOOTMEM_INFO_NODE
217 extern void __init register_page_bootmem_info_node(struct pglist_data *pgdat);
218 #else
219 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
220 {
221 }
222 #endif
223 extern void put_page_bootmem(struct page *page);
224 extern void get_page_bootmem(unsigned long ingo, struct page *page,
225 			     unsigned long type);
226 
227 void get_online_mems(void);
228 void put_online_mems(void);
229 
230 void mem_hotplug_begin(void);
231 void mem_hotplug_done(void);
232 
233 extern void set_zone_contiguous(struct zone *zone);
234 extern void clear_zone_contiguous(struct zone *zone);
235 
236 #else /* ! CONFIG_MEMORY_HOTPLUG */
237 #define pfn_to_online_page(pfn)			\
238 ({						\
239 	struct page *___page = NULL;		\
240 	if (pfn_valid(pfn))			\
241 		___page = pfn_to_page(pfn);	\
242 	___page;				\
243  })
244 
245 /*
246  * Stub functions for when hotplug is off
247  */
248 static inline void pgdat_resize_lock(struct pglist_data *p, unsigned long *f) {}
249 static inline void pgdat_resize_unlock(struct pglist_data *p, unsigned long *f) {}
250 static inline void pgdat_resize_init(struct pglist_data *pgdat) {}
251 
252 static inline unsigned zone_span_seqbegin(struct zone *zone)
253 {
254 	return 0;
255 }
256 static inline int zone_span_seqretry(struct zone *zone, unsigned iv)
257 {
258 	return 0;
259 }
260 static inline void zone_span_writelock(struct zone *zone) {}
261 static inline void zone_span_writeunlock(struct zone *zone) {}
262 static inline void zone_seqlock_init(struct zone *zone) {}
263 
264 static inline int mhp_notimplemented(const char *func)
265 {
266 	printk(KERN_WARNING "%s() called, with CONFIG_MEMORY_HOTPLUG disabled\n", func);
267 	dump_stack();
268 	return -ENOSYS;
269 }
270 
271 static inline void register_page_bootmem_info_node(struct pglist_data *pgdat)
272 {
273 }
274 
275 static inline int try_online_node(int nid)
276 {
277 	return 0;
278 }
279 
280 static inline void get_online_mems(void) {}
281 static inline void put_online_mems(void) {}
282 
283 static inline void mem_hotplug_begin(void) {}
284 static inline void mem_hotplug_done(void) {}
285 
286 static inline bool movable_node_is_enabled(void)
287 {
288 	return false;
289 }
290 #endif /* ! CONFIG_MEMORY_HOTPLUG */
291 
292 #ifdef CONFIG_MEMORY_HOTREMOVE
293 
294 extern bool is_mem_section_removable(unsigned long pfn, unsigned long nr_pages);
295 extern void try_offline_node(int nid);
296 extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
297 extern void remove_memory(int nid, u64 start, u64 size);
298 
299 #else
300 static inline bool is_mem_section_removable(unsigned long pfn,
301 					unsigned long nr_pages)
302 {
303 	return false;
304 }
305 
306 static inline void try_offline_node(int nid) {}
307 
308 static inline int offline_pages(unsigned long start_pfn, unsigned long nr_pages)
309 {
310 	return -EINVAL;
311 }
312 
313 static inline void remove_memory(int nid, u64 start, u64 size) {}
314 #endif /* CONFIG_MEMORY_HOTREMOVE */
315 
316 extern int walk_memory_range(unsigned long start_pfn, unsigned long end_pfn,
317 		void *arg, int (*func)(struct memory_block *, void *));
318 extern int add_memory(int nid, u64 start, u64 size);
319 extern int add_memory_resource(int nid, struct resource *resource, bool online);
320 extern int arch_add_memory(int nid, u64 start, u64 size, bool want_memblock);
321 extern void move_pfn_range_to_zone(struct zone *zone, unsigned long start_pfn,
322 		unsigned long nr_pages);
323 extern int offline_pages(unsigned long start_pfn, unsigned long nr_pages);
324 extern bool is_memblock_offlined(struct memory_block *mem);
325 extern void remove_memory(int nid, u64 start, u64 size);
326 extern int sparse_add_one_section(struct pglist_data *pgdat, unsigned long start_pfn);
327 extern void sparse_remove_one_section(struct zone *zone, struct mem_section *ms,
328 		unsigned long map_offset);
329 extern struct page *sparse_decode_mem_map(unsigned long coded_mem_map,
330 					  unsigned long pnum);
331 extern bool allow_online_pfn_range(int nid, unsigned long pfn, unsigned long nr_pages,
332 		int online_type);
333 extern struct zone *zone_for_pfn_range(int online_type, int nid, unsigned start_pfn,
334 		unsigned long nr_pages);
335 #endif /* __LINUX_MEMORY_HOTPLUG_H */
336