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