include/linux/bootmem.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Discontiguous memory support, Kanoj Sarcar, SGI, Nov 1999
   4  */
   5 #ifndef _LINUX_BOOTMEM_H
   6 #define _LINUX_BOOTMEM_H
   7
   8 #include <linux/mmzone.h>
   9 #include <linux/mm_types.h>
  10 #include <asm/dma.h>
  11 #include <asm/processor.h>
  12
  13 /*
  14  *  simple boot-time physical memory area allocator.
  15  */
  16
  17 extern unsigned long max_low_pfn;
  18 extern unsigned long min_low_pfn;
  19
  20 /*
  21  * highest page
  22  */
  23 extern unsigned long max_pfn;
  24 /*
  25  * highest possible page
  26  */
  27 extern unsigned long long max_possible_pfn;
  28
  29 extern unsigned long bootmem_bootmap_pages(unsigned long);
  30
  31 extern unsigned long init_bootmem_node(pg_data_t *pgdat,
  32                                        unsigned long freepfn,
  33                                        unsigned long startpfn,
  34                                        unsigned long endpfn);
  35 extern unsigned long init_bootmem(unsigned long addr, unsigned long memend);
  36
  37 extern unsigned long free_all_bootmem(void);
  38 extern void reset_node_managed_pages(pg_data_t *pgdat);
  39 extern void reset_all_zones_managed_pages(void);
  40
  41 extern void free_bootmem_node(pg_data_t *pgdat,
  42                               unsigned long addr,
  43                               unsigned long size);
  44 extern void free_bootmem(unsigned long physaddr, unsigned long size);
  45 extern void free_bootmem_late(unsigned long physaddr, unsigned long size);
  46
  47 /*
  48  * Flags for reserve_bootmem (also if CONFIG_HAVE_ARCH_BOOTMEM_NODE,
  49  * the architecture-specific code should honor this).
  50  *
  51  * If flags is BOOTMEM_DEFAULT, then the return value is always 0 (success).
  52  * If flags contains BOOTMEM_EXCLUSIVE, then -EBUSY is returned if the memory
  53  * already was reserved.
  54  */
  55 #define BOOTMEM_DEFAULT         0
  56 #define BOOTMEM_EXCLUSIVE       (1<<0)
  57
  58 extern int reserve_bootmem(unsigned long addr,
  59                            unsigned long size,
  60                            int flags);
  61 extern int reserve_bootmem_node(pg_data_t *pgdat,
  62                                 unsigned long physaddr,
  63                                 unsigned long size,
  64                                 int flags);
  65
  66 extern void *__alloc_bootmem(unsigned long size,
  67                              unsigned long align,
  68                              unsigned long goal);
  69 extern void *__alloc_bootmem_nopanic(unsigned long size,
  70                                      unsigned long align,
  71                                      unsigned long goal) __malloc;
  72 extern void *__alloc_bootmem_node(pg_data_t *pgdat,
  73                                   unsigned long size,
  74                                   unsigned long align,
  75                                   unsigned long goal) __malloc;
  76 void *__alloc_bootmem_node_high(pg_data_t *pgdat,
  77                                   unsigned long size,
  78                                   unsigned long align,
  79                                   unsigned long goal) __malloc;
  80 extern void *__alloc_bootmem_node_nopanic(pg_data_t *pgdat,
  81                                   unsigned long size,
  82                                   unsigned long align,
  83                                   unsigned long goal) __malloc;
  84 void *___alloc_bootmem_node_nopanic(pg_data_t *pgdat,
  85                                   unsigned long size,
  86                                   unsigned long align,
  87                                   unsigned long goal,
  88                                   unsigned long limit) __malloc;
  89 extern void *__alloc_bootmem_low(unsigned long size,
  90                                  unsigned long align,
  91                                  unsigned long goal) __malloc;
  92 void *__alloc_bootmem_low_nopanic(unsigned long size,
  93                                  unsigned long align,
  94                                  unsigned long goal) __malloc;
  95 extern void *__alloc_bootmem_low_node(pg_data_t *pgdat,
  96                                       unsigned long size,
  97                                       unsigned long align,
  98                                       unsigned long goal) __malloc;
  99
 100 /* We are using top down, so it is safe to use 0 here */
 101 #define BOOTMEM_LOW_LIMIT 0
 102
 103 #ifndef ARCH_LOW_ADDRESS_LIMIT
 104 #define ARCH_LOW_ADDRESS_LIMIT  0xffffffffUL
 105 #endif
 106
 107 #define alloc_bootmem(x) \
 108         __alloc_bootmem(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
 109 #define alloc_bootmem_align(x, align) \
 110         __alloc_bootmem(x, align, BOOTMEM_LOW_LIMIT)
 111 #define alloc_bootmem_nopanic(x) \
 112         __alloc_bootmem_nopanic(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
 113 #define alloc_bootmem_pages(x) \
 114         __alloc_bootmem(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
 115 #define alloc_bootmem_pages_nopanic(x) \
 116         __alloc_bootmem_nopanic(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
 117 #define alloc_bootmem_node(pgdat, x) \
 118         __alloc_bootmem_node(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
 119 #define alloc_bootmem_node_nopanic(pgdat, x) \
 120         __alloc_bootmem_node_nopanic(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
 121 #define alloc_bootmem_pages_node(pgdat, x) \
 122         __alloc_bootmem_node(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
 123 #define alloc_bootmem_pages_node_nopanic(pgdat, x) \
 124         __alloc_bootmem_node_nopanic(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
 125
 126 #define alloc_bootmem_low(x) \
 127         __alloc_bootmem_low(x, SMP_CACHE_BYTES, 0)
 128 #define alloc_bootmem_low_pages_nopanic(x) \
 129         __alloc_bootmem_low_nopanic(x, PAGE_SIZE, 0)
 130 #define alloc_bootmem_low_pages(x) \
 131         __alloc_bootmem_low(x, PAGE_SIZE, 0)
 132 #define alloc_bootmem_low_pages_node(pgdat, x) \
 133         __alloc_bootmem_low_node(pgdat, x, PAGE_SIZE, 0)
 134
 135
 136 #if defined(CONFIG_HAVE_MEMBLOCK)
 137
 138 /* FIXME: use MEMBLOCK_ALLOC_* variants here */
 139 #define BOOTMEM_ALLOC_ACCESSIBLE        0
 140 #define BOOTMEM_ALLOC_ANYWHERE          (~(phys_addr_t)0)
 141
 142 /* FIXME: Move to memblock.h at a point where we remove nobootmem.c */
 143 void *memblock_virt_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
 144                                       phys_addr_t min_addr,
 145                                       phys_addr_t max_addr, int nid);
 146 void *memblock_virt_alloc_try_nid_nopanic(phys_addr_t size,
 147                 phys_addr_t align, phys_addr_t min_addr,
 148                 phys_addr_t max_addr, int nid);
 149 void *memblock_virt_alloc_try_nid(phys_addr_t size, phys_addr_t align,
 150                 phys_addr_t min_addr, phys_addr_t max_addr, int nid);
 151 void __memblock_free_early(phys_addr_t base, phys_addr_t size);
 152 void __memblock_free_late(phys_addr_t base, phys_addr_t size);
 153
 154 static inline void * __init memblock_virt_alloc(
 155                                         phys_addr_t size,  phys_addr_t align)
 156 {
 157         return memblock_virt_alloc_try_nid(size, align, BOOTMEM_LOW_LIMIT,
 158                                             BOOTMEM_ALLOC_ACCESSIBLE,
 159                                             NUMA_NO_NODE);
 160 }
 161
 162 static inline void * __init memblock_virt_alloc_raw(
 163                                         phys_addr_t size,  phys_addr_t align)
 164 {
 165         return memblock_virt_alloc_try_nid_raw(size, align, BOOTMEM_LOW_LIMIT,
 166                                             BOOTMEM_ALLOC_ACCESSIBLE,
 167                                             NUMA_NO_NODE);
 168 }
 169
 170 static inline void * __init memblock_virt_alloc_nopanic(
 171                                         phys_addr_t size, phys_addr_t align)
 172 {
 173         return memblock_virt_alloc_try_nid_nopanic(size, align,
 174                                                     BOOTMEM_LOW_LIMIT,
 175                                                     BOOTMEM_ALLOC_ACCESSIBLE,
 176                                                     NUMA_NO_NODE);
 177 }
 178
 179 static inline void * __init memblock_virt_alloc_low(
 180                                         phys_addr_t size, phys_addr_t align)
 181 {
 182         return memblock_virt_alloc_try_nid(size, align,
 183                                                    BOOTMEM_LOW_LIMIT,
 184                                                    ARCH_LOW_ADDRESS_LIMIT,
 185                                                    NUMA_NO_NODE);
 186 }
 187 static inline void * __init memblock_virt_alloc_low_nopanic(
 188                                         phys_addr_t size, phys_addr_t align)
 189 {
 190         return memblock_virt_alloc_try_nid_nopanic(size, align,
 191                                                    BOOTMEM_LOW_LIMIT,
 192                                                    ARCH_LOW_ADDRESS_LIMIT,
 193                                                    NUMA_NO_NODE);
 194 }
 195
 196 static inline void * __init memblock_virt_alloc_from_nopanic(
 197                 phys_addr_t size, phys_addr_t align, phys_addr_t min_addr)
 198 {
 199         return memblock_virt_alloc_try_nid_nopanic(size, align, min_addr,
 200                                                     BOOTMEM_ALLOC_ACCESSIBLE,
 201                                                     NUMA_NO_NODE);
 202 }
 203
 204 static inline void * __init memblock_virt_alloc_node(
 205                                                 phys_addr_t size, int nid)
 206 {
 207         return memblock_virt_alloc_try_nid(size, 0, BOOTMEM_LOW_LIMIT,
 208                                             BOOTMEM_ALLOC_ACCESSIBLE, nid);
 209 }
 210
 211 static inline void * __init memblock_virt_alloc_node_nopanic(
 212                                                 phys_addr_t size, int nid)
 213 {
 214         return memblock_virt_alloc_try_nid_nopanic(size, 0, BOOTMEM_LOW_LIMIT,
 215                                                     BOOTMEM_ALLOC_ACCESSIBLE,
 216                                                     nid);
 217 }
 218
 219 static inline void __init memblock_free_early(
 220                                         phys_addr_t base, phys_addr_t size)
 221 {
 222         __memblock_free_early(base, size);
 223 }
 224
 225 static inline void __init memblock_free_early_nid(
 226                                 phys_addr_t base, phys_addr_t size, int nid)
 227 {
 228         __memblock_free_early(base, size);
 229 }
 230
 231 static inline void __init memblock_free_late(
 232                                         phys_addr_t base, phys_addr_t size)
 233 {
 234         __memblock_free_late(base, size);
 235 }
 236
 237 #else
 238
 239 #define BOOTMEM_ALLOC_ACCESSIBLE        0
 240
 241
 242 /* Fall back to all the existing bootmem APIs */
 243 static inline void * __init memblock_virt_alloc(
 244                                         phys_addr_t size,  phys_addr_t align)
 245 {
 246         if (!align)
 247                 align = SMP_CACHE_BYTES;
 248         return __alloc_bootmem(size, align, BOOTMEM_LOW_LIMIT);
 249 }
 250
 251 static inline void * __init memblock_virt_alloc_raw(
 252                                         phys_addr_t size,  phys_addr_t align)
 253 {
 254         if (!align)
 255                 align = SMP_CACHE_BYTES;
 256         return __alloc_bootmem_nopanic(size, align, BOOTMEM_LOW_LIMIT);
 257 }
 258
 259 static inline void * __init memblock_virt_alloc_nopanic(
 260                                         phys_addr_t size, phys_addr_t align)
 261 {
 262         if (!align)
 263                 align = SMP_CACHE_BYTES;
 264         return __alloc_bootmem_nopanic(size, align, BOOTMEM_LOW_LIMIT);
 265 }
 266
 267 static inline void * __init memblock_virt_alloc_low(
 268                                         phys_addr_t size, phys_addr_t align)
 269 {
 270         if (!align)
 271                 align = SMP_CACHE_BYTES;
 272         return __alloc_bootmem_low(size, align, 0);
 273 }
 274
 275 static inline void * __init memblock_virt_alloc_low_nopanic(
 276                                         phys_addr_t size, phys_addr_t align)
 277 {
 278         if (!align)
 279                 align = SMP_CACHE_BYTES;
 280         return __alloc_bootmem_low_nopanic(size, align, 0);
 281 }
 282
 283 static inline void * __init memblock_virt_alloc_from_nopanic(
 284                 phys_addr_t size, phys_addr_t align, phys_addr_t min_addr)
 285 {
 286         return __alloc_bootmem_nopanic(size, align, min_addr);
 287 }
 288
 289 static inline void * __init memblock_virt_alloc_node(
 290                                                 phys_addr_t size, int nid)
 291 {
 292         return __alloc_bootmem_node(NODE_DATA(nid), size, SMP_CACHE_BYTES,
 293                                      BOOTMEM_LOW_LIMIT);
 294 }
 295
 296 static inline void * __init memblock_virt_alloc_node_nopanic(
 297                                                 phys_addr_t size, int nid)
 298 {
 299         return __alloc_bootmem_node_nopanic(NODE_DATA(nid), size,
 300                                              SMP_CACHE_BYTES,
 301                                              BOOTMEM_LOW_LIMIT);
 302 }
 303
 304 static inline void * __init memblock_virt_alloc_try_nid(phys_addr_t size,
 305         phys_addr_t align, phys_addr_t min_addr, phys_addr_t max_addr, int nid)
 306 {
 307         return __alloc_bootmem_node_high(NODE_DATA(nid), size, align,
 308                                           min_addr);
 309 }
 310
 311 static inline void * __init memblock_virt_alloc_try_nid_raw(
 312                         phys_addr_t size, phys_addr_t align,
 313                         phys_addr_t min_addr, phys_addr_t max_addr, int nid)
 314 {
 315         return ___alloc_bootmem_node_nopanic(NODE_DATA(nid), size, align,
 316                                 min_addr, max_addr);
 317 }
 318
 319 static inline void * __init memblock_virt_alloc_try_nid_nopanic(
 320                         phys_addr_t size, phys_addr_t align,
 321                         phys_addr_t min_addr, phys_addr_t max_addr, int nid)
 322 {
 323         return ___alloc_bootmem_node_nopanic(NODE_DATA(nid), size, align,
 324                                 min_addr, max_addr);
 325 }
 326
 327 static inline void __init memblock_free_early(
 328                                         phys_addr_t base, phys_addr_t size)
 329 {
 330         free_bootmem(base, size);
 331 }
 332
 333 static inline void __init memblock_free_early_nid(
 334                                 phys_addr_t base, phys_addr_t size, int nid)
 335 {
 336         free_bootmem_node(NODE_DATA(nid), base, size);
 337 }
 338
 339 static inline void __init memblock_free_late(
 340                                         phys_addr_t base, phys_addr_t size)
 341 {
 342         free_bootmem_late(base, size);
 343 }
 344 #endif /* defined(CONFIG_HAVE_MEMBLOCK) */
 345
 346 extern void *alloc_large_system_hash(const char *tablename,
 347                                      unsigned long bucketsize,
 348                                      unsigned long numentries,
 349                                      int scale,
 350                                      int flags,
 351                                      unsigned int *_hash_shift,
 352                                      unsigned int *_hash_mask,
 353                                      unsigned long low_limit,
 354                                      unsigned long high_limit);
 355
 356 #define HASH_EARLY      0x00000001      /* Allocating during early boot? */
 357 #define HASH_SMALL      0x00000002      /* sub-page allocation allowed, min
 358                                          * shift passed via *_hash_shift */
 359 #define HASH_ZERO       0x00000004      /* Zero allocated hash table */
 360
 361 /* Only NUMA needs hash distribution. 64bit NUMA architectures have
 362  * sufficient vmalloc space.
 363  */
 364 #ifdef CONFIG_NUMA
 365 #define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
 366 extern int hashdist;            /* Distribute hashes across NUMA nodes? */
 367 #else
 368 #define hashdist (0)
 369 #endif
 370
 371
 372 #endif /* _LINUX_BOOTMEM_H */