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