Merge tag 'vfio-v4.2-rc1' of git://github.com/awilliam/linux-vfio
[sfrench/cifs-2.6.git] / include / linux / memblock.h
1 #ifndef _LINUX_MEMBLOCK_H
2 #define _LINUX_MEMBLOCK_H
3 #ifdef __KERNEL__
4
5 #ifdef CONFIG_HAVE_MEMBLOCK
6 /*
7  * Logical memory blocks.
8  *
9  * Copyright (C) 2001 Peter Bergner, IBM Corp.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version
14  * 2 of the License, or (at your option) any later version.
15  */
16
17 #include <linux/init.h>
18 #include <linux/mm.h>
19
20 #define INIT_MEMBLOCK_REGIONS   128
21 #define INIT_PHYSMEM_REGIONS    4
22
23 /* Definition of memblock flags. */
24 enum {
25         MEMBLOCK_NONE           = 0x0,  /* No special request */
26         MEMBLOCK_HOTPLUG        = 0x1,  /* hotpluggable region */
27         MEMBLOCK_MIRROR         = 0x2,  /* mirrored region */
28 };
29
30 struct memblock_region {
31         phys_addr_t base;
32         phys_addr_t size;
33         unsigned long flags;
34 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
35         int nid;
36 #endif
37 };
38
39 struct memblock_type {
40         unsigned long cnt;      /* number of regions */
41         unsigned long max;      /* size of the allocated array */
42         phys_addr_t total_size; /* size of all regions */
43         struct memblock_region *regions;
44 };
45
46 struct memblock {
47         bool bottom_up;  /* is bottom up direction? */
48         phys_addr_t current_limit;
49         struct memblock_type memory;
50         struct memblock_type reserved;
51 #ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
52         struct memblock_type physmem;
53 #endif
54 };
55
56 extern struct memblock memblock;
57 extern int memblock_debug;
58 #ifdef CONFIG_MOVABLE_NODE
59 /* If movable_node boot option specified */
60 extern bool movable_node_enabled;
61 #endif /* CONFIG_MOVABLE_NODE */
62
63 #define memblock_dbg(fmt, ...) \
64         if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
65
66 phys_addr_t memblock_find_in_range_node(phys_addr_t size, phys_addr_t align,
67                                             phys_addr_t start, phys_addr_t end,
68                                             int nid, ulong flags);
69 phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
70                                    phys_addr_t size, phys_addr_t align);
71 phys_addr_t get_allocated_memblock_reserved_regions_info(phys_addr_t *addr);
72 phys_addr_t get_allocated_memblock_memory_regions_info(phys_addr_t *addr);
73 void memblock_allow_resize(void);
74 int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
75 int memblock_add(phys_addr_t base, phys_addr_t size);
76 int memblock_remove(phys_addr_t base, phys_addr_t size);
77 int memblock_free(phys_addr_t base, phys_addr_t size);
78 int memblock_reserve(phys_addr_t base, phys_addr_t size);
79 void memblock_trim_memory(phys_addr_t align);
80 int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
81 int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
82 int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
83 ulong choose_memblock_flags(void);
84
85 /* Low level functions */
86 int memblock_add_range(struct memblock_type *type,
87                        phys_addr_t base, phys_addr_t size,
88                        int nid, unsigned long flags);
89
90 int memblock_remove_range(struct memblock_type *type,
91                           phys_addr_t base,
92                           phys_addr_t size);
93
94 void __next_mem_range(u64 *idx, int nid, ulong flags,
95                       struct memblock_type *type_a,
96                       struct memblock_type *type_b, phys_addr_t *out_start,
97                       phys_addr_t *out_end, int *out_nid);
98
99 void __next_mem_range_rev(u64 *idx, int nid, ulong flags,
100                           struct memblock_type *type_a,
101                           struct memblock_type *type_b, phys_addr_t *out_start,
102                           phys_addr_t *out_end, int *out_nid);
103
104 /**
105  * for_each_mem_range - iterate through memblock areas from type_a and not
106  * included in type_b. Or just type_a if type_b is NULL.
107  * @i: u64 used as loop variable
108  * @type_a: ptr to memblock_type to iterate
109  * @type_b: ptr to memblock_type which excludes from the iteration
110  * @nid: node selector, %NUMA_NO_NODE for all nodes
111  * @flags: pick from blocks based on memory attributes
112  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
113  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
114  * @p_nid: ptr to int for nid of the range, can be %NULL
115  */
116 #define for_each_mem_range(i, type_a, type_b, nid, flags,               \
117                            p_start, p_end, p_nid)                       \
118         for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b,    \
119                                      p_start, p_end, p_nid);            \
120              i != (u64)ULLONG_MAX;                                      \
121              __next_mem_range(&i, nid, flags, type_a, type_b,           \
122                               p_start, p_end, p_nid))
123
124 /**
125  * for_each_mem_range_rev - reverse iterate through memblock areas from
126  * type_a and not included in type_b. Or just type_a if type_b is NULL.
127  * @i: u64 used as loop variable
128  * @type_a: ptr to memblock_type to iterate
129  * @type_b: ptr to memblock_type which excludes from the iteration
130  * @nid: node selector, %NUMA_NO_NODE for all nodes
131  * @flags: pick from blocks based on memory attributes
132  * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
133  * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
134  * @p_nid: ptr to int for nid of the range, can be %NULL
135  */
136 #define for_each_mem_range_rev(i, type_a, type_b, nid, flags,           \
137                                p_start, p_end, p_nid)                   \
138         for (i = (u64)ULLONG_MAX,                                       \
139                      __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
140                                          p_start, p_end, p_nid);        \
141              i != (u64)ULLONG_MAX;                                      \
142              __next_mem_range_rev(&i, nid, flags, type_a, type_b,       \
143                                   p_start, p_end, p_nid))
144
145 #ifdef CONFIG_MOVABLE_NODE
146 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
147 {
148         return m->flags & MEMBLOCK_HOTPLUG;
149 }
150
151 static inline bool movable_node_is_enabled(void)
152 {
153         return movable_node_enabled;
154 }
155 #else
156 static inline bool memblock_is_hotpluggable(struct memblock_region *m)
157 {
158         return false;
159 }
160 static inline bool movable_node_is_enabled(void)
161 {
162         return false;
163 }
164 #endif
165
166 static inline bool memblock_is_mirror(struct memblock_region *m)
167 {
168         return m->flags & MEMBLOCK_MIRROR;
169 }
170
171 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
172 int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
173                             unsigned long  *end_pfn);
174 void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
175                           unsigned long *out_end_pfn, int *out_nid);
176
177 /**
178  * for_each_mem_pfn_range - early memory pfn range iterator
179  * @i: an integer used as loop variable
180  * @nid: node selector, %MAX_NUMNODES for all nodes
181  * @p_start: ptr to ulong for start pfn of the range, can be %NULL
182  * @p_end: ptr to ulong for end pfn of the range, can be %NULL
183  * @p_nid: ptr to int for nid of the range, can be %NULL
184  *
185  * Walks over configured memory ranges.
186  */
187 #define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid)           \
188         for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
189              i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
190 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
191
192 /**
193  * for_each_free_mem_range - iterate through free memblock areas
194  * @i: u64 used as loop variable
195  * @nid: node selector, %NUMA_NO_NODE for all nodes
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
199  * @flags: pick from blocks based on memory attributes
200  *
201  * Walks over free (memory && !reserved) areas of memblock.  Available as
202  * soon as memblock is initialized.
203  */
204 #define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid)   \
205         for_each_mem_range(i, &memblock.memory, &memblock.reserved,     \
206                            nid, flags, p_start, p_end, p_nid)
207
208 /**
209  * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
210  * @i: u64 used as loop variable
211  * @nid: node selector, %NUMA_NO_NODE for all nodes
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
214  * @p_nid: ptr to int for nid of the range, can be %NULL
215  * @flags: pick from blocks based on memory attributes
216  *
217  * Walks over free (memory && !reserved) areas of memblock in reverse
218  * order.  Available as soon as memblock is initialized.
219  */
220 #define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end,  \
221                                         p_nid)                          \
222         for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
223                                nid, flags, p_start, p_end, p_nid)
224
225 static inline void memblock_set_region_flags(struct memblock_region *r,
226                                              unsigned long flags)
227 {
228         r->flags |= flags;
229 }
230
231 static inline void memblock_clear_region_flags(struct memblock_region *r,
232                                                unsigned long flags)
233 {
234         r->flags &= ~flags;
235 }
236
237 #ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
238 int memblock_set_node(phys_addr_t base, phys_addr_t size,
239                       struct memblock_type *type, int nid);
240
241 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
242 {
243         r->nid = nid;
244 }
245
246 static inline int memblock_get_region_node(const struct memblock_region *r)
247 {
248         return r->nid;
249 }
250 #else
251 static inline void memblock_set_region_node(struct memblock_region *r, int nid)
252 {
253 }
254
255 static inline int memblock_get_region_node(const struct memblock_region *r)
256 {
257         return 0;
258 }
259 #endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
260
261 phys_addr_t memblock_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
262 phys_addr_t memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
263
264 phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align);
265
266 #ifdef CONFIG_MOVABLE_NODE
267 /*
268  * Set the allocation direction to bottom-up or top-down.
269  */
270 static inline void __init memblock_set_bottom_up(bool enable)
271 {
272         memblock.bottom_up = enable;
273 }
274
275 /*
276  * Check if the allocation direction is bottom-up or not.
277  * if this is true, that said, memblock will allocate memory
278  * in bottom-up direction.
279  */
280 static inline bool memblock_bottom_up(void)
281 {
282         return memblock.bottom_up;
283 }
284 #else
285 static inline void __init memblock_set_bottom_up(bool enable) {}
286 static inline bool memblock_bottom_up(void) { return false; }
287 #endif
288
289 /* Flags for memblock_alloc_base() amd __memblock_alloc_base() */
290 #define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
291 #define MEMBLOCK_ALLOC_ACCESSIBLE       0
292
293 phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
294                                         phys_addr_t start, phys_addr_t end,
295                                         ulong flags);
296 phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
297                                 phys_addr_t max_addr);
298 phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
299                                   phys_addr_t max_addr);
300 phys_addr_t memblock_phys_mem_size(void);
301 phys_addr_t memblock_mem_size(unsigned long limit_pfn);
302 phys_addr_t memblock_start_of_DRAM(void);
303 phys_addr_t memblock_end_of_DRAM(void);
304 void memblock_enforce_memory_limit(phys_addr_t memory_limit);
305 int memblock_is_memory(phys_addr_t addr);
306 int memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
307 int memblock_is_reserved(phys_addr_t addr);
308 int memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
309
310 extern void __memblock_dump_all(void);
311
312 static inline void memblock_dump_all(void)
313 {
314         if (memblock_debug)
315                 __memblock_dump_all();
316 }
317
318 /**
319  * memblock_set_current_limit - Set the current allocation limit to allow
320  *                         limiting allocations to what is currently
321  *                         accessible during boot
322  * @limit: New limit value (physical address)
323  */
324 void memblock_set_current_limit(phys_addr_t limit);
325
326
327 phys_addr_t memblock_get_current_limit(void);
328
329 /*
330  * pfn conversion functions
331  *
332  * While the memory MEMBLOCKs should always be page aligned, the reserved
333  * MEMBLOCKs may not be. This accessor attempt to provide a very clear
334  * idea of what they return for such non aligned MEMBLOCKs.
335  */
336
337 /**
338  * memblock_region_memory_base_pfn - Return the lowest pfn intersecting with the memory region
339  * @reg: memblock_region structure
340  */
341 static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
342 {
343         return PFN_UP(reg->base);
344 }
345
346 /**
347  * memblock_region_memory_end_pfn - Return the end_pfn this region
348  * @reg: memblock_region structure
349  */
350 static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
351 {
352         return PFN_DOWN(reg->base + reg->size);
353 }
354
355 /**
356  * memblock_region_reserved_base_pfn - Return the lowest pfn intersecting with the reserved region
357  * @reg: memblock_region structure
358  */
359 static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
360 {
361         return PFN_DOWN(reg->base);
362 }
363
364 /**
365  * memblock_region_reserved_end_pfn - Return the end_pfn this region
366  * @reg: memblock_region structure
367  */
368 static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
369 {
370         return PFN_UP(reg->base + reg->size);
371 }
372
373 #define for_each_memblock(memblock_type, region)                                        \
374         for (region = memblock.memblock_type.regions;                           \
375              region < (memblock.memblock_type.regions + memblock.memblock_type.cnt);    \
376              region++)
377
378
379 #ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
380 #define __init_memblock __meminit
381 #define __initdata_memblock __meminitdata
382 #else
383 #define __init_memblock
384 #define __initdata_memblock
385 #endif
386
387 #ifdef CONFIG_MEMTEST
388 extern void early_memtest(phys_addr_t start, phys_addr_t end);
389 #else
390 static inline void early_memtest(phys_addr_t start, phys_addr_t end)
391 {
392 }
393 #endif
394
395 #else
396 static inline phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align)
397 {
398         return 0;
399 }
400
401 #endif /* CONFIG_HAVE_MEMBLOCK */
402
403 #endif /* __KERNEL__ */
404
405 #endif /* _LINUX_MEMBLOCK_H */