]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/linux/memblock.h
dax: Fix unlock mismatch with updated API
[mirror_ubuntu-eoan-kernel.git] / include / linux / memblock.h
1 #ifndef _LINUX_MEMBLOCK_H
2 #define _LINUX_MEMBLOCK_H
3 #ifdef __KERNEL__
4
5 /*
6 * Logical memory blocks.
7 *
8 * Copyright (C) 2001 Peter Bergner, IBM Corp.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version
13 * 2 of the License, or (at your option) any later version.
14 */
15
16 #include <linux/init.h>
17 #include <linux/mm.h>
18 #include <asm/dma.h>
19
20 extern unsigned long max_low_pfn;
21 extern unsigned long min_low_pfn;
22
23 /*
24 * highest page
25 */
26 extern unsigned long max_pfn;
27 /*
28 * highest possible page
29 */
30 extern unsigned long long max_possible_pfn;
31
32 #define INIT_MEMBLOCK_REGIONS 128
33 #define INIT_PHYSMEM_REGIONS 4
34
35 /**
36 * enum memblock_flags - definition of memory region attributes
37 * @MEMBLOCK_NONE: no special request
38 * @MEMBLOCK_HOTPLUG: hotpluggable region
39 * @MEMBLOCK_MIRROR: mirrored region
40 * @MEMBLOCK_NOMAP: don't add to kernel direct mapping
41 */
42 enum memblock_flags {
43 MEMBLOCK_NONE = 0x0, /* No special request */
44 MEMBLOCK_HOTPLUG = 0x1, /* hotpluggable region */
45 MEMBLOCK_MIRROR = 0x2, /* mirrored region */
46 MEMBLOCK_NOMAP = 0x4, /* don't add to kernel direct mapping */
47 };
48
49 /**
50 * struct memblock_region - represents a memory region
51 * @base: physical address of the region
52 * @size: size of the region
53 * @flags: memory region attributes
54 * @nid: NUMA node id
55 */
56 struct memblock_region {
57 phys_addr_t base;
58 phys_addr_t size;
59 enum memblock_flags flags;
60 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
61 int nid;
62 #endif
63 };
64
65 /**
66 * struct memblock_type - collection of memory regions of certain type
67 * @cnt: number of regions
68 * @max: size of the allocated array
69 * @total_size: size of all regions
70 * @regions: array of regions
71 * @name: the memory type symbolic name
72 */
73 struct memblock_type {
74 unsigned long cnt;
75 unsigned long max;
76 phys_addr_t total_size;
77 struct memblock_region *regions;
78 char *name;
79 };
80
81 /**
82 * struct memblock - memblock allocator metadata
83 * @bottom_up: is bottom up direction?
84 * @current_limit: physical address of the current allocation limit
85 * @memory: usabe memory regions
86 * @reserved: reserved memory regions
87 * @physmem: all physical memory
88 */
89 struct memblock {
90 bool bottom_up; /* is bottom up direction? */
91 phys_addr_t current_limit;
92 struct memblock_type memory;
93 struct memblock_type reserved;
94 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
95 struct memblock_type physmem;
96 #endif
97 };
98
99 extern struct memblock memblock;
100 extern int memblock_debug;
101
102 #ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
103 #define __init_memblock __meminit
104 #define __initdata_memblock __meminitdata
105 void memblock_discard(void);
106 #else
107 #define __init_memblock
108 #define __initdata_memblock
109 #endif
110
111 #define memblock_dbg(fmt, ...) \
112 if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
113
114 phys_addr_t memblock_find_in_range_node(phys_addr_t size, phys_addr_t align,
115 phys_addr_t start, phys_addr_t end,
116 int nid, enum memblock_flags flags);
117 phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
118 phys_addr_t size, phys_addr_t align);
119 void memblock_allow_resize(void);
120 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
121 int memblock_add(phys_addr_t base, phys_addr_t size);
122 int memblock_remove(phys_addr_t base, phys_addr_t size);
123 int memblock_free(phys_addr_t base, phys_addr_t size);
124 int memblock_reserve(phys_addr_t base, phys_addr_t size);
125 void memblock_trim_memory(phys_addr_t align);
126 bool memblock_overlaps_region(struct memblock_type *type,
127 phys_addr_t base, phys_addr_t size);
128 int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
129 int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
130 int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
131 int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
132 int memblock_clear_nomap(phys_addr_t base, phys_addr_t size);
133 enum memblock_flags choose_memblock_flags(void);
134
135 unsigned long memblock_free_all(void);
136 void reset_node_managed_pages(pg_data_t *pgdat);
137 void reset_all_zones_managed_pages(void);
138
139 /* Low level functions */
140 int memblock_add_range(struct memblock_type *type,
141 phys_addr_t base, phys_addr_t size,
142 int nid, enum memblock_flags flags);
143
144 void __next_mem_range(u64 *idx, int nid, enum memblock_flags flags,
145 struct memblock_type *type_a,
146 struct memblock_type *type_b, phys_addr_t *out_start,
147 phys_addr_t *out_end, int *out_nid);
148
149 void __next_mem_range_rev(u64 *idx, int nid, enum memblock_flags flags,
150 struct memblock_type *type_a,
151 struct memblock_type *type_b, phys_addr_t *out_start,
152 phys_addr_t *out_end, int *out_nid);
153
154 void __next_reserved_mem_region(u64 *idx, phys_addr_t *out_start,
155 phys_addr_t *out_end);
156
157 void __memblock_free_early(phys_addr_t base, phys_addr_t size);
158 void __memblock_free_late(phys_addr_t base, phys_addr_t size);
159
160 /**
161 * for_each_mem_range - iterate through memblock areas from type_a and not
162 * included in type_b. Or just type_a if type_b is NULL.
163 * @i: u64 used as loop variable
164 * @type_a: ptr to memblock_type to iterate
165 * @type_b: ptr to memblock_type which excludes from the iteration
166 * @nid: node selector, %NUMA_NO_NODE for all nodes
167 * @flags: pick from blocks based on memory attributes
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
170 * @p_nid: ptr to int for nid of the range, can be %NULL
171 */
172 #define for_each_mem_range(i, type_a, type_b, nid, flags, \
173 p_start, p_end, p_nid) \
174 for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b, \
175 p_start, p_end, p_nid); \
176 i != (u64)ULLONG_MAX; \
177 __next_mem_range(&i, nid, flags, type_a, type_b, \
178 p_start, p_end, p_nid))
179
180 /**
181 * for_each_mem_range_rev - reverse iterate through memblock areas from
182 * type_a and not included in type_b. Or just type_a if type_b is NULL.
183 * @i: u64 used as loop variable
184 * @type_a: ptr to memblock_type to iterate
185 * @type_b: ptr to memblock_type which excludes from the iteration
186 * @nid: node selector, %NUMA_NO_NODE for all nodes
187 * @flags: pick from blocks based on memory attributes
188 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
189 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
190 * @p_nid: ptr to int for nid of the range, can be %NULL
191 */
192 #define for_each_mem_range_rev(i, type_a, type_b, nid, flags, \
193 p_start, p_end, p_nid) \
194 for (i = (u64)ULLONG_MAX, \
195 __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
196 p_start, p_end, p_nid); \
197 i != (u64)ULLONG_MAX; \
198 __next_mem_range_rev(&i, nid, flags, type_a, type_b, \
199 p_start, p_end, p_nid))
200
201 /**
202 * for_each_reserved_mem_region - iterate over all reserved memblock areas
203 * @i: u64 used as loop variable
204 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
205 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
206 *
207 * Walks over reserved areas of memblock. Available as soon as memblock
208 * is initialized.
209 */
210 #define for_each_reserved_mem_region(i, p_start, p_end) \
211 for (i = 0UL, __next_reserved_mem_region(&i, p_start, p_end); \
212 i != (u64)ULLONG_MAX; \
213 __next_reserved_mem_region(&i, p_start, p_end))
214
215 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
216 {
217 return m->flags & MEMBLOCK_HOTPLUG;
218 }
219
220 static inline bool memblock_is_mirror(struct memblock_region *m)
221 {
222 return m->flags & MEMBLOCK_MIRROR;
223 }
224
225 static inline bool memblock_is_nomap(struct memblock_region *m)
226 {
227 return m->flags & MEMBLOCK_NOMAP;
228 }
229
230 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
231 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
232 unsigned long *end_pfn);
233 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
234 unsigned long *out_end_pfn, int *out_nid);
235
236 /**
237 * for_each_mem_pfn_range - early memory pfn range iterator
238 * @i: an integer used as loop variable
239 * @nid: node selector, %MAX_NUMNODES for all nodes
240 * @p_start: ptr to ulong for start pfn of the range, can be %NULL
241 * @p_end: ptr to ulong for end pfn of the range, can be %NULL
242 * @p_nid: ptr to int for nid of the range, can be %NULL
243 *
244 * Walks over configured memory ranges.
245 */
246 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid) \
247 for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
248 i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
249 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
250
251 /**
252 * for_each_free_mem_range - iterate through free memblock areas
253 * @i: u64 used as loop variable
254 * @nid: node selector, %NUMA_NO_NODE for all nodes
255 * @flags: pick from blocks based on memory attributes
256 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
257 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
258 * @p_nid: ptr to int for nid of the range, can be %NULL
259 *
260 * Walks over free (memory && !reserved) areas of memblock. Available as
261 * soon as memblock is initialized.
262 */
263 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid) \
264 for_each_mem_range(i, &memblock.memory, &memblock.reserved, \
265 nid, flags, p_start, p_end, p_nid)
266
267 /**
268 * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
269 * @i: u64 used as loop variable
270 * @nid: node selector, %NUMA_NO_NODE for all nodes
271 * @flags: pick from blocks based on memory attributes
272 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
273 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
274 * @p_nid: ptr to int for nid of the range, can be %NULL
275 *
276 * Walks over free (memory && !reserved) areas of memblock in reverse
277 * order. Available as soon as memblock is initialized.
278 */
279 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end, \
280 p_nid) \
281 for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
282 nid, flags, p_start, p_end, p_nid)
283
284 static inline void memblock_set_region_flags(struct memblock_region *r,
285 enum memblock_flags flags)
286 {
287 r->flags |= flags;
288 }
289
290 static inline void memblock_clear_region_flags(struct memblock_region *r,
291 enum memblock_flags flags)
292 {
293 r->flags &= ~flags;
294 }
295
296 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
297 int memblock_set_node(phys_addr_t base, phys_addr_t size,
298 struct memblock_type *type, int nid);
299
300 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
301 {
302 r->nid = nid;
303 }
304
305 static inline int memblock_get_region_node(const struct memblock_region *r)
306 {
307 return r->nid;
308 }
309 #else
310 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
311 {
312 }
313
314 static inline int memblock_get_region_node(const struct memblock_region *r)
315 {
316 return 0;
317 }
318 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
319
320 /* Flags for memblock allocation APIs */
321 #define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
322 #define MEMBLOCK_ALLOC_ACCESSIBLE 0
323
324 /* We are using top down, so it is safe to use 0 here */
325 #define MEMBLOCK_LOW_LIMIT 0
326
327 #ifndef ARCH_LOW_ADDRESS_LIMIT
328 #define ARCH_LOW_ADDRESS_LIMIT 0xffffffffUL
329 #endif
330
331 phys_addr_t memblock_phys_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
332 phys_addr_t memblock_phys_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
333
334 phys_addr_t memblock_phys_alloc(phys_addr_t size, phys_addr_t align);
335
336 void *memblock_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
337 phys_addr_t min_addr, phys_addr_t max_addr,
338 int nid);
339 void *memblock_alloc_try_nid_nopanic(phys_addr_t size, phys_addr_t align,
340 phys_addr_t min_addr, phys_addr_t max_addr,
341 int nid);
342 void *memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align,
343 phys_addr_t min_addr, phys_addr_t max_addr,
344 int nid);
345
346 static inline void * __init memblock_alloc(phys_addr_t size, phys_addr_t align)
347 {
348 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
349 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
350 }
351
352 static inline void * __init memblock_alloc_raw(phys_addr_t size,
353 phys_addr_t align)
354 {
355 return memblock_alloc_try_nid_raw(size, align, MEMBLOCK_LOW_LIMIT,
356 MEMBLOCK_ALLOC_ACCESSIBLE,
357 NUMA_NO_NODE);
358 }
359
360 static inline void * __init memblock_alloc_from(phys_addr_t size,
361 phys_addr_t align,
362 phys_addr_t min_addr)
363 {
364 return memblock_alloc_try_nid(size, align, min_addr,
365 MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
366 }
367
368 static inline void * __init memblock_alloc_nopanic(phys_addr_t size,
369 phys_addr_t align)
370 {
371 return memblock_alloc_try_nid_nopanic(size, align, MEMBLOCK_LOW_LIMIT,
372 MEMBLOCK_ALLOC_ACCESSIBLE,
373 NUMA_NO_NODE);
374 }
375
376 static inline void * __init memblock_alloc_low(phys_addr_t size,
377 phys_addr_t align)
378 {
379 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
380 ARCH_LOW_ADDRESS_LIMIT, NUMA_NO_NODE);
381 }
382 static inline void * __init memblock_alloc_low_nopanic(phys_addr_t size,
383 phys_addr_t align)
384 {
385 return memblock_alloc_try_nid_nopanic(size, align, MEMBLOCK_LOW_LIMIT,
386 ARCH_LOW_ADDRESS_LIMIT,
387 NUMA_NO_NODE);
388 }
389
390 static inline void * __init memblock_alloc_from_nopanic(phys_addr_t size,
391 phys_addr_t align,
392 phys_addr_t min_addr)
393 {
394 return memblock_alloc_try_nid_nopanic(size, align, min_addr,
395 MEMBLOCK_ALLOC_ACCESSIBLE,
396 NUMA_NO_NODE);
397 }
398
399 static inline void * __init memblock_alloc_node(phys_addr_t size,
400 phys_addr_t align, int nid)
401 {
402 return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
403 MEMBLOCK_ALLOC_ACCESSIBLE, nid);
404 }
405
406 static inline void * __init memblock_alloc_node_nopanic(phys_addr_t size,
407 int nid)
408 {
409 return memblock_alloc_try_nid_nopanic(size, SMP_CACHE_BYTES,
410 MEMBLOCK_LOW_LIMIT,
411 MEMBLOCK_ALLOC_ACCESSIBLE, nid);
412 }
413
414 static inline void __init memblock_free_early(phys_addr_t base,
415 phys_addr_t size)
416 {
417 __memblock_free_early(base, size);
418 }
419
420 static inline void __init memblock_free_early_nid(phys_addr_t base,
421 phys_addr_t size, int nid)
422 {
423 __memblock_free_early(base, size);
424 }
425
426 static inline void __init memblock_free_late(phys_addr_t base, phys_addr_t size)
427 {
428 __memblock_free_late(base, size);
429 }
430
431 /*
432 * Set the allocation direction to bottom-up or top-down.
433 */
434 static inline void __init memblock_set_bottom_up(bool enable)
435 {
436 memblock.bottom_up = enable;
437 }
438
439 /*
440 * Check if the allocation direction is bottom-up or not.
441 * if this is true, that said, memblock will allocate memory
442 * in bottom-up direction.
443 */
444 static inline bool memblock_bottom_up(void)
445 {
446 return memblock.bottom_up;
447 }
448
449 phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
450 phys_addr_t start, phys_addr_t end,
451 enum memblock_flags flags);
452 phys_addr_t memblock_alloc_base_nid(phys_addr_t size,
453 phys_addr_t align, phys_addr_t max_addr,
454 int nid, enum memblock_flags flags);
455 phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
456 phys_addr_t max_addr);
457 phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
458 phys_addr_t max_addr);
459 phys_addr_t memblock_phys_mem_size(void);
460 phys_addr_t memblock_reserved_size(void);
461 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
462 phys_addr_t memblock_start_of_DRAM(void);
463 phys_addr_t memblock_end_of_DRAM(void);
464 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
465 void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
466 void memblock_mem_limit_remove_map(phys_addr_t limit);
467 bool memblock_is_memory(phys_addr_t addr);
468 bool memblock_is_map_memory(phys_addr_t addr);
469 bool memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
470 bool memblock_is_reserved(phys_addr_t addr);
471 bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
472
473 extern void __memblock_dump_all(void);
474
475 static inline void memblock_dump_all(void)
476 {
477 if (memblock_debug)
478 __memblock_dump_all();
479 }
480
481 /**
482 * memblock_set_current_limit - Set the current allocation limit to allow
483 * limiting allocations to what is currently
484 * accessible during boot
485 * @limit: New limit value (physical address)
486 */
487 void memblock_set_current_limit(phys_addr_t limit);
488
489
490 phys_addr_t memblock_get_current_limit(void);
491
492 /*
493 * pfn conversion functions
494 *
495 * While the memory MEMBLOCKs should always be page aligned, the reserved
496 * MEMBLOCKs may not be. This accessor attempt to provide a very clear
497 * idea of what they return for such non aligned MEMBLOCKs.
498 */
499
500 /**
501 * memblock_region_memory_base_pfn - get the lowest pfn of the memory region
502 * @reg: memblock_region structure
503 *
504 * Return: the lowest pfn intersecting with the memory region
505 */
506 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
507 {
508 return PFN_UP(reg->base);
509 }
510
511 /**
512 * memblock_region_memory_end_pfn - get the end pfn of the memory region
513 * @reg: memblock_region structure
514 *
515 * Return: the end_pfn of the reserved region
516 */
517 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
518 {
519 return PFN_DOWN(reg->base + reg->size);
520 }
521
522 /**
523 * memblock_region_reserved_base_pfn - get the lowest pfn of the reserved region
524 * @reg: memblock_region structure
525 *
526 * Return: the lowest pfn intersecting with the reserved region
527 */
528 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
529 {
530 return PFN_DOWN(reg->base);
531 }
532
533 /**
534 * memblock_region_reserved_end_pfn - get the end pfn of the reserved region
535 * @reg: memblock_region structure
536 *
537 * Return: the end_pfn of the reserved region
538 */
539 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
540 {
541 return PFN_UP(reg->base + reg->size);
542 }
543
544 #define for_each_memblock(memblock_type, region) \
545 for (region = memblock.memblock_type.regions; \
546 region < (memblock.memblock_type.regions + memblock.memblock_type.cnt); \
547 region++)
548
549 #define for_each_memblock_type(i, memblock_type, rgn) \
550 for (i = 0, rgn = &memblock_type->regions[0]; \
551 i < memblock_type->cnt; \
552 i++, rgn = &memblock_type->regions[i])
553
554 extern void *alloc_large_system_hash(const char *tablename,
555 unsigned long bucketsize,
556 unsigned long numentries,
557 int scale,
558 int flags,
559 unsigned int *_hash_shift,
560 unsigned int *_hash_mask,
561 unsigned long low_limit,
562 unsigned long high_limit);
563
564 #define HASH_EARLY 0x00000001 /* Allocating during early boot? */
565 #define HASH_SMALL 0x00000002 /* sub-page allocation allowed, min
566 * shift passed via *_hash_shift */
567 #define HASH_ZERO 0x00000004 /* Zero allocated hash table */
568
569 /* Only NUMA needs hash distribution. 64bit NUMA architectures have
570 * sufficient vmalloc space.
571 */
572 #ifdef CONFIG_NUMA
573 #define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
574 extern int hashdist; /* Distribute hashes across NUMA nodes? */
575 #else
576 #define hashdist (0)
577 #endif
578
579 #ifdef CONFIG_MEMTEST
580 extern void early_memtest(phys_addr_t start, phys_addr_t end);
581 #else
582 static inline void early_memtest(phys_addr_t start, phys_addr_t end)
583 {
584 }
585 #endif
586
587 #endif /* __KERNEL__ */
588
589 #endif /* _LINUX_MEMBLOCK_H */