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