5f74ba623dbdd396c4505aa66435c24c88a0ff4f
[sfrench/cifs-2.6.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_late(phys_addr_t base, phys_addr_t size);
158
159 /**
160  * for_each_mem_range - iterate through memblock areas from type_a and not
161  * included in type_b. Or just type_a if type_b is NULL.
162  * @i: u64 used as loop variable
163  * @type_a: ptr to memblock_type to iterate
164  * @type_b: ptr to memblock_type which excludes from the iteration
165  * @nid: node selector, %NUMA_NO_NODE for all nodes
166  * @flags: pick from blocks based on memory attributes
167  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
168  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
169  * @p_nid: ptr to int for nid of the range, can be %NULL
170  */
171 #define for_each_mem_range(i, type_a, type_b, nid, flags,               \
172                            p_start, p_end, p_nid)                       \
173         for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b,    \
174                                      p_start, p_end, p_nid);            \
175              i != (u64)ULLONG_MAX;                                      \
176              __next_mem_range(&i, nid, flags, type_a, type_b,           \
177                               p_start, p_end, p_nid))
178
179 /**
180  * for_each_mem_range_rev - reverse iterate through memblock areas from
181  * type_a and not included in type_b. Or just type_a if type_b is NULL.
182  * @i: u64 used as loop variable
183  * @type_a: ptr to memblock_type to iterate
184  * @type_b: ptr to memblock_type which excludes from the iteration
185  * @nid: node selector, %NUMA_NO_NODE for all nodes
186  * @flags: pick from blocks based on memory attributes
187  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
188  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
189  * @p_nid: ptr to int for nid of the range, can be %NULL
190  */
191 #define for_each_mem_range_rev(i, type_a, type_b, nid, flags,           \
192                                p_start, p_end, p_nid)                   \
193         for (i = (u64)ULLONG_MAX,                                       \
194                      __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
195                                           p_start, p_end, p_nid);       \
196              i != (u64)ULLONG_MAX;                                      \
197              __next_mem_range_rev(&i, nid, flags, type_a, type_b,       \
198                                   p_start, p_end, p_nid))
199
200 /**
201  * for_each_reserved_mem_region - iterate over all reserved memblock areas
202  * @i: u64 used as loop variable
203  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
204  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
205  *
206  * Walks over reserved areas of memblock. Available as soon as memblock
207  * is initialized.
208  */
209 #define for_each_reserved_mem_region(i, p_start, p_end)                 \
210         for (i = 0UL, __next_reserved_mem_region(&i, p_start, p_end);   \
211              i != (u64)ULLONG_MAX;                                      \
212              __next_reserved_mem_region(&i, p_start, p_end))
213
214 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
215 {
216         return m->flags & MEMBLOCK_HOTPLUG;
217 }
218
219 static inline bool memblock_is_mirror(struct memblock_region *m)
220 {
221         return m->flags & MEMBLOCK_MIRROR;
222 }
223
224 static inline bool memblock_is_nomap(struct memblock_region *m)
225 {
226         return m->flags & MEMBLOCK_NOMAP;
227 }
228
229 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
230 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
231                             unsigned long  *end_pfn);
232 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
233                           unsigned long *out_end_pfn, int *out_nid);
234
235 /**
236  * for_each_mem_pfn_range - early memory pfn range iterator
237  * @i: an integer used as loop variable
238  * @nid: node selector, %MAX_NUMNODES for all nodes
239  * @p_start: ptr to ulong for start pfn of the range, can be %NULL
240  * @p_end: ptr to ulong for end pfn of the range, can be %NULL
241  * @p_nid: ptr to int for nid of the range, can be %NULL
242  *
243  * Walks over configured memory ranges.
244  */
245 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid)           \
246         for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
247              i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
248 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
249
250 /**
251  * for_each_free_mem_range - iterate through free memblock areas
252  * @i: u64 used as loop variable
253  * @nid: node selector, %NUMA_NO_NODE for all nodes
254  * @flags: pick from blocks based on memory attributes
255  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
256  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
257  * @p_nid: ptr to int for nid of the range, can be %NULL
258  *
259  * Walks over free (memory && !reserved) areas of memblock.  Available as
260  * soon as memblock is initialized.
261  */
262 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid)   \
263         for_each_mem_range(i, &memblock.memory, &memblock.reserved,     \
264                            nid, flags, p_start, p_end, p_nid)
265
266 /**
267  * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
268  * @i: u64 used as loop variable
269  * @nid: node selector, %NUMA_NO_NODE for all nodes
270  * @flags: pick from blocks based on memory attributes
271  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
272  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
273  * @p_nid: ptr to int for nid of the range, can be %NULL
274  *
275  * Walks over free (memory && !reserved) areas of memblock in reverse
276  * order.  Available as soon as memblock is initialized.
277  */
278 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end,  \
279                                         p_nid)                          \
280         for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
281                                nid, flags, p_start, p_end, p_nid)
282
283 static inline void memblock_set_region_flags(struct memblock_region *r,
284                                              enum memblock_flags flags)
285 {
286         r->flags |= flags;
287 }
288
289 static inline void memblock_clear_region_flags(struct memblock_region *r,
290                                                enum memblock_flags flags)
291 {
292         r->flags &= ~flags;
293 }
294
295 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
296 int memblock_set_node(phys_addr_t base, phys_addr_t size,
297                       struct memblock_type *type, int nid);
298
299 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
300 {
301         r->nid = nid;
302 }
303
304 static inline int memblock_get_region_node(const struct memblock_region *r)
305 {
306         return r->nid;
307 }
308 #else
309 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
310 {
311 }
312
313 static inline int memblock_get_region_node(const struct memblock_region *r)
314 {
315         return 0;
316 }
317 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
318
319 /* Flags for memblock allocation APIs */
320 #define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
321 #define MEMBLOCK_ALLOC_ACCESSIBLE       0
322
323 /* We are using top down, so it is safe to use 0 here */
324 #define MEMBLOCK_LOW_LIMIT 0
325
326 #ifndef ARCH_LOW_ADDRESS_LIMIT
327 #define ARCH_LOW_ADDRESS_LIMIT  0xffffffffUL
328 #endif
329
330 phys_addr_t memblock_phys_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
331 phys_addr_t memblock_phys_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
332
333 phys_addr_t memblock_phys_alloc(phys_addr_t size, phys_addr_t align);
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_nopanic(phys_addr_t size, phys_addr_t align,
339                                      phys_addr_t min_addr, phys_addr_t max_addr,
340                                      int nid);
341 void *memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align,
342                              phys_addr_t min_addr, phys_addr_t max_addr,
343                              int nid);
344
345 static inline void * __init memblock_alloc(phys_addr_t size,  phys_addr_t align)
346 {
347         return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
348                                       MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
349 }
350
351 static inline void * __init memblock_alloc_raw(phys_addr_t size,
352                                                phys_addr_t align)
353 {
354         return memblock_alloc_try_nid_raw(size, align, MEMBLOCK_LOW_LIMIT,
355                                           MEMBLOCK_ALLOC_ACCESSIBLE,
356                                           NUMA_NO_NODE);
357 }
358
359 static inline void * __init memblock_alloc_from(phys_addr_t size,
360                                                 phys_addr_t align,
361                                                 phys_addr_t min_addr)
362 {
363         return memblock_alloc_try_nid(size, align, min_addr,
364                                       MEMBLOCK_ALLOC_ACCESSIBLE, NUMA_NO_NODE);
365 }
366
367 static inline void * __init memblock_alloc_nopanic(phys_addr_t size,
368                                                    phys_addr_t align)
369 {
370         return memblock_alloc_try_nid_nopanic(size, align, MEMBLOCK_LOW_LIMIT,
371                                               MEMBLOCK_ALLOC_ACCESSIBLE,
372                                               NUMA_NO_NODE);
373 }
374
375 static inline void * __init memblock_alloc_low(phys_addr_t size,
376                                                phys_addr_t align)
377 {
378         return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
379                                       ARCH_LOW_ADDRESS_LIMIT, NUMA_NO_NODE);
380 }
381 static inline void * __init memblock_alloc_low_nopanic(phys_addr_t size,
382                                                        phys_addr_t align)
383 {
384         return memblock_alloc_try_nid_nopanic(size, align, MEMBLOCK_LOW_LIMIT,
385                                               ARCH_LOW_ADDRESS_LIMIT,
386                                               NUMA_NO_NODE);
387 }
388
389 static inline void * __init memblock_alloc_from_nopanic(phys_addr_t size,
390                                                         phys_addr_t align,
391                                                         phys_addr_t min_addr)
392 {
393         return memblock_alloc_try_nid_nopanic(size, align, min_addr,
394                                               MEMBLOCK_ALLOC_ACCESSIBLE,
395                                               NUMA_NO_NODE);
396 }
397
398 static inline void * __init memblock_alloc_node(phys_addr_t size,
399                                                 phys_addr_t align, int nid)
400 {
401         return memblock_alloc_try_nid(size, align, MEMBLOCK_LOW_LIMIT,
402                                       MEMBLOCK_ALLOC_ACCESSIBLE, nid);
403 }
404
405 static inline void * __init memblock_alloc_node_nopanic(phys_addr_t size,
406                                                         int nid)
407 {
408         return memblock_alloc_try_nid_nopanic(size, SMP_CACHE_BYTES,
409                                               MEMBLOCK_LOW_LIMIT,
410                                               MEMBLOCK_ALLOC_ACCESSIBLE, nid);
411 }
412
413 static inline void __init memblock_free_early(phys_addr_t base,
414                                               phys_addr_t size)
415 {
416         memblock_free(base, size);
417 }
418
419 static inline void __init memblock_free_early_nid(phys_addr_t base,
420                                                   phys_addr_t size, int nid)
421 {
422         memblock_free(base, size);
423 }
424
425 static inline void __init memblock_free_late(phys_addr_t base, phys_addr_t size)
426 {
427         __memblock_free_late(base, size);
428 }
429
430 /*
431  * Set the allocation direction to bottom-up or top-down.
432  */
433 static inline void __init memblock_set_bottom_up(bool enable)
434 {
435         memblock.bottom_up = enable;
436 }
437
438 /*
439  * Check if the allocation direction is bottom-up or not.
440  * if this is true, that said, memblock will allocate memory
441  * in bottom-up direction.
442  */
443 static inline bool memblock_bottom_up(void)
444 {
445         return memblock.bottom_up;
446 }
447
448 phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
449                                         phys_addr_t start, phys_addr_t end,
450                                         enum memblock_flags flags);
451 phys_addr_t memblock_alloc_base_nid(phys_addr_t size,
452                                         phys_addr_t align, phys_addr_t max_addr,
453                                         int nid, enum memblock_flags flags);
454 phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
455                                 phys_addr_t max_addr);
456 phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
457                                   phys_addr_t max_addr);
458 phys_addr_t memblock_phys_mem_size(void);
459 phys_addr_t memblock_reserved_size(void);
460 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
461 phys_addr_t memblock_start_of_DRAM(void);
462 phys_addr_t memblock_end_of_DRAM(void);
463 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
464 void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
465 void memblock_mem_limit_remove_map(phys_addr_t limit);
466 bool memblock_is_memory(phys_addr_t addr);
467 bool memblock_is_map_memory(phys_addr_t addr);
468 bool memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
469 bool memblock_is_reserved(phys_addr_t addr);
470 bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
471
472 extern void __memblock_dump_all(void);
473
474 static inline void memblock_dump_all(void)
475 {
476         if (memblock_debug)
477                 __memblock_dump_all();
478 }
479
480 /**
481  * memblock_set_current_limit - Set the current allocation limit to allow
482  *                         limiting allocations to what is currently
483  *                         accessible during boot
484  * @limit: New limit value (physical address)
485  */
486 void memblock_set_current_limit(phys_addr_t limit);
487
488
489 phys_addr_t memblock_get_current_limit(void);
490
491 /*
492  * pfn conversion functions
493  *
494  * While the memory MEMBLOCKs should always be page aligned, the reserved
495  * MEMBLOCKs may not be. This accessor attempt to provide a very clear
496  * idea of what they return for such non aligned MEMBLOCKs.
497  */
498
499 /**
500  * memblock_region_memory_base_pfn - get the lowest pfn of the memory region
501  * @reg: memblock_region structure
502  *
503  * Return: the lowest pfn intersecting with the memory region
504  */
505 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
506 {
507         return PFN_UP(reg->base);
508 }
509
510 /**
511  * memblock_region_memory_end_pfn - get the end pfn of the memory region
512  * @reg: memblock_region structure
513  *
514  * Return: the end_pfn of the reserved region
515  */
516 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
517 {
518         return PFN_DOWN(reg->base + reg->size);
519 }
520
521 /**
522  * memblock_region_reserved_base_pfn - get the lowest pfn of the reserved region
523  * @reg: memblock_region structure
524  *
525  * Return: the lowest pfn intersecting with the reserved region
526  */
527 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
528 {
529         return PFN_DOWN(reg->base);
530 }
531
532 /**
533  * memblock_region_reserved_end_pfn - get the end pfn of the reserved region
534  * @reg: memblock_region structure
535  *
536  * Return: the end_pfn of the reserved region
537  */
538 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
539 {
540         return PFN_UP(reg->base + reg->size);
541 }
542
543 #define for_each_memblock(memblock_type, region)                                        \
544         for (region = memblock.memblock_type.regions;                                   \
545              region < (memblock.memblock_type.regions + memblock.memblock_type.cnt);    \
546              region++)
547
548 #define for_each_memblock_type(i, memblock_type, rgn)                   \
549         for (i = 0, rgn = &memblock_type->regions[0];                   \
550              i < memblock_type->cnt;                                    \
551              i++, rgn = &memblock_type->regions[i])
552
553 extern void *alloc_large_system_hash(const char *tablename,
554                                      unsigned long bucketsize,
555                                      unsigned long numentries,
556                                      int scale,
557                                      int flags,
558                                      unsigned int *_hash_shift,
559                                      unsigned int *_hash_mask,
560                                      unsigned long low_limit,
561                                      unsigned long high_limit);
562
563 #define HASH_EARLY      0x00000001      /* Allocating during early boot? */
564 #define HASH_SMALL      0x00000002      /* sub-page allocation allowed, min
565                                          * shift passed via *_hash_shift */
566 #define HASH_ZERO       0x00000004      /* Zero allocated hash table */
567
568 /* Only NUMA needs hash distribution. 64bit NUMA architectures have
569  * sufficient vmalloc space.
570  */
571 #ifdef CONFIG_NUMA
572 #define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
573 extern int hashdist;            /* Distribute hashes across NUMA nodes? */
574 #else
575 #define hashdist (0)
576 #endif
577
578 #ifdef CONFIG_MEMTEST
579 extern void early_memtest(phys_addr_t start, phys_addr_t end);
580 #else
581 static inline void early_memtest(phys_addr_t start, phys_addr_t end)
582 {
583 }
584 #endif
585
586 #endif /* __KERNEL__ */
587
588 #endif /* _LINUX_MEMBLOCK_H */