xref: /linux-6.15/include/linux/memblock.h (revision e756bc56)
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 
22 struct memblock_region {
23 	phys_addr_t base;
24 	phys_addr_t size;
25 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
26 	int nid;
27 #endif
28 };
29 
30 struct memblock_type {
31 	unsigned long cnt;	/* number of regions */
32 	unsigned long max;	/* size of the allocated array */
33 	phys_addr_t total_size;	/* size of all regions */
34 	struct memblock_region *regions;
35 };
36 
37 struct memblock {
38 	bool bottom_up;  /* is bottom up direction? */
39 	phys_addr_t current_limit;
40 	struct memblock_type memory;
41 	struct memblock_type reserved;
42 };
43 
44 extern struct memblock memblock;
45 extern int memblock_debug;
46 
47 #define memblock_dbg(fmt, ...) \
48 	if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
49 
50 phys_addr_t memblock_find_in_range_node(phys_addr_t start, phys_addr_t end,
51 				phys_addr_t size, phys_addr_t align, int nid);
52 phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
53 				   phys_addr_t size, phys_addr_t align);
54 phys_addr_t get_allocated_memblock_reserved_regions_info(phys_addr_t *addr);
55 void memblock_allow_resize(void);
56 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
57 int memblock_add(phys_addr_t base, phys_addr_t size);
58 int memblock_remove(phys_addr_t base, phys_addr_t size);
59 int memblock_free(phys_addr_t base, phys_addr_t size);
60 int memblock_reserve(phys_addr_t base, phys_addr_t size);
61 void memblock_trim_memory(phys_addr_t align);
62 
63 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
64 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
65 			    unsigned long  *end_pfn);
66 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
67 			  unsigned long *out_end_pfn, int *out_nid);
68 
69 /**
70  * for_each_mem_pfn_range - early memory pfn range iterator
71  * @i: an integer used as loop variable
72  * @nid: node selector, %MAX_NUMNODES for all nodes
73  * @p_start: ptr to ulong for start pfn of the range, can be %NULL
74  * @p_end: ptr to ulong for end pfn of the range, can be %NULL
75  * @p_nid: ptr to int for nid of the range, can be %NULL
76  *
77  * Walks over configured memory ranges.
78  */
79 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid)		\
80 	for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
81 	     i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
82 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
83 
84 void __next_free_mem_range(u64 *idx, int nid, phys_addr_t *out_start,
85 			   phys_addr_t *out_end, int *out_nid);
86 
87 /**
88  * for_each_free_mem_range - iterate through free memblock areas
89  * @i: u64 used as loop variable
90  * @nid: node selector, %MAX_NUMNODES for all nodes
91  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
92  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
93  * @p_nid: ptr to int for nid of the range, can be %NULL
94  *
95  * Walks over free (memory && !reserved) areas of memblock.  Available as
96  * soon as memblock is initialized.
97  */
98 #define for_each_free_mem_range(i, nid, p_start, p_end, p_nid)		\
99 	for (i = 0,							\
100 	     __next_free_mem_range(&i, nid, p_start, p_end, p_nid);	\
101 	     i != (u64)ULLONG_MAX;					\
102 	     __next_free_mem_range(&i, nid, p_start, p_end, p_nid))
103 
104 void __next_free_mem_range_rev(u64 *idx, int nid, phys_addr_t *out_start,
105 			       phys_addr_t *out_end, int *out_nid);
106 
107 /**
108  * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
109  * @i: u64 used as loop variable
110  * @nid: node selector, %MAX_NUMNODES for all nodes
111  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
112  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
113  * @p_nid: ptr to int for nid of the range, can be %NULL
114  *
115  * Walks over free (memory && !reserved) areas of memblock in reverse
116  * order.  Available as soon as memblock is initialized.
117  */
118 #define for_each_free_mem_range_reverse(i, nid, p_start, p_end, p_nid)	\
119 	for (i = (u64)ULLONG_MAX,					\
120 	     __next_free_mem_range_rev(&i, nid, p_start, p_end, p_nid);	\
121 	     i != (u64)ULLONG_MAX;					\
122 	     __next_free_mem_range_rev(&i, nid, p_start, p_end, p_nid))
123 
124 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
125 int memblock_set_node(phys_addr_t base, phys_addr_t size, int nid);
126 
127 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
128 {
129 	r->nid = nid;
130 }
131 
132 static inline int memblock_get_region_node(const struct memblock_region *r)
133 {
134 	return r->nid;
135 }
136 #else
137 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
138 {
139 }
140 
141 static inline int memblock_get_region_node(const struct memblock_region *r)
142 {
143 	return 0;
144 }
145 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
146 
147 phys_addr_t memblock_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
148 phys_addr_t memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
149 
150 phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align);
151 
152 #ifdef CONFIG_MOVABLE_NODE
153 /*
154  * Set the allocation direction to bottom-up or top-down.
155  */
156 static inline void memblock_set_bottom_up(bool enable)
157 {
158 	memblock.bottom_up = enable;
159 }
160 
161 /*
162  * Check if the allocation direction is bottom-up or not.
163  * if this is true, that said, memblock will allocate memory
164  * in bottom-up direction.
165  */
166 static inline bool memblock_bottom_up(void)
167 {
168 	return memblock.bottom_up;
169 }
170 #else
171 static inline void memblock_set_bottom_up(bool enable) {}
172 static inline bool memblock_bottom_up(void) { return false; }
173 #endif
174 
175 /* Flags for memblock_alloc_base() amd __memblock_alloc_base() */
176 #define MEMBLOCK_ALLOC_ANYWHERE	(~(phys_addr_t)0)
177 #define MEMBLOCK_ALLOC_ACCESSIBLE	0
178 
179 phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
180 				phys_addr_t max_addr);
181 phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
182 				  phys_addr_t max_addr);
183 phys_addr_t memblock_phys_mem_size(void);
184 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
185 phys_addr_t memblock_start_of_DRAM(void);
186 phys_addr_t memblock_end_of_DRAM(void);
187 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
188 int memblock_is_memory(phys_addr_t addr);
189 int memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
190 int memblock_is_reserved(phys_addr_t addr);
191 int memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
192 
193 extern void __memblock_dump_all(void);
194 
195 static inline void memblock_dump_all(void)
196 {
197 	if (memblock_debug)
198 		__memblock_dump_all();
199 }
200 
201 /**
202  * memblock_set_current_limit - Set the current allocation limit to allow
203  *                         limiting allocations to what is currently
204  *                         accessible during boot
205  * @limit: New limit value (physical address)
206  */
207 void memblock_set_current_limit(phys_addr_t limit);
208 
209 
210 /*
211  * pfn conversion functions
212  *
213  * While the memory MEMBLOCKs should always be page aligned, the reserved
214  * MEMBLOCKs may not be. This accessor attempt to provide a very clear
215  * idea of what they return for such non aligned MEMBLOCKs.
216  */
217 
218 /**
219  * memblock_region_memory_base_pfn - Return the lowest pfn intersecting with the memory region
220  * @reg: memblock_region structure
221  */
222 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
223 {
224 	return PFN_UP(reg->base);
225 }
226 
227 /**
228  * memblock_region_memory_end_pfn - Return the end_pfn this region
229  * @reg: memblock_region structure
230  */
231 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
232 {
233 	return PFN_DOWN(reg->base + reg->size);
234 }
235 
236 /**
237  * memblock_region_reserved_base_pfn - Return the lowest pfn intersecting with the reserved region
238  * @reg: memblock_region structure
239  */
240 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
241 {
242 	return PFN_DOWN(reg->base);
243 }
244 
245 /**
246  * memblock_region_reserved_end_pfn - Return the end_pfn this region
247  * @reg: memblock_region structure
248  */
249 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
250 {
251 	return PFN_UP(reg->base + reg->size);
252 }
253 
254 #define for_each_memblock(memblock_type, region)					\
255 	for (region = memblock.memblock_type.regions;				\
256 	     region < (memblock.memblock_type.regions + memblock.memblock_type.cnt);	\
257 	     region++)
258 
259 
260 #ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
261 #define __init_memblock __meminit
262 #define __initdata_memblock __meminitdata
263 #else
264 #define __init_memblock
265 #define __initdata_memblock
266 #endif
267 
268 #else
269 static inline phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align)
270 {
271 	return 0;
272 }
273 
274 #endif /* CONFIG_HAVE_MEMBLOCK */
275 
276 #endif /* __KERNEL__ */
277 
278 #endif /* _LINUX_MEMBLOCK_H */
279