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