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