xref: /linux-6.15/include/linux/memblock.h (revision 1f330c32)
1 #ifndef _LINUX_MEMBLOCK_H
2 #define _LINUX_MEMBLOCK_H
3 #ifdef __KERNEL__
4 
5 #ifdef CONFIG_HAVE_MEMBLOCK
6 /*
7  * Logical memory blocks.
8  *
9  * Copyright (C) 2001 Peter Bergner, IBM Corp.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version
14  * 2 of the License, or (at your option) any later version.
15  */
16 
17 #include <linux/init.h>
18 #include <linux/mm.h>
19 
20 #define INIT_MEMBLOCK_REGIONS	128
21 #define INIT_PHYSMEM_REGIONS	4
22 
23 /* Definition of memblock flags. */
24 enum {
25 	MEMBLOCK_NONE		= 0x0,	/* No special request */
26 	MEMBLOCK_HOTPLUG	= 0x1,	/* hotpluggable region */
27 	MEMBLOCK_MIRROR		= 0x2,	/* mirrored region */
28 	MEMBLOCK_NOMAP		= 0x4,	/* don't add to kernel direct mapping */
29 };
30 
31 struct memblock_region {
32 	phys_addr_t base;
33 	phys_addr_t size;
34 	unsigned long flags;
35 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
36 	int nid;
37 #endif
38 };
39 
40 struct memblock_type {
41 	unsigned long cnt;	/* number of regions */
42 	unsigned long max;	/* size of the allocated array */
43 	phys_addr_t total_size;	/* size of all regions */
44 	struct memblock_region *regions;
45 };
46 
47 struct memblock {
48 	bool bottom_up;  /* is bottom up direction? */
49 	phys_addr_t current_limit;
50 	struct memblock_type memory;
51 	struct memblock_type reserved;
52 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
53 	struct memblock_type physmem;
54 #endif
55 };
56 
57 extern struct memblock memblock;
58 extern int memblock_debug;
59 #ifdef CONFIG_MOVABLE_NODE
60 /* If movable_node boot option specified */
61 extern bool movable_node_enabled;
62 #endif /* CONFIG_MOVABLE_NODE */
63 
64 #ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
65 #define __init_memblock __meminit
66 #define __initdata_memblock __meminitdata
67 #else
68 #define __init_memblock
69 #define __initdata_memblock
70 #endif
71 
72 #define memblock_dbg(fmt, ...) \
73 	if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
74 
75 phys_addr_t memblock_find_in_range_node(phys_addr_t size, phys_addr_t align,
76 					    phys_addr_t start, phys_addr_t end,
77 					    int nid, ulong flags);
78 phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
79 				   phys_addr_t size, phys_addr_t align);
80 phys_addr_t get_allocated_memblock_reserved_regions_info(phys_addr_t *addr);
81 phys_addr_t get_allocated_memblock_memory_regions_info(phys_addr_t *addr);
82 void memblock_allow_resize(void);
83 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
84 int memblock_add(phys_addr_t base, phys_addr_t size);
85 int memblock_remove(phys_addr_t base, phys_addr_t size);
86 int memblock_free(phys_addr_t base, phys_addr_t size);
87 int memblock_reserve(phys_addr_t base, phys_addr_t size);
88 void memblock_trim_memory(phys_addr_t align);
89 bool memblock_overlaps_region(struct memblock_type *type,
90 			      phys_addr_t base, phys_addr_t size);
91 int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
92 int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
93 int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
94 int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
95 ulong choose_memblock_flags(void);
96 
97 /* Low level functions */
98 int memblock_add_range(struct memblock_type *type,
99 		       phys_addr_t base, phys_addr_t size,
100 		       int nid, unsigned long flags);
101 
102 void __next_mem_range(u64 *idx, int nid, ulong flags,
103 		      struct memblock_type *type_a,
104 		      struct memblock_type *type_b, phys_addr_t *out_start,
105 		      phys_addr_t *out_end, int *out_nid);
106 
107 void __next_mem_range_rev(u64 *idx, int nid, ulong flags,
108 			  struct memblock_type *type_a,
109 			  struct memblock_type *type_b, phys_addr_t *out_start,
110 			  phys_addr_t *out_end, int *out_nid);
111 
112 void __next_reserved_mem_region(u64 *idx, phys_addr_t *out_start,
113 			       phys_addr_t *out_end);
114 
115 /**
116  * for_each_mem_range - iterate through memblock areas from type_a and not
117  * included in type_b. Or just type_a if type_b is NULL.
118  * @i: u64 used as loop variable
119  * @type_a: ptr to memblock_type to iterate
120  * @type_b: ptr to memblock_type which excludes from the iteration
121  * @nid: node selector, %NUMA_NO_NODE for all nodes
122  * @flags: pick from blocks based on memory attributes
123  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
124  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
125  * @p_nid: ptr to int for nid of the range, can be %NULL
126  */
127 #define for_each_mem_range(i, type_a, type_b, nid, flags,		\
128 			   p_start, p_end, p_nid)			\
129 	for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b,	\
130 				     p_start, p_end, p_nid);		\
131 	     i != (u64)ULLONG_MAX;					\
132 	     __next_mem_range(&i, nid, flags, type_a, type_b,		\
133 			      p_start, p_end, p_nid))
134 
135 /**
136  * for_each_mem_range_rev - reverse iterate through memblock areas from
137  * type_a and not included in type_b. Or just type_a if type_b is NULL.
138  * @i: u64 used as loop variable
139  * @type_a: ptr to memblock_type to iterate
140  * @type_b: ptr to memblock_type which excludes from the iteration
141  * @nid: node selector, %NUMA_NO_NODE for all nodes
142  * @flags: pick from blocks based on memory attributes
143  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
144  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
145  * @p_nid: ptr to int for nid of the range, can be %NULL
146  */
147 #define for_each_mem_range_rev(i, type_a, type_b, nid, flags,		\
148 			       p_start, p_end, p_nid)			\
149 	for (i = (u64)ULLONG_MAX,					\
150 		     __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
151 					 p_start, p_end, p_nid);	\
152 	     i != (u64)ULLONG_MAX;					\
153 	     __next_mem_range_rev(&i, nid, flags, type_a, type_b,	\
154 				  p_start, p_end, p_nid))
155 
156 /**
157  * for_each_reserved_mem_region - iterate over all reserved memblock areas
158  * @i: u64 used as loop variable
159  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
160  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
161  *
162  * Walks over reserved areas of memblock. Available as soon as memblock
163  * is initialized.
164  */
165 #define for_each_reserved_mem_region(i, p_start, p_end)			\
166 	for (i = 0UL,							\
167 	     __next_reserved_mem_region(&i, p_start, p_end);		\
168 	     i != (u64)ULLONG_MAX;					\
169 	     __next_reserved_mem_region(&i, p_start, p_end))
170 
171 #ifdef CONFIG_MOVABLE_NODE
172 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
173 {
174 	return m->flags & MEMBLOCK_HOTPLUG;
175 }
176 
177 static inline bool __init_memblock movable_node_is_enabled(void)
178 {
179 	return movable_node_enabled;
180 }
181 #else
182 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
183 {
184 	return false;
185 }
186 static inline bool movable_node_is_enabled(void)
187 {
188 	return false;
189 }
190 #endif
191 
192 static inline bool memblock_is_mirror(struct memblock_region *m)
193 {
194 	return m->flags & MEMBLOCK_MIRROR;
195 }
196 
197 static inline bool memblock_is_nomap(struct memblock_region *m)
198 {
199 	return m->flags & MEMBLOCK_NOMAP;
200 }
201 
202 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
203 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
204 			    unsigned long  *end_pfn);
205 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
206 			  unsigned long *out_end_pfn, int *out_nid);
207 
208 /**
209  * for_each_mem_pfn_range - early memory pfn range iterator
210  * @i: an integer used as loop variable
211  * @nid: node selector, %MAX_NUMNODES for all nodes
212  * @p_start: ptr to ulong for start pfn of the range, can be %NULL
213  * @p_end: ptr to ulong for end pfn of the range, can be %NULL
214  * @p_nid: ptr to int for nid of the range, can be %NULL
215  *
216  * Walks over configured memory ranges.
217  */
218 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid)		\
219 	for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
220 	     i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
221 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
222 
223 /**
224  * for_each_free_mem_range - iterate through free memblock areas
225  * @i: u64 used as loop variable
226  * @nid: node selector, %NUMA_NO_NODE for all nodes
227  * @flags: pick from blocks based on memory attributes
228  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
229  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
230  * @p_nid: ptr to int for nid of the range, can be %NULL
231  *
232  * Walks over free (memory && !reserved) areas of memblock.  Available as
233  * soon as memblock is initialized.
234  */
235 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid)	\
236 	for_each_mem_range(i, &memblock.memory, &memblock.reserved,	\
237 			   nid, flags, p_start, p_end, p_nid)
238 
239 /**
240  * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
241  * @i: u64 used as loop variable
242  * @nid: node selector, %NUMA_NO_NODE for all nodes
243  * @flags: pick from blocks based on memory attributes
244  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
245  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
246  * @p_nid: ptr to int for nid of the range, can be %NULL
247  *
248  * Walks over free (memory && !reserved) areas of memblock in reverse
249  * order.  Available as soon as memblock is initialized.
250  */
251 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end,	\
252 					p_nid)				\
253 	for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved,	\
254 			       nid, flags, p_start, p_end, p_nid)
255 
256 static inline void memblock_set_region_flags(struct memblock_region *r,
257 					     unsigned long flags)
258 {
259 	r->flags |= flags;
260 }
261 
262 static inline void memblock_clear_region_flags(struct memblock_region *r,
263 					       unsigned long flags)
264 {
265 	r->flags &= ~flags;
266 }
267 
268 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
269 int memblock_set_node(phys_addr_t base, phys_addr_t size,
270 		      struct memblock_type *type, int nid);
271 
272 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
273 {
274 	r->nid = nid;
275 }
276 
277 static inline int memblock_get_region_node(const struct memblock_region *r)
278 {
279 	return r->nid;
280 }
281 #else
282 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
283 {
284 }
285 
286 static inline int memblock_get_region_node(const struct memblock_region *r)
287 {
288 	return 0;
289 }
290 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
291 
292 phys_addr_t memblock_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
293 phys_addr_t memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
294 
295 phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align);
296 
297 #ifdef CONFIG_MOVABLE_NODE
298 /*
299  * Set the allocation direction to bottom-up or top-down.
300  */
301 static inline void __init memblock_set_bottom_up(bool enable)
302 {
303 	memblock.bottom_up = enable;
304 }
305 
306 /*
307  * Check if the allocation direction is bottom-up or not.
308  * if this is true, that said, memblock will allocate memory
309  * in bottom-up direction.
310  */
311 static inline bool memblock_bottom_up(void)
312 {
313 	return memblock.bottom_up;
314 }
315 #else
316 static inline void __init memblock_set_bottom_up(bool enable) {}
317 static inline bool memblock_bottom_up(void) { return false; }
318 #endif
319 
320 /* Flags for memblock_alloc_base() amd __memblock_alloc_base() */
321 #define MEMBLOCK_ALLOC_ANYWHERE	(~(phys_addr_t)0)
322 #define MEMBLOCK_ALLOC_ACCESSIBLE	0
323 
324 phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
325 					phys_addr_t start, phys_addr_t end,
326 					ulong flags);
327 phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
328 				phys_addr_t max_addr);
329 phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
330 				  phys_addr_t max_addr);
331 phys_addr_t memblock_phys_mem_size(void);
332 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
333 phys_addr_t memblock_start_of_DRAM(void);
334 phys_addr_t memblock_end_of_DRAM(void);
335 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
336 bool memblock_is_memory(phys_addr_t addr);
337 int memblock_is_map_memory(phys_addr_t addr);
338 int memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
339 bool memblock_is_reserved(phys_addr_t addr);
340 bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
341 
342 extern void __memblock_dump_all(void);
343 
344 static inline void memblock_dump_all(void)
345 {
346 	if (memblock_debug)
347 		__memblock_dump_all();
348 }
349 
350 /**
351  * memblock_set_current_limit - Set the current allocation limit to allow
352  *                         limiting allocations to what is currently
353  *                         accessible during boot
354  * @limit: New limit value (physical address)
355  */
356 void memblock_set_current_limit(phys_addr_t limit);
357 
358 
359 phys_addr_t memblock_get_current_limit(void);
360 
361 /*
362  * pfn conversion functions
363  *
364  * While the memory MEMBLOCKs should always be page aligned, the reserved
365  * MEMBLOCKs may not be. This accessor attempt to provide a very clear
366  * idea of what they return for such non aligned MEMBLOCKs.
367  */
368 
369 /**
370  * memblock_region_memory_base_pfn - Return the lowest pfn intersecting with the memory region
371  * @reg: memblock_region structure
372  */
373 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
374 {
375 	return PFN_UP(reg->base);
376 }
377 
378 /**
379  * memblock_region_memory_end_pfn - Return the end_pfn this region
380  * @reg: memblock_region structure
381  */
382 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
383 {
384 	return PFN_DOWN(reg->base + reg->size);
385 }
386 
387 /**
388  * memblock_region_reserved_base_pfn - Return the lowest pfn intersecting with the reserved region
389  * @reg: memblock_region structure
390  */
391 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
392 {
393 	return PFN_DOWN(reg->base);
394 }
395 
396 /**
397  * memblock_region_reserved_end_pfn - Return the end_pfn this region
398  * @reg: memblock_region structure
399  */
400 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
401 {
402 	return PFN_UP(reg->base + reg->size);
403 }
404 
405 #define for_each_memblock(memblock_type, region)					\
406 	for (region = memblock.memblock_type.regions;				\
407 	     region < (memblock.memblock_type.regions + memblock.memblock_type.cnt);	\
408 	     region++)
409 
410 #define for_each_memblock_type(memblock_type, rgn)			\
411 	idx = 0;							\
412 	rgn = &memblock_type->regions[idx];				\
413 	for (idx = 0; idx < memblock_type->cnt;				\
414 	     idx++,rgn = &memblock_type->regions[idx])
415 
416 #ifdef CONFIG_MEMTEST
417 extern void early_memtest(phys_addr_t start, phys_addr_t end);
418 #else
419 static inline void early_memtest(phys_addr_t start, phys_addr_t end)
420 {
421 }
422 #endif
423 
424 #else
425 static inline phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align)
426 {
427 	return 0;
428 }
429 
430 #endif /* CONFIG_HAVE_MEMBLOCK */
431 
432 #endif /* __KERNEL__ */
433 
434 #endif /* _LINUX_MEMBLOCK_H */
435