1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _LINUX_MEMBLOCK_H
3 #define _LINUX_MEMBLOCK_H
7 * Logical memory blocks.
9 * Copyright (C) 2001 Peter Bergner, IBM Corp.
12 #include <linux/init.h>
16 extern unsigned long max_low_pfn;
17 extern unsigned long min_low_pfn;
22 extern unsigned long max_pfn;
24 * highest possible page
26 extern unsigned long long max_possible_pfn;
29 * enum memblock_flags - definition of memory region attributes
30 * @MEMBLOCK_NONE: no special request
31 * @MEMBLOCK_HOTPLUG: hotpluggable region
32 * @MEMBLOCK_MIRROR: mirrored region
33 * @MEMBLOCK_NOMAP: don't add to kernel direct mapping
36 MEMBLOCK_NONE = 0x0, /* No special request */
37 MEMBLOCK_HOTPLUG = 0x1, /* hotpluggable region */
38 MEMBLOCK_MIRROR = 0x2, /* mirrored region */
39 MEMBLOCK_NOMAP = 0x4, /* don't add to kernel direct mapping */
43 * struct memblock_region - represents a memory region
44 * @base: base address of the region
45 * @size: size of the region
46 * @flags: memory region attributes
49 struct memblock_region {
52 enum memblock_flags flags;
53 #ifdef CONFIG_NEED_MULTIPLE_NODES
59 * struct memblock_type - collection of memory regions of certain type
60 * @cnt: number of regions
61 * @max: size of the allocated array
62 * @total_size: size of all regions
63 * @regions: array of regions
64 * @name: the memory type symbolic name
66 struct memblock_type {
69 phys_addr_t total_size;
70 struct memblock_region *regions;
75 * struct memblock - memblock allocator metadata
76 * @bottom_up: is bottom up direction?
77 * @current_limit: physical address of the current allocation limit
78 * @memory: usable memory regions
79 * @reserved: reserved memory regions
82 bool bottom_up; /* is bottom up direction? */
83 phys_addr_t current_limit;
84 struct memblock_type memory;
85 struct memblock_type reserved;
88 extern struct memblock memblock;
89 extern int memblock_debug;
91 #ifndef CONFIG_ARCH_KEEP_MEMBLOCK
92 #define __init_memblock __meminit
93 #define __initdata_memblock __meminitdata
94 void memblock_discard(void);
96 #define __init_memblock
97 #define __initdata_memblock
98 static inline void memblock_discard(void) {}
101 #define memblock_dbg(fmt, ...) \
102 if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
104 phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
105 phys_addr_t size, phys_addr_t align);
106 void memblock_allow_resize(void);
107 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
108 int memblock_add(phys_addr_t base, phys_addr_t size);
109 int memblock_remove(phys_addr_t base, phys_addr_t size);
110 int memblock_free(phys_addr_t base, phys_addr_t size);
111 int memblock_reserve(phys_addr_t base, phys_addr_t size);
112 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
113 int memblock_physmem_add(phys_addr_t base, phys_addr_t size);
115 void memblock_trim_memory(phys_addr_t align);
116 bool memblock_overlaps_region(struct memblock_type *type,
117 phys_addr_t base, phys_addr_t size);
118 int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
119 int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
120 int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
121 int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
122 int memblock_clear_nomap(phys_addr_t base, phys_addr_t size);
124 unsigned long memblock_free_all(void);
125 void reset_node_managed_pages(pg_data_t *pgdat);
126 void reset_all_zones_managed_pages(void);
128 /* Low level functions */
129 void __next_mem_range(u64 *idx, int nid, enum memblock_flags flags,
130 struct memblock_type *type_a,
131 struct memblock_type *type_b, phys_addr_t *out_start,
132 phys_addr_t *out_end, int *out_nid);
134 void __next_mem_range_rev(u64 *idx, int nid, enum memblock_flags flags,
135 struct memblock_type *type_a,
136 struct memblock_type *type_b, phys_addr_t *out_start,
137 phys_addr_t *out_end, int *out_nid);
139 void __next_reserved_mem_region(u64 *idx, phys_addr_t *out_start,
140 phys_addr_t *out_end);
142 void __memblock_free_late(phys_addr_t base, phys_addr_t size);
144 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
145 static inline void __next_physmem_range(u64 *idx, struct memblock_type *type,
146 phys_addr_t *out_start,
147 phys_addr_t *out_end)
149 extern struct memblock_type physmem;
151 __next_mem_range(idx, NUMA_NO_NODE, MEMBLOCK_NONE, &physmem, type,
152 out_start, out_end, NULL);
156 * for_each_physmem_range - iterate through physmem areas not included in type.
157 * @i: u64 used as loop variable
158 * @type: ptr to memblock_type which excludes from the iteration, can be %NULL
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
162 #define for_each_physmem_range(i, type, p_start, p_end) \
163 for (i = 0, __next_physmem_range(&i, type, p_start, p_end); \
164 i != (u64)ULLONG_MAX; \
165 __next_physmem_range(&i, type, p_start, p_end))
166 #endif /* CONFIG_HAVE_MEMBLOCK_PHYS_MAP */
169 * for_each_mem_range - iterate through memblock areas from type_a and not
170 * included in type_b. Or just type_a if type_b is NULL.
171 * @i: u64 used as loop variable
172 * @type_a: ptr to memblock_type to iterate
173 * @type_b: ptr to memblock_type which excludes from the iteration
174 * @nid: node selector, %NUMA_NO_NODE for all nodes
175 * @flags: pick from blocks based on memory attributes
176 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
177 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
178 * @p_nid: ptr to int for nid of the range, can be %NULL
180 #define for_each_mem_range(i, type_a, type_b, nid, flags, \
181 p_start, p_end, p_nid) \
182 for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b, \
183 p_start, p_end, p_nid); \
184 i != (u64)ULLONG_MAX; \
185 __next_mem_range(&i, nid, flags, type_a, type_b, \
186 p_start, p_end, p_nid))
189 * for_each_mem_range_rev - reverse iterate through memblock areas from
190 * type_a and not included in type_b. Or just type_a if type_b is NULL.
191 * @i: u64 used as loop variable
192 * @type_a: ptr to memblock_type to iterate
193 * @type_b: ptr to memblock_type which excludes from the iteration
194 * @nid: node selector, %NUMA_NO_NODE for all nodes
195 * @flags: pick from blocks based on memory attributes
196 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
197 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
198 * @p_nid: ptr to int for nid of the range, can be %NULL
200 #define for_each_mem_range_rev(i, type_a, type_b, nid, flags, \
201 p_start, p_end, p_nid) \
202 for (i = (u64)ULLONG_MAX, \
203 __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
204 p_start, p_end, p_nid); \
205 i != (u64)ULLONG_MAX; \
206 __next_mem_range_rev(&i, nid, flags, type_a, type_b, \
207 p_start, p_end, p_nid))
210 * for_each_reserved_mem_region - iterate over all reserved memblock areas
211 * @i: u64 used as loop variable
212 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
213 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
215 * Walks over reserved areas of memblock. Available as soon as memblock
218 #define for_each_reserved_mem_region(i, p_start, p_end) \
219 for (i = 0UL, __next_reserved_mem_region(&i, p_start, p_end); \
220 i != (u64)ULLONG_MAX; \
221 __next_reserved_mem_region(&i, p_start, p_end))
223 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
225 return m->flags & MEMBLOCK_HOTPLUG;
228 static inline bool memblock_is_mirror(struct memblock_region *m)
230 return m->flags & MEMBLOCK_MIRROR;
233 static inline bool memblock_is_nomap(struct memblock_region *m)
235 return m->flags & MEMBLOCK_NOMAP;
238 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
239 unsigned long *end_pfn);
240 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
241 unsigned long *out_end_pfn, int *out_nid);
244 * for_each_mem_pfn_range - early memory pfn range iterator
245 * @i: an integer used as loop variable
246 * @nid: node selector, %MAX_NUMNODES for all nodes
247 * @p_start: ptr to ulong for start pfn of the range, can be %NULL
248 * @p_end: ptr to ulong for end pfn of the range, can be %NULL
249 * @p_nid: ptr to int for nid of the range, can be %NULL
251 * Walks over configured memory ranges.
253 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid) \
254 for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
255 i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
257 #ifdef CONFIG_DEFERRED_STRUCT_PAGE_INIT
258 void __next_mem_pfn_range_in_zone(u64 *idx, struct zone *zone,
259 unsigned long *out_spfn,
260 unsigned long *out_epfn);
262 * for_each_free_mem_range_in_zone - iterate through zone specific free
264 * @i: u64 used as loop variable
265 * @zone: zone in which all of the memory blocks reside
266 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
267 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
269 * Walks over free (memory && !reserved) areas of memblock in a specific
270 * zone. Available once memblock and an empty zone is initialized. The main
271 * assumption is that the zone start, end, and pgdat have been associated.
272 * This way we can use the zone to determine NUMA node, and if a given part
273 * of the memblock is valid for the zone.
275 #define for_each_free_mem_pfn_range_in_zone(i, zone, p_start, p_end) \
277 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end); \
279 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end))
282 * for_each_free_mem_range_in_zone_from - iterate through zone specific
283 * free memblock areas from a given point
284 * @i: u64 used as loop variable
285 * @zone: zone in which all of the memory blocks reside
286 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
287 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
289 * Walks over free (memory && !reserved) areas of memblock in a specific
290 * zone, continuing from current position. Available as soon as memblock is
293 #define for_each_free_mem_pfn_range_in_zone_from(i, zone, p_start, p_end) \
294 for (; i != U64_MAX; \
295 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end))
297 int __init deferred_page_init_max_threads(const struct cpumask *node_cpumask);
299 #endif /* CONFIG_DEFERRED_STRUCT_PAGE_INIT */
302 * for_each_free_mem_range - iterate through free memblock areas
303 * @i: u64 used as loop variable
304 * @nid: node selector, %NUMA_NO_NODE for all nodes
305 * @flags: pick from blocks based on memory attributes
306 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
307 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
308 * @p_nid: ptr to int for nid of the range, can be %NULL
310 * Walks over free (memory && !reserved) areas of memblock. Available as
311 * soon as memblock is initialized.
313 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid) \
314 for_each_mem_range(i, &memblock.memory, &memblock.reserved, \
315 nid, flags, p_start, p_end, p_nid)
318 * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
319 * @i: u64 used as loop variable
320 * @nid: node selector, %NUMA_NO_NODE for all nodes
321 * @flags: pick from blocks based on memory attributes
322 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
323 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
324 * @p_nid: ptr to int for nid of the range, can be %NULL
326 * Walks over free (memory && !reserved) areas of memblock in reverse
327 * order. Available as soon as memblock is initialized.
329 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end, \
331 for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
332 nid, flags, p_start, p_end, p_nid)
334 int memblock_set_node(phys_addr_t base, phys_addr_t size,
335 struct memblock_type *type, int nid);
337 #ifdef CONFIG_NEED_MULTIPLE_NODES
338 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
343 static inline int memblock_get_region_node(const struct memblock_region *r)
348 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
352 static inline int memblock_get_region_node(const struct memblock_region *r)
356 #endif /* CONFIG_NEED_MULTIPLE_NODES */
358 /* Flags for memblock allocation APIs */
359 #define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
360 #define MEMBLOCK_ALLOC_ACCESSIBLE 0
361 #define MEMBLOCK_ALLOC_KASAN 1
363 /* We are using top down, so it is safe to use 0 here */
364 #define MEMBLOCK_LOW_LIMIT 0
366 #ifndef ARCH_LOW_ADDRESS_LIMIT
367 #define ARCH_LOW_ADDRESS_LIMIT 0xffffffffUL
370 phys_addr_t memblock_phys_alloc_range(phys_addr_t size, phys_addr_t align,
371 phys_addr_t start, phys_addr_t end);
372 phys_addr_t memblock_alloc_range_nid(phys_addr_t size,
373 phys_addr_t align, phys_addr_t start,
374 phys_addr_t end, int nid, bool exact_nid);
375 phys_addr_t memblock_phys_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
377 static inline phys_addr_t memblock_phys_alloc(phys_addr_t size,
380 return memblock_phys_alloc_range(size, align, 0,
381 MEMBLOCK_ALLOC_ACCESSIBLE);
384 void *memblock_alloc_exact_nid_raw(phys_addr_t size, phys_addr_t align,
385 phys_addr_t min_addr, phys_addr_t max_addr,
387 void *memblock_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
388 phys_addr_t min_addr, phys_addr_t max_addr,
390 void *memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align,
391 phys_addr_t min_addr, phys_addr_t max_addr,
394 static inline void * __init memblock_alloc(phys_addr_t size, phys_addr_t align)
396 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
397 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
400 static inline void * __init memblock_alloc_raw(phys_addr_t size,
403 return memblock_alloc_try_nid_raw(size, align, MEMBLOCK_LOW_LIMIT,
404 MEMBLOCK_ALLOC_ACCESSIBLE,
408 static inline void * __init memblock_alloc_from(phys_addr_t size,
410 phys_addr_t min_addr)
412 return memblock_alloc_try_nid(size, align, min_addr,
413 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
416 static inline void * __init memblock_alloc_low(phys_addr_t size,
419 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
420 ARCH_LOW_ADDRESS_LIMIT, NUMA_NO_NODE);
423 static inline void * __init memblock_alloc_node(phys_addr_t size,
424 phys_addr_t align, int nid)
426 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
427 MEMBLOCK_ALLOC_ACCESSIBLE, nid);
430 static inline void __init memblock_free_early(phys_addr_t base,
433 memblock_free(base, size);
436 static inline void __init memblock_free_early_nid(phys_addr_t base,
437 phys_addr_t size, int nid)
439 memblock_free(base, size);
442 static inline void __init memblock_free_late(phys_addr_t base, phys_addr_t size)
444 __memblock_free_late(base, size);
448 * Set the allocation direction to bottom-up or top-down.
450 static inline void __init memblock_set_bottom_up(bool enable)
452 memblock.bottom_up = enable;
456 * Check if the allocation direction is bottom-up or not.
457 * if this is true, that said, memblock will allocate memory
458 * in bottom-up direction.
460 static inline bool memblock_bottom_up(void)
462 return memblock.bottom_up;
465 phys_addr_t memblock_phys_mem_size(void);
466 phys_addr_t memblock_reserved_size(void);
467 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
468 phys_addr_t memblock_start_of_DRAM(void);
469 phys_addr_t memblock_end_of_DRAM(void);
470 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
471 void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
472 void memblock_mem_limit_remove_map(phys_addr_t limit);
473 bool memblock_is_memory(phys_addr_t addr);
474 bool memblock_is_map_memory(phys_addr_t addr);
475 bool memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
476 bool memblock_is_reserved(phys_addr_t addr);
477 bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
479 extern void __memblock_dump_all(void);
481 static inline void memblock_dump_all(void)
484 __memblock_dump_all();
488 * memblock_set_current_limit - Set the current allocation limit to allow
489 * limiting allocations to what is currently
490 * accessible during boot
491 * @limit: New limit value (physical address)
493 void memblock_set_current_limit(phys_addr_t limit);
496 phys_addr_t memblock_get_current_limit(void);
499 * pfn conversion functions
501 * While the memory MEMBLOCKs should always be page aligned, the reserved
502 * MEMBLOCKs may not be. This accessor attempt to provide a very clear
503 * idea of what they return for such non aligned MEMBLOCKs.
507 * memblock_region_memory_base_pfn - get the lowest pfn of the memory region
508 * @reg: memblock_region structure
510 * Return: the lowest pfn intersecting with the memory region
512 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
514 return PFN_UP(reg->base);
518 * memblock_region_memory_end_pfn - get the end pfn of the memory region
519 * @reg: memblock_region structure
521 * Return: the end_pfn of the reserved region
523 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
525 return PFN_DOWN(reg->base + reg->size);
529 * memblock_region_reserved_base_pfn - get the lowest pfn of the reserved region
530 * @reg: memblock_region structure
532 * Return: the lowest pfn intersecting with the reserved region
534 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
536 return PFN_DOWN(reg->base);
540 * memblock_region_reserved_end_pfn - get the end pfn of the reserved region
541 * @reg: memblock_region structure
543 * Return: the end_pfn of the reserved region
545 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
547 return PFN_UP(reg->base + reg->size);
550 #define for_each_memblock(memblock_type, region) \
551 for (region = memblock.memblock_type.regions; \
552 region < (memblock.memblock_type.regions + memblock.memblock_type.cnt); \
555 extern void *alloc_large_system_hash(const char *tablename,
556 unsigned long bucketsize,
557 unsigned long numentries,
560 unsigned int *_hash_shift,
561 unsigned int *_hash_mask,
562 unsigned long low_limit,
563 unsigned long high_limit);
565 #define HASH_EARLY 0x00000001 /* Allocating during early boot? */
566 #define HASH_SMALL 0x00000002 /* sub-page allocation allowed, min
567 * shift passed via *_hash_shift */
568 #define HASH_ZERO 0x00000004 /* Zero allocated hash table */
570 /* Only NUMA needs hash distribution. 64bit NUMA architectures have
571 * sufficient vmalloc space.
574 #define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
575 extern int hashdist; /* Distribute hashes across NUMA nodes? */
580 #ifdef CONFIG_MEMTEST
581 extern void early_memtest(phys_addr_t start, phys_addr_t end);
583 static inline void early_memtest(phys_addr_t start, phys_addr_t end)
588 #endif /* __KERNEL__ */
590 #endif /* _LINUX_MEMBLOCK_H */