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