1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _LINUX_MEMBLOCK_H
3 #define _LINUX_MEMBLOCK_H
6 * Logical memory blocks.
8 * Copyright (C) 2001 Peter Bergner, IBM Corp.
11 #include <linux/init.h>
15 extern unsigned long max_low_pfn;
16 extern unsigned long min_low_pfn;
21 extern unsigned long max_pfn;
23 * highest possible page
25 extern unsigned long long max_possible_pfn;
28 * enum memblock_flags - definition of memory region attributes
29 * @MEMBLOCK_NONE: no special request
30 * @MEMBLOCK_HOTPLUG: memory region indicated in the firmware-provided memory
31 * map during early boot as hot(un)pluggable system RAM (e.g., memory range
32 * that might get hotunplugged later). With "movable_node" set on the kernel
33 * commandline, try keeping this memory region hotunpluggable. Does not apply
34 * to memblocks added ("hotplugged") after early boot.
35 * @MEMBLOCK_MIRROR: mirrored region
36 * @MEMBLOCK_NOMAP: don't add to kernel direct mapping and treat as
37 * reserved in the memory map; refer to memblock_mark_nomap() description
39 * @MEMBLOCK_DRIVER_MANAGED: memory region that is always detected and added
40 * via a driver, and never indicated in the firmware-provided memory map as
41 * system RAM. This corresponds to IORESOURCE_SYSRAM_DRIVER_MANAGED in the
42 * kernel resource tree.
43 * @MEMBLOCK_RSRV_NOINIT: memory region for which struct pages are
44 * not initialized (only for reserved regions).
47 MEMBLOCK_NONE = 0x0, /* No special request */
48 MEMBLOCK_HOTPLUG = 0x1, /* hotpluggable region */
49 MEMBLOCK_MIRROR = 0x2, /* mirrored region */
50 MEMBLOCK_NOMAP = 0x4, /* don't add to kernel direct mapping */
51 MEMBLOCK_DRIVER_MANAGED = 0x8, /* always detected via a driver */
52 MEMBLOCK_RSRV_NOINIT = 0x10, /* don't initialize struct pages */
56 * struct memblock_region - represents a memory region
57 * @base: base address of the region
58 * @size: size of the region
59 * @flags: memory region attributes
62 struct memblock_region {
65 enum memblock_flags flags;
72 * struct memblock_type - collection of memory regions of certain type
73 * @cnt: number of regions
74 * @max: size of the allocated array
75 * @total_size: size of all regions
76 * @regions: array of regions
77 * @name: the memory type symbolic name
79 struct memblock_type {
82 phys_addr_t total_size;
83 struct memblock_region *regions;
88 * struct memblock - memblock allocator metadata
89 * @bottom_up: is bottom up direction?
90 * @current_limit: physical address of the current allocation limit
91 * @memory: usable memory regions
92 * @reserved: reserved memory regions
95 bool bottom_up; /* is bottom up direction? */
96 phys_addr_t current_limit;
97 struct memblock_type memory;
98 struct memblock_type reserved;
101 extern struct memblock memblock;
103 #ifndef CONFIG_ARCH_KEEP_MEMBLOCK
104 #define __init_memblock __meminit
105 #define __initdata_memblock __meminitdata
106 void memblock_discard(void);
108 #define __init_memblock
109 #define __initdata_memblock
110 static inline void memblock_discard(void) {}
113 void memblock_allow_resize(void);
114 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid,
115 enum memblock_flags flags);
116 int memblock_add(phys_addr_t base, phys_addr_t size);
117 int memblock_remove(phys_addr_t base, phys_addr_t size);
118 int memblock_phys_free(phys_addr_t base, phys_addr_t size);
119 int memblock_reserve(phys_addr_t base, phys_addr_t size);
120 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
121 int memblock_physmem_add(phys_addr_t base, phys_addr_t size);
123 void memblock_trim_memory(phys_addr_t align);
124 unsigned long memblock_addrs_overlap(phys_addr_t base1, phys_addr_t size1,
125 phys_addr_t base2, phys_addr_t size2);
126 bool memblock_overlaps_region(struct memblock_type *type,
127 phys_addr_t base, phys_addr_t size);
128 bool memblock_validate_numa_coverage(unsigned long threshold_bytes);
129 int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
130 int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
131 int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
132 int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
133 int memblock_clear_nomap(phys_addr_t base, phys_addr_t size);
134 int memblock_reserved_mark_noinit(phys_addr_t base, phys_addr_t size);
136 void memblock_free_all(void);
137 void memblock_free(void *ptr, size_t size);
138 void reset_all_zones_managed_pages(void);
140 /* Low level functions */
141 void __next_mem_range(u64 *idx, int nid, enum memblock_flags flags,
142 struct memblock_type *type_a,
143 struct memblock_type *type_b, phys_addr_t *out_start,
144 phys_addr_t *out_end, int *out_nid);
146 void __next_mem_range_rev(u64 *idx, int nid, enum memblock_flags flags,
147 struct memblock_type *type_a,
148 struct memblock_type *type_b, phys_addr_t *out_start,
149 phys_addr_t *out_end, int *out_nid);
151 void memblock_free_late(phys_addr_t base, phys_addr_t size);
153 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
154 static inline void __next_physmem_range(u64 *idx, struct memblock_type *type,
155 phys_addr_t *out_start,
156 phys_addr_t *out_end)
158 extern struct memblock_type physmem;
160 __next_mem_range(idx, NUMA_NO_NODE, MEMBLOCK_NONE, &physmem, type,
161 out_start, out_end, NULL);
165 * for_each_physmem_range - iterate through physmem areas not included in type.
166 * @i: u64 used as loop variable
167 * @type: ptr to memblock_type which excludes from the iteration, can be %NULL
168 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
169 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
171 #define for_each_physmem_range(i, type, p_start, p_end) \
172 for (i = 0, __next_physmem_range(&i, type, p_start, p_end); \
173 i != (u64)ULLONG_MAX; \
174 __next_physmem_range(&i, type, p_start, p_end))
175 #endif /* CONFIG_HAVE_MEMBLOCK_PHYS_MAP */
178 * __for_each_mem_range - iterate through memblock areas from type_a and not
179 * included in type_b. Or just type_a if type_b is NULL.
180 * @i: u64 used as loop variable
181 * @type_a: ptr to memblock_type to iterate
182 * @type_b: ptr to memblock_type which excludes from the iteration
183 * @nid: node selector, %NUMA_NO_NODE for all nodes
184 * @flags: pick from blocks based on memory attributes
185 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
186 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
187 * @p_nid: ptr to int for nid of the range, can be %NULL
189 #define __for_each_mem_range(i, type_a, type_b, nid, flags, \
190 p_start, p_end, p_nid) \
191 for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b, \
192 p_start, p_end, p_nid); \
193 i != (u64)ULLONG_MAX; \
194 __next_mem_range(&i, nid, flags, type_a, type_b, \
195 p_start, p_end, p_nid))
198 * __for_each_mem_range_rev - reverse iterate through memblock areas from
199 * type_a and not included in type_b. Or just type_a if type_b is NULL.
200 * @i: u64 used as loop variable
201 * @type_a: ptr to memblock_type to iterate
202 * @type_b: ptr to memblock_type which excludes from the iteration
203 * @nid: node selector, %NUMA_NO_NODE for all nodes
204 * @flags: pick from blocks based on memory attributes
205 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
206 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
207 * @p_nid: ptr to int for nid of the range, can be %NULL
209 #define __for_each_mem_range_rev(i, type_a, type_b, nid, flags, \
210 p_start, p_end, p_nid) \
211 for (i = (u64)ULLONG_MAX, \
212 __next_mem_range_rev(&i, nid, flags, type_a, type_b, \
213 p_start, p_end, p_nid); \
214 i != (u64)ULLONG_MAX; \
215 __next_mem_range_rev(&i, nid, flags, type_a, type_b, \
216 p_start, p_end, p_nid))
219 * for_each_mem_range - iterate through memory areas.
220 * @i: u64 used as loop variable
221 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
222 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
224 #define for_each_mem_range(i, p_start, p_end) \
225 __for_each_mem_range(i, &memblock.memory, NULL, NUMA_NO_NODE, \
226 MEMBLOCK_HOTPLUG | MEMBLOCK_DRIVER_MANAGED, \
227 p_start, p_end, NULL)
230 * for_each_mem_range_rev - reverse iterate through memblock areas from
231 * type_a and not included in type_b. Or just type_a if type_b is NULL.
232 * @i: u64 used as loop variable
233 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
234 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
236 #define for_each_mem_range_rev(i, p_start, p_end) \
237 __for_each_mem_range_rev(i, &memblock.memory, NULL, NUMA_NO_NODE, \
238 MEMBLOCK_HOTPLUG | MEMBLOCK_DRIVER_MANAGED,\
239 p_start, p_end, NULL)
242 * for_each_reserved_mem_range - iterate over all reserved memblock areas
243 * @i: u64 used as loop variable
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
247 * Walks over reserved areas of memblock. Available as soon as memblock
250 #define for_each_reserved_mem_range(i, p_start, p_end) \
251 __for_each_mem_range(i, &memblock.reserved, NULL, NUMA_NO_NODE, \
252 MEMBLOCK_NONE, p_start, p_end, NULL)
254 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
256 return m->flags & MEMBLOCK_HOTPLUG;
259 static inline bool memblock_is_mirror(struct memblock_region *m)
261 return m->flags & MEMBLOCK_MIRROR;
264 static inline bool memblock_is_nomap(struct memblock_region *m)
266 return m->flags & MEMBLOCK_NOMAP;
269 static inline bool memblock_is_reserved_noinit(struct memblock_region *m)
271 return m->flags & MEMBLOCK_RSRV_NOINIT;
274 static inline bool memblock_is_driver_managed(struct memblock_region *m)
276 return m->flags & MEMBLOCK_DRIVER_MANAGED;
279 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
280 unsigned long *end_pfn);
281 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
282 unsigned long *out_end_pfn, int *out_nid);
285 * for_each_mem_pfn_range - early memory pfn range iterator
286 * @i: an integer used as loop variable
287 * @nid: node selector, %MAX_NUMNODES for all nodes
288 * @p_start: ptr to ulong for start pfn of the range, can be %NULL
289 * @p_end: ptr to ulong for end pfn of the range, can be %NULL
290 * @p_nid: ptr to int for nid of the range, can be %NULL
292 * Walks over configured memory ranges.
294 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid) \
295 for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
296 i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
298 #ifdef CONFIG_DEFERRED_STRUCT_PAGE_INIT
299 void __next_mem_pfn_range_in_zone(u64 *idx, struct zone *zone,
300 unsigned long *out_spfn,
301 unsigned long *out_epfn);
303 * for_each_free_mem_pfn_range_in_zone - iterate through zone specific free
305 * @i: u64 used as loop variable
306 * @zone: zone in which all of the memory blocks reside
307 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
308 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
310 * Walks over free (memory && !reserved) areas of memblock in a specific
311 * zone. Available once memblock and an empty zone is initialized. The main
312 * assumption is that the zone start, end, and pgdat have been associated.
313 * This way we can use the zone to determine NUMA node, and if a given part
314 * of the memblock is valid for the zone.
316 #define for_each_free_mem_pfn_range_in_zone(i, zone, p_start, p_end) \
318 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end); \
320 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end))
323 * for_each_free_mem_pfn_range_in_zone_from - iterate through zone specific
324 * free memblock areas from a given point
325 * @i: u64 used as loop variable
326 * @zone: zone in which all of the memory blocks reside
327 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
328 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
330 * Walks over free (memory && !reserved) areas of memblock in a specific
331 * zone, continuing from current position. Available as soon as memblock is
334 #define for_each_free_mem_pfn_range_in_zone_from(i, zone, p_start, p_end) \
335 for (; i != U64_MAX; \
336 __next_mem_pfn_range_in_zone(&i, zone, p_start, p_end))
338 int __init deferred_page_init_max_threads(const struct cpumask *node_cpumask);
340 #endif /* CONFIG_DEFERRED_STRUCT_PAGE_INIT */
343 * for_each_free_mem_range - iterate through free memblock areas
344 * @i: u64 used as loop variable
345 * @nid: node selector, %NUMA_NO_NODE for all nodes
346 * @flags: pick from blocks based on memory attributes
347 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
348 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
349 * @p_nid: ptr to int for nid of the range, can be %NULL
351 * Walks over free (memory && !reserved) areas of memblock. Available as
352 * soon as memblock is initialized.
354 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid) \
355 __for_each_mem_range(i, &memblock.memory, &memblock.reserved, \
356 nid, flags, p_start, p_end, p_nid)
359 * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
360 * @i: u64 used as loop variable
361 * @nid: node selector, %NUMA_NO_NODE for all nodes
362 * @flags: pick from blocks based on memory attributes
363 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
364 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
365 * @p_nid: ptr to int for nid of the range, can be %NULL
367 * Walks over free (memory && !reserved) areas of memblock in reverse
368 * order. Available as soon as memblock is initialized.
370 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end, \
372 __for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
373 nid, flags, p_start, p_end, p_nid)
375 int memblock_set_node(phys_addr_t base, phys_addr_t size,
376 struct memblock_type *type, int nid);
379 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
384 static inline int memblock_get_region_node(const struct memblock_region *r)
389 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
393 static inline int memblock_get_region_node(const struct memblock_region *r)
397 #endif /* CONFIG_NUMA */
399 /* Flags for memblock allocation APIs */
400 #define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
401 #define MEMBLOCK_ALLOC_ACCESSIBLE 0
402 #define MEMBLOCK_ALLOC_NOLEAKTRACE 1
404 /* We are using top down, so it is safe to use 0 here */
405 #define MEMBLOCK_LOW_LIMIT 0
407 #ifndef ARCH_LOW_ADDRESS_LIMIT
408 #define ARCH_LOW_ADDRESS_LIMIT 0xffffffffUL
411 phys_addr_t memblock_phys_alloc_range(phys_addr_t size, phys_addr_t align,
412 phys_addr_t start, phys_addr_t end);
413 phys_addr_t memblock_alloc_range_nid(phys_addr_t size,
414 phys_addr_t align, phys_addr_t start,
415 phys_addr_t end, int nid, bool exact_nid);
416 phys_addr_t memblock_phys_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
418 static __always_inline phys_addr_t memblock_phys_alloc(phys_addr_t size,
421 return memblock_phys_alloc_range(size, align, 0,
422 MEMBLOCK_ALLOC_ACCESSIBLE);
425 void *memblock_alloc_exact_nid_raw(phys_addr_t size, phys_addr_t align,
426 phys_addr_t min_addr, phys_addr_t max_addr,
428 void *memblock_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
429 phys_addr_t min_addr, phys_addr_t max_addr,
431 void *memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align,
432 phys_addr_t min_addr, phys_addr_t max_addr,
435 static __always_inline void *memblock_alloc(phys_addr_t size, phys_addr_t align)
437 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
438 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
441 static inline void *memblock_alloc_raw(phys_addr_t size,
444 return memblock_alloc_try_nid_raw(size, align, MEMBLOCK_LOW_LIMIT,
445 MEMBLOCK_ALLOC_ACCESSIBLE,
449 static inline void *memblock_alloc_from(phys_addr_t size,
451 phys_addr_t min_addr)
453 return memblock_alloc_try_nid(size, align, min_addr,
454 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
457 static inline void *memblock_alloc_low(phys_addr_t size,
460 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
461 ARCH_LOW_ADDRESS_LIMIT, NUMA_NO_NODE);
464 static inline void *memblock_alloc_node(phys_addr_t size,
465 phys_addr_t align, int nid)
467 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
468 MEMBLOCK_ALLOC_ACCESSIBLE, nid);
472 * Set the allocation direction to bottom-up or top-down.
474 static inline __init_memblock void memblock_set_bottom_up(bool enable)
476 memblock.bottom_up = enable;
480 * Check if the allocation direction is bottom-up or not.
481 * if this is true, that said, memblock will allocate memory
482 * in bottom-up direction.
484 static inline __init_memblock bool memblock_bottom_up(void)
486 return memblock.bottom_up;
489 phys_addr_t memblock_phys_mem_size(void);
490 phys_addr_t memblock_reserved_size(void);
491 phys_addr_t memblock_start_of_DRAM(void);
492 phys_addr_t memblock_end_of_DRAM(void);
493 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
494 void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
495 void memblock_mem_limit_remove_map(phys_addr_t limit);
496 bool memblock_is_memory(phys_addr_t addr);
497 bool memblock_is_map_memory(phys_addr_t addr);
498 bool memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
499 bool memblock_is_reserved(phys_addr_t addr);
500 bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
502 void memblock_dump_all(void);
505 * memblock_set_current_limit - Set the current allocation limit to allow
506 * limiting allocations to what is currently
507 * accessible during boot
508 * @limit: New limit value (physical address)
510 void memblock_set_current_limit(phys_addr_t limit);
513 phys_addr_t memblock_get_current_limit(void);
516 * pfn conversion functions
518 * While the memory MEMBLOCKs should always be page aligned, the reserved
519 * MEMBLOCKs may not be. This accessor attempt to provide a very clear
520 * idea of what they return for such non aligned MEMBLOCKs.
524 * memblock_region_memory_base_pfn - get the lowest pfn of the memory region
525 * @reg: memblock_region structure
527 * Return: the lowest pfn intersecting with the memory region
529 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
531 return PFN_UP(reg->base);
535 * memblock_region_memory_end_pfn - get the end pfn of the memory region
536 * @reg: memblock_region structure
538 * Return: the end_pfn of the reserved region
540 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
542 return PFN_DOWN(reg->base + reg->size);
546 * memblock_region_reserved_base_pfn - get the lowest pfn of the reserved region
547 * @reg: memblock_region structure
549 * Return: the lowest pfn intersecting with the reserved region
551 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
553 return PFN_DOWN(reg->base);
557 * memblock_region_reserved_end_pfn - get the end pfn of the reserved region
558 * @reg: memblock_region structure
560 * Return: the end_pfn of the reserved region
562 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
564 return PFN_UP(reg->base + reg->size);
568 * for_each_mem_region - itereate over memory regions
569 * @region: loop variable
571 #define for_each_mem_region(region) \
572 for (region = memblock.memory.regions; \
573 region < (memblock.memory.regions + memblock.memory.cnt); \
577 * for_each_reserved_mem_region - itereate over reserved memory regions
578 * @region: loop variable
580 #define for_each_reserved_mem_region(region) \
581 for (region = memblock.reserved.regions; \
582 region < (memblock.reserved.regions + memblock.reserved.cnt); \
585 extern void *alloc_large_system_hash(const char *tablename,
586 unsigned long bucketsize,
587 unsigned long numentries,
590 unsigned int *_hash_shift,
591 unsigned int *_hash_mask,
592 unsigned long low_limit,
593 unsigned long high_limit);
595 #define HASH_EARLY 0x00000001 /* Allocating during early boot? */
596 #define HASH_ZERO 0x00000002 /* Zero allocated hash table */
598 /* Only NUMA needs hash distribution. 64bit NUMA architectures have
599 * sufficient vmalloc space.
602 #define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
603 extern int hashdist; /* Distribute hashes across NUMA nodes? */
608 #ifdef CONFIG_MEMTEST
609 void early_memtest(phys_addr_t start, phys_addr_t end);
610 void memtest_report_meminfo(struct seq_file *m);
612 static inline void early_memtest(phys_addr_t start, phys_addr_t end) { }
613 static inline void memtest_report_meminfo(struct seq_file *m) { }
617 #endif /* _LINUX_MEMBLOCK_H */