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