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