[linux-2.6-block.git] / include / linux / bootmem.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Discontiguous memory support, Kanoj Sarcar, SGI, Nov 1999
 */
#ifndef _LINUX_BOOTMEM_H
#define _LINUX_BOOTMEM_H

#include <linux/mmzone.h>
#include <linux/mm_types.h>
#include <asm/dma.h>
#include <asm/processor.h>

/*
 *  simple boot-time physical memory area allocator.
 */

extern unsigned long max_low_pfn;
extern unsigned long min_low_pfn;

/*
 * highest page
 */
extern unsigned long max_pfn;
/*
 * highest possible page
 */
extern unsigned long long max_possible_pfn;

extern unsigned long free_all_bootmem(void);
extern void reset_node_managed_pages(pg_data_t *pgdat);
extern void reset_all_zones_managed_pages(void);

extern void free_bootmem_node(pg_data_t *pgdat,
			      unsigned long addr,
			      unsigned long size);
extern void free_bootmem(unsigned long physaddr, unsigned long size);
extern void free_bootmem_late(unsigned long physaddr, unsigned long size);

/*
 * Flags for reserve_bootmem (also if CONFIG_HAVE_ARCH_BOOTMEM_NODE,
 * the architecture-specific code should honor this).
 *
 * If flags is BOOTMEM_DEFAULT, then the return value is always 0 (success).
 * If flags contains BOOTMEM_EXCLUSIVE, then -EBUSY is returned if the memory
 * already was reserved.
 */
#define BOOTMEM_DEFAULT		0
#define BOOTMEM_EXCLUSIVE	(1<<0)

extern void *__alloc_bootmem(unsigned long size,
			     unsigned long align,
			     unsigned long goal);
extern void *__alloc_bootmem_nopanic(unsigned long size,
				     unsigned long align,
				     unsigned long goal) __malloc;
extern void *__alloc_bootmem_node(pg_data_t *pgdat,
				  unsigned long size,
				  unsigned long align,
				  unsigned long goal) __malloc;
void *__alloc_bootmem_node_high(pg_data_t *pgdat,
				  unsigned long size,
				  unsigned long align,
				  unsigned long goal) __malloc;
extern void *__alloc_bootmem_node_nopanic(pg_data_t *pgdat,
				  unsigned long size,
				  unsigned long align,
				  unsigned long goal) __malloc;
void *___alloc_bootmem_node_nopanic(pg_data_t *pgdat,
				  unsigned long size,
				  unsigned long align,
				  unsigned long goal,
				  unsigned long limit) __malloc;
extern void *__alloc_bootmem_low(unsigned long size,
				 unsigned long align,
				 unsigned long goal) __malloc;
void *__alloc_bootmem_low_nopanic(unsigned long size,
				 unsigned long align,
				 unsigned long goal) __malloc;
extern void *__alloc_bootmem_low_node(pg_data_t *pgdat,
				      unsigned long size,
				      unsigned long align,
				      unsigned long goal) __malloc;

/* We are using top down, so it is safe to use 0 here */
#define BOOTMEM_LOW_LIMIT 0

#ifndef ARCH_LOW_ADDRESS_LIMIT
#define ARCH_LOW_ADDRESS_LIMIT  0xffffffffUL
#endif

#define alloc_bootmem(x) \
	__alloc_bootmem(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_align(x, align) \
	__alloc_bootmem(x, align, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_nopanic(x) \
	__alloc_bootmem_nopanic(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_pages(x) \
	__alloc_bootmem(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_pages_nopanic(x) \
	__alloc_bootmem_nopanic(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_node(pgdat, x) \
	__alloc_bootmem_node(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_node_nopanic(pgdat, x) \
	__alloc_bootmem_node_nopanic(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_pages_node(pgdat, x) \
	__alloc_bootmem_node(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
#define alloc_bootmem_pages_node_nopanic(pgdat, x) \
	__alloc_bootmem_node_nopanic(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)

#define alloc_bootmem_low(x) \
	__alloc_bootmem_low(x, SMP_CACHE_BYTES, 0)
#define alloc_bootmem_low_pages_nopanic(x) \
	__alloc_bootmem_low_nopanic(x, PAGE_SIZE, 0)
#define alloc_bootmem_low_pages(x) \
	__alloc_bootmem_low(x, PAGE_SIZE, 0)
#define alloc_bootmem_low_pages_node(pgdat, x) \
	__alloc_bootmem_low_node(pgdat, x, PAGE_SIZE, 0)

/* FIXME: use MEMBLOCK_ALLOC_* variants here */
#define BOOTMEM_ALLOC_ACCESSIBLE	0
#define BOOTMEM_ALLOC_ANYWHERE		(~(phys_addr_t)0)

/* FIXME: Move to memblock.h at a point where we remove nobootmem.c */
void *memblock_virt_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
				      phys_addr_t min_addr,
				      phys_addr_t max_addr, int nid);
void *memblock_virt_alloc_try_nid_nopanic(phys_addr_t size,
		phys_addr_t align, phys_addr_t min_addr,
		phys_addr_t max_addr, int nid);
void *memblock_virt_alloc_try_nid(phys_addr_t size, phys_addr_t align,
		phys_addr_t min_addr, phys_addr_t max_addr, int nid);
void __memblock_free_early(phys_addr_t base, phys_addr_t size);
void __memblock_free_late(phys_addr_t base, phys_addr_t size);

static inline void * __init memblock_virt_alloc(
					phys_addr_t size,  phys_addr_t align)
{
	return memblock_virt_alloc_try_nid(size, align, BOOTMEM_LOW_LIMIT,
					    BOOTMEM_ALLOC_ACCESSIBLE,
					    NUMA_NO_NODE);
}

static inline void * __init memblock_virt_alloc_raw(
					phys_addr_t size,  phys_addr_t align)
{
	return memblock_virt_alloc_try_nid_raw(size, align, BOOTMEM_LOW_LIMIT,
					    BOOTMEM_ALLOC_ACCESSIBLE,
					    NUMA_NO_NODE);
}

static inline void * __init memblock_virt_alloc_nopanic(
					phys_addr_t size, phys_addr_t align)
{
	return memblock_virt_alloc_try_nid_nopanic(size, align,
						    BOOTMEM_LOW_LIMIT,
						    BOOTMEM_ALLOC_ACCESSIBLE,
						    NUMA_NO_NODE);
}

static inline void * __init memblock_virt_alloc_low(
					phys_addr_t size, phys_addr_t align)
{
	return memblock_virt_alloc_try_nid(size, align,
						   BOOTMEM_LOW_LIMIT,
						   ARCH_LOW_ADDRESS_LIMIT,
						   NUMA_NO_NODE);
}
static inline void * __init memblock_virt_alloc_low_nopanic(
					phys_addr_t size, phys_addr_t align)
{
	return memblock_virt_alloc_try_nid_nopanic(size, align,
						   BOOTMEM_LOW_LIMIT,
						   ARCH_LOW_ADDRESS_LIMIT,
						   NUMA_NO_NODE);
}

static inline void * __init memblock_virt_alloc_from_nopanic(
		phys_addr_t size, phys_addr_t align, phys_addr_t min_addr)
{
	return memblock_virt_alloc_try_nid_nopanic(size, align, min_addr,
						    BOOTMEM_ALLOC_ACCESSIBLE,
						    NUMA_NO_NODE);
}

static inline void * __init memblock_virt_alloc_node(
						phys_addr_t size, int nid)
{
	return memblock_virt_alloc_try_nid(size, 0, BOOTMEM_LOW_LIMIT,
					    BOOTMEM_ALLOC_ACCESSIBLE, nid);
}

static inline void * __init memblock_virt_alloc_node_nopanic(
						phys_addr_t size, int nid)
{
	return memblock_virt_alloc_try_nid_nopanic(size, 0, BOOTMEM_LOW_LIMIT,
						    BOOTMEM_ALLOC_ACCESSIBLE,
						    nid);
}

static inline void __init memblock_free_early(
					phys_addr_t base, phys_addr_t size)
{
	__memblock_free_early(base, size);
}

static inline void __init memblock_free_early_nid(
				phys_addr_t base, phys_addr_t size, int nid)
{
	__memblock_free_early(base, size);
}

static inline void __init memblock_free_late(
					phys_addr_t base, phys_addr_t size)
{
	__memblock_free_late(base, size);
}

extern void *alloc_large_system_hash(const char *tablename,
				     unsigned long bucketsize,
				     unsigned long numentries,
				     int scale,
				     int flags,
				     unsigned int *_hash_shift,
				     unsigned int *_hash_mask,
				     unsigned long low_limit,
				     unsigned long high_limit);

#define HASH_EARLY	0x00000001	/* Allocating during early boot? */
#define HASH_SMALL	0x00000002	/* sub-page allocation allowed, min
					 * shift passed via *_hash_shift */
#define HASH_ZERO	0x00000004	/* Zero allocated hash table */

/* Only NUMA needs hash distribution. 64bit NUMA architectures have
 * sufficient vmalloc space.
 */
#ifdef CONFIG_NUMA
#define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
extern int hashdist;		/* Distribute hashes across NUMA nodes? */
#else
#define hashdist (0)
#endif


#endif /* _LINUX_BOOTMEM_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/*
	3	* Discontiguous memory support, Kanoj Sarcar, SGI, Nov 1999
	4	*/
	5	#ifndef _LINUX_BOOTMEM_H
	6	#define _LINUX_BOOTMEM_H
	7
1da177e4	8	#include <linux/mmzone.h>
26f09e9b	9	#include <linux/mm_types.h>
e786e86a	10	#include <asm/dma.h>
2382705f	11	#include <asm/processor.h>
1da177e4 LT	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;
8dd33030 IM	24	/*
	25	* highest possible page
	26	*/
	27	extern unsigned long long max_possible_pfn;
1da177e4	28
223e8dc9	29	extern unsigned long free_all_bootmem(void);
f784a3f1	30	extern void reset_node_managed_pages(pg_data_t *pgdat);
7b4b2a0d	31	extern void reset_all_zones_managed_pages(void);
223e8dc9 JW	32
	33	extern void free_bootmem_node(pg_data_t *pgdat,
	34	unsigned long addr,
	35	unsigned long size);
81df9bff JK	36	extern void free_bootmem(unsigned long physaddr, unsigned long size);
81df9bff JK	37	extern void free_bootmem_late(unsigned long physaddr, unsigned long size);
223e8dc9 JW	38
	39	/*
	40	* Flags for reserve_bootmem (also if CONFIG_HAVE_ARCH_BOOTMEM_NODE,
	41	* the architecture-specific code should honor this).
	42	*
1754e44e WSH	43	* If flags is BOOTMEM_DEFAULT, then the return value is always 0 (success).
	44	* If flags contains BOOTMEM_EXCLUSIVE, then -EBUSY is returned if the memory
	45	* already was reserved.
223e8dc9 JW	46	*/
	47	#define BOOTMEM_DEFAULT 0
	48	#define BOOTMEM_EXCLUSIVE (1<<0)
	49
2d0aae41	50	extern void *__alloc_bootmem(unsigned long size,
f71bf0ca FBH	51	unsigned long align,
f71bf0ca FBH	52	unsigned long goal);
2d0aae41	53	extern void *__alloc_bootmem_nopanic(unsigned long size,
f71bf0ca	54	unsigned long align,
48a27055	55	unsigned long goal) __malloc;
223e8dc9 JW	56	extern void __alloc_bootmem_node(pg_data_t pgdat,
	57	unsigned long size,
	58	unsigned long align,
48a27055	59	unsigned long goal) __malloc;
08677214 YL	60	void __alloc_bootmem_node_high(pg_data_t pgdat,
	61	unsigned long size,
	62	unsigned long align,
48a27055	63	unsigned long goal) __malloc;
223e8dc9 JW	64	extern void __alloc_bootmem_node_nopanic(pg_data_t pgdat,
	65	unsigned long size,
	66	unsigned long align,
48a27055	67	unsigned long goal) __malloc;
99ab7b19 YL	68	void ___alloc_bootmem_node_nopanic(pg_data_t pgdat,
	69	unsigned long size,
	70	unsigned long align,
	71	unsigned long goal,
48a27055	72	unsigned long limit) __malloc;
2d0aae41 TH	73	extern void *__alloc_bootmem_low(unsigned long size,
2d0aae41 TH	74	unsigned long align,
48a27055	75	unsigned long goal) __malloc;
38fa4175 YL	76	void *__alloc_bootmem_low_nopanic(unsigned long size,
38fa4175 YL	77	unsigned long align,
48a27055	78	unsigned long goal) __malloc;
f71bf0ca FBH	79	extern void __alloc_bootmem_low_node(pg_data_t pgdat,
	80	unsigned long size,
	81	unsigned long align,
48a27055	82	unsigned long goal) __malloc;
c1329375	83
8bba154e YL	84	/* We are using top down, so it is safe to use 0 here */
8bba154e YL	85	#define BOOTMEM_LOW_LIMIT 0
8bba154e	86
2382705f	87	#ifndef ARCH_LOW_ADDRESS_LIMIT
	88	#define ARCH_LOW_ADDRESS_LIMIT 0xffffffffUL
	89	#endif
	90
1da177e4	91	#define alloc_bootmem(x) \
8bba154e	92	__alloc_bootmem(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
53dde5f3	93	#define alloc_bootmem_align(x, align) \
8bba154e	94	__alloc_bootmem(x, align, BOOTMEM_LOW_LIMIT)
74768ed8	95	#define alloc_bootmem_nopanic(x) \
8bba154e	96	__alloc_bootmem_nopanic(x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
1da177e4	97	#define alloc_bootmem_pages(x) \
8bba154e	98	__alloc_bootmem(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
74768ed8	99	#define alloc_bootmem_pages_nopanic(x) \
8bba154e	100	__alloc_bootmem_nopanic(x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
1da177e4	101	#define alloc_bootmem_node(pgdat, x) \
8bba154e	102	__alloc_bootmem_node(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
8f389a99	103	#define alloc_bootmem_node_nopanic(pgdat, x) \
8bba154e	104	__alloc_bootmem_node_nopanic(pgdat, x, SMP_CACHE_BYTES, BOOTMEM_LOW_LIMIT)
1da177e4	105	#define alloc_bootmem_pages_node(pgdat, x) \
8bba154e	106	__alloc_bootmem_node(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
2d0aae41	107	#define alloc_bootmem_pages_node_nopanic(pgdat, x) \
8bba154e	108	__alloc_bootmem_node_nopanic(pgdat, x, PAGE_SIZE, BOOTMEM_LOW_LIMIT)
2d0aae41 TH	109
	110	#define alloc_bootmem_low(x) \
	111	__alloc_bootmem_low(x, SMP_CACHE_BYTES, 0)
38fa4175 YL	112	#define alloc_bootmem_low_pages_nopanic(x) \
38fa4175 YL	113	__alloc_bootmem_low_nopanic(x, PAGE_SIZE, 0)
2d0aae41 TH	114	#define alloc_bootmem_low_pages(x) \
2d0aae41 TH	115	__alloc_bootmem_low(x, PAGE_SIZE, 0)
1da177e4	116	#define alloc_bootmem_low_pages_node(pgdat, x) \
71fb2e8f	117	__alloc_bootmem_low_node(pgdat, x, PAGE_SIZE, 0)
c6af5e9f	118
26f09e9b SS	119	/* FIXME: use MEMBLOCK_ALLOC_* variants here */
	120	#define BOOTMEM_ALLOC_ACCESSIBLE 0
	121	#define BOOTMEM_ALLOC_ANYWHERE (~(phys_addr_t)0)
	122
	123	/* FIXME: Move to memblock.h at a point where we remove nobootmem.c */
ea1f5f37 PT	124	void *memblock_virt_alloc_try_nid_raw(phys_addr_t size, phys_addr_t align,
	125	phys_addr_t min_addr,
	126	phys_addr_t max_addr, int nid);
26f09e9b SS	127	void *memblock_virt_alloc_try_nid_nopanic(phys_addr_t size,
	128	phys_addr_t align, phys_addr_t min_addr,
	129	phys_addr_t max_addr, int nid);
	130	void *memblock_virt_alloc_try_nid(phys_addr_t size, phys_addr_t align,
	131	phys_addr_t min_addr, phys_addr_t max_addr, int nid);
	132	void __memblock_free_early(phys_addr_t base, phys_addr_t size);
	133	void __memblock_free_late(phys_addr_t base, phys_addr_t size);
	134
	135	static inline void * __init memblock_virt_alloc(
	136	phys_addr_t size, phys_addr_t align)
	137	{
	138	return memblock_virt_alloc_try_nid(size, align, BOOTMEM_LOW_LIMIT,
	139	BOOTMEM_ALLOC_ACCESSIBLE,
	140	NUMA_NO_NODE);
	141	}
	142
ea1f5f37 PT	143	static inline void * __init memblock_virt_alloc_raw(
	144	phys_addr_t size, phys_addr_t align)
	145	{
	146	return memblock_virt_alloc_try_nid_raw(size, align, BOOTMEM_LOW_LIMIT,
	147	BOOTMEM_ALLOC_ACCESSIBLE,
	148	NUMA_NO_NODE);
	149	}
	150
26f09e9b SS	151	static inline void * __init memblock_virt_alloc_nopanic(
	152	phys_addr_t size, phys_addr_t align)
	153	{
	154	return memblock_virt_alloc_try_nid_nopanic(size, align,
	155	BOOTMEM_LOW_LIMIT,
	156	BOOTMEM_ALLOC_ACCESSIBLE,
	157	NUMA_NO_NODE);
	158	}
	159
ad6492b8 YL	160	static inline void * __init memblock_virt_alloc_low(
	161	phys_addr_t size, phys_addr_t align)
	162	{
	163	return memblock_virt_alloc_try_nid(size, align,
	164	BOOTMEM_LOW_LIMIT,
	165	ARCH_LOW_ADDRESS_LIMIT,
	166	NUMA_NO_NODE);
	167	}
	168	static inline void * __init memblock_virt_alloc_low_nopanic(
	169	phys_addr_t size, phys_addr_t align)
	170	{
	171	return memblock_virt_alloc_try_nid_nopanic(size, align,
	172	BOOTMEM_LOW_LIMIT,
	173	ARCH_LOW_ADDRESS_LIMIT,
	174	NUMA_NO_NODE);
	175	}
	176
26f09e9b SS	177	static inline void * __init memblock_virt_alloc_from_nopanic(
	178	phys_addr_t size, phys_addr_t align, phys_addr_t min_addr)
	179	{
	180	return memblock_virt_alloc_try_nid_nopanic(size, align, min_addr,
	181	BOOTMEM_ALLOC_ACCESSIBLE,
	182	NUMA_NO_NODE);
	183	}
	184
	185	static inline void * __init memblock_virt_alloc_node(
	186	phys_addr_t size, int nid)
	187	{
	188	return memblock_virt_alloc_try_nid(size, 0, BOOTMEM_LOW_LIMIT,
	189	BOOTMEM_ALLOC_ACCESSIBLE, nid);
	190	}
	191
	192	static inline void * __init memblock_virt_alloc_node_nopanic(
	193	phys_addr_t size, int nid)
	194	{
	195	return memblock_virt_alloc_try_nid_nopanic(size, 0, BOOTMEM_LOW_LIMIT,
	196	BOOTMEM_ALLOC_ACCESSIBLE,
	197	nid);
	198	}
	199
	200	static inline void __init memblock_free_early(
	201	phys_addr_t base, phys_addr_t size)
	202	{
	203	__memblock_free_early(base, size);
	204	}
	205
	206	static inline void __init memblock_free_early_nid(
	207	phys_addr_t base, phys_addr_t size, int nid)
	208	{
	209	__memblock_free_early(base, size);
	210	}
	211
	212	static inline void __init memblock_free_late(
	213	phys_addr_t base, phys_addr_t size)
	214	{
	215	__memblock_free_late(base, size);
	216	}
	217
f71bf0ca FBH	218	extern void alloc_large_system_hash(const char tablename,
	219	unsigned long bucketsize,
	220	unsigned long numentries,
	221	int scale,
	222	int flags,
	223	unsigned int *_hash_shift,
	224	unsigned int *_hash_mask,
31fe62b9 TB	225	unsigned long low_limit,
31fe62b9 TB	226	unsigned long high_limit);
1da177e4	227
04903664	228	#define HASH_EARLY 0x00000001 /* Allocating during early boot? */
2c85f51d JB	229	#define HASH_SMALL 0x00000002 /* sub-page allocation allowed, min
2c85f51d JB	230	* shift passed via _hash_shift /
3749a8f0	231	#define HASH_ZERO 0x00000004 /* Zero allocated hash table */
1da177e4	232
c2fdf3a9 AB	233	/* Only NUMA needs hash distribution. 64bit NUMA architectures have
c2fdf3a9 AB	234	* sufficient vmalloc space.
1da177e4	235	*/
a9919c79 RV	236	#ifdef CONFIG_NUMA
	237	#define HASHDIST_DEFAULT IS_ENABLED(CONFIG_64BIT)
	238	extern int hashdist; /* Distribute hashes across NUMA nodes? */
1da177e4	239	#else
a9919c79	240	#define hashdist (0)
1da177e4	241	#endif
1da177e4 LT	242
	243
	244	#endif /* _LINUX_BOOTMEM_H */