[mirror_ubuntu-bionic-kernel.git] / include / linux / memblock.h

#ifndef _LINUX_MEMBLOCK_H
#define _LINUX_MEMBLOCK_H
#ifdef __KERNEL__

#ifdef CONFIG_HAVE_MEMBLOCK
/*
 * Logical memory blocks.
 *
 * Copyright (C) 2001 Peter Bergner, IBM Corp.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#include <linux/init.h>
#include <linux/mm.h>

#define INIT_MEMBLOCK_REGIONS	128
#define INIT_PHYSMEM_REGIONS	4

/* Definition of memblock flags. */
enum {
	MEMBLOCK_NONE		= 0x0,	/* No special request */
	MEMBLOCK_HOTPLUG	= 0x1,	/* hotpluggable region */
	MEMBLOCK_MIRROR		= 0x2,	/* mirrored region */
	MEMBLOCK_NOMAP		= 0x4,	/* don't add to kernel direct mapping */
};

struct memblock_region {
	phys_addr_t base;
	phys_addr_t size;
	unsigned long flags;
#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
	int nid;
#endif
};

struct memblock_type {
	unsigned long cnt;	/* number of regions */
	unsigned long max;	/* size of the allocated array */
	phys_addr_t total_size;	/* size of all regions */
	struct memblock_region *regions;
	char *name;
};

struct memblock {
	bool bottom_up;  /* is bottom up direction? */
	phys_addr_t current_limit;
	struct memblock_type memory;
	struct memblock_type reserved;
#ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
	struct memblock_type physmem;
#endif
};

extern struct memblock memblock;
extern int memblock_debug;

#ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
#define __init_memblock __meminit
#define __initdata_memblock __meminitdata
void memblock_discard(void);
#else
#define __init_memblock
#define __initdata_memblock
#endif

#define memblock_dbg(fmt, ...) \
	if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)

phys_addr_t memblock_find_in_range_node(phys_addr_t size, phys_addr_t align,
					phys_addr_t start, phys_addr_t end,
					int nid, ulong flags);
phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
				   phys_addr_t size, phys_addr_t align);
void memblock_allow_resize(void);
int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
int memblock_add(phys_addr_t base, phys_addr_t size);
int memblock_remove(phys_addr_t base, phys_addr_t size);
int memblock_free(phys_addr_t base, phys_addr_t size);
int memblock_reserve(phys_addr_t base, phys_addr_t size);
void memblock_trim_memory(phys_addr_t align);
bool memblock_overlaps_region(struct memblock_type *type,
			      phys_addr_t base, phys_addr_t size);
int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
int memblock_clear_nomap(phys_addr_t base, phys_addr_t size);
ulong choose_memblock_flags(void);

/* Low level functions */
int memblock_add_range(struct memblock_type *type,
		       phys_addr_t base, phys_addr_t size,
		       int nid, unsigned long flags);

void __next_mem_range(u64 *idx, int nid, ulong flags,
		      struct memblock_type *type_a,
		      struct memblock_type *type_b, phys_addr_t *out_start,
		      phys_addr_t *out_end, int *out_nid);

void __next_mem_range_rev(u64 *idx, int nid, ulong flags,
			  struct memblock_type *type_a,
			  struct memblock_type *type_b, phys_addr_t *out_start,
			  phys_addr_t *out_end, int *out_nid);

void __next_reserved_mem_region(u64 *idx, phys_addr_t *out_start,
				phys_addr_t *out_end);

void __memblock_free_early(phys_addr_t base, phys_addr_t size);
void __memblock_free_late(phys_addr_t base, phys_addr_t size);

/**
 * for_each_mem_range - iterate through memblock areas from type_a and not
 * included in type_b. Or just type_a if type_b is NULL.
 * @i: u64 used as loop variable
 * @type_a: ptr to memblock_type to iterate
 * @type_b: ptr to memblock_type which excludes from the iteration
 * @nid: node selector, %NUMA_NO_NODE for all nodes
 * @flags: pick from blocks based on memory attributes
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 * @p_nid: ptr to int for nid of the range, can be %NULL
 */
#define for_each_mem_range(i, type_a, type_b, nid, flags,		\
			   p_start, p_end, p_nid)			\
	for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b,	\
				     p_start, p_end, p_nid);		\
	     i != (u64)ULLONG_MAX;					\
	     __next_mem_range(&i, nid, flags, type_a, type_b,		\
			      p_start, p_end, p_nid))

/**
 * for_each_mem_range_rev - reverse iterate through memblock areas from
 * type_a and not included in type_b. Or just type_a if type_b is NULL.
 * @i: u64 used as loop variable
 * @type_a: ptr to memblock_type to iterate
 * @type_b: ptr to memblock_type which excludes from the iteration
 * @nid: node selector, %NUMA_NO_NODE for all nodes
 * @flags: pick from blocks based on memory attributes
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 * @p_nid: ptr to int for nid of the range, can be %NULL
 */
#define for_each_mem_range_rev(i, type_a, type_b, nid, flags,		\
			       p_start, p_end, p_nid)			\
	for (i = (u64)ULLONG_MAX,					\
		     __next_mem_range_rev(&i, nid, flags, type_a, type_b,\
					  p_start, p_end, p_nid);	\
	     i != (u64)ULLONG_MAX;					\
	     __next_mem_range_rev(&i, nid, flags, type_a, type_b,	\
				  p_start, p_end, p_nid))

/**
 * for_each_reserved_mem_region - iterate over all reserved memblock areas
 * @i: u64 used as loop variable
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 *
 * Walks over reserved areas of memblock. Available as soon as memblock
 * is initialized.
 */
#define for_each_reserved_mem_region(i, p_start, p_end)			\
	for (i = 0UL, __next_reserved_mem_region(&i, p_start, p_end);	\
	     i != (u64)ULLONG_MAX;					\
	     __next_reserved_mem_region(&i, p_start, p_end))

static inline bool memblock_is_hotpluggable(struct memblock_region *m)
{
	return m->flags & MEMBLOCK_HOTPLUG;
}

static inline bool memblock_is_mirror(struct memblock_region *m)
{
	return m->flags & MEMBLOCK_MIRROR;
}

static inline bool memblock_is_nomap(struct memblock_region *m)
{
	return m->flags & MEMBLOCK_NOMAP;
}

#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
			    unsigned long  *end_pfn);
void __next_mem_pfn_range(int *idx, int nid, unsigned long *out_start_pfn,
			  unsigned long *out_end_pfn, int *out_nid);
unsigned long memblock_next_valid_pfn(unsigned long pfn, unsigned long max_pfn);

/**
 * for_each_mem_pfn_range - early memory pfn range iterator
 * @i: an integer used as loop variable
 * @nid: node selector, %MAX_NUMNODES for all nodes
 * @p_start: ptr to ulong for start pfn of the range, can be %NULL
 * @p_end: ptr to ulong for end pfn of the range, can be %NULL
 * @p_nid: ptr to int for nid of the range, can be %NULL
 *
 * Walks over configured memory ranges.
 */
#define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid)		\
	for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
	     i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
#endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */

/**
 * for_each_free_mem_range - iterate through free memblock areas
 * @i: u64 used as loop variable
 * @nid: node selector, %NUMA_NO_NODE for all nodes
 * @flags: pick from blocks based on memory attributes
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 * @p_nid: ptr to int for nid of the range, can be %NULL
 *
 * Walks over free (memory && !reserved) areas of memblock.  Available as
 * soon as memblock is initialized.
 */
#define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid)	\
	for_each_mem_range(i, &memblock.memory, &memblock.reserved,	\
			   nid, flags, p_start, p_end, p_nid)

/**
 * for_each_free_mem_range_reverse - rev-iterate through free memblock areas
 * @i: u64 used as loop variable
 * @nid: node selector, %NUMA_NO_NODE for all nodes
 * @flags: pick from blocks based on memory attributes
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 * @p_nid: ptr to int for nid of the range, can be %NULL
 *
 * Walks over free (memory && !reserved) areas of memblock in reverse
 * order.  Available as soon as memblock is initialized.
 */
#define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end,	\
					p_nid)				\
	for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved,	\
			       nid, flags, p_start, p_end, p_nid)

/**
 * for_each_resv_unavail_range - iterate through reserved and unavailable memory
 * @i: u64 used as loop variable
 * @flags: pick from blocks based on memory attributes
 * @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
 * @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
 *
 * Walks over unavailable but reserved (reserved && !memory) areas of memblock.
 * Available as soon as memblock is initialized.
 * Note: because this memory does not belong to any physical node, flags and
 * nid arguments do not make sense and thus not exported as arguments.
 */
#define for_each_resv_unavail_range(i, p_start, p_end)			\
	for_each_mem_range(i, &memblock.reserved, &memblock.memory,	\
			   NUMA_NO_NODE, MEMBLOCK_NONE, p_start, p_end, NULL)

static inline void memblock_set_region_flags(struct memblock_region *r,
					     unsigned long flags)
{
	r->flags |= flags;
}

static inline void memblock_clear_region_flags(struct memblock_region *r,
					       unsigned long flags)
{
	r->flags &= ~flags;
}

#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
int memblock_set_node(phys_addr_t base, phys_addr_t size,
		      struct memblock_type *type, int nid);

static inline void memblock_set_region_node(struct memblock_region *r, int nid)
{
	r->nid = nid;
}

static inline int memblock_get_region_node(const struct memblock_region *r)
{
	return r->nid;
}
#else
static inline void memblock_set_region_node(struct memblock_region *r, int nid)
{
}

static inline int memblock_get_region_node(const struct memblock_region *r)
{
	return 0;
}
#endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */

phys_addr_t memblock_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
phys_addr_t memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);

phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align);

/*
 * Set the allocation direction to bottom-up or top-down.
 */
static inline void __init memblock_set_bottom_up(bool enable)
{
	memblock.bottom_up = enable;
}

/*
 * Check if the allocation direction is bottom-up or not.
 * if this is true, that said, memblock will allocate memory
 * in bottom-up direction.
 */
static inline bool memblock_bottom_up(void)
{
	return memblock.bottom_up;
}

/* Flags for memblock_alloc_base() amd __memblock_alloc_base() */
#define MEMBLOCK_ALLOC_ANYWHERE	(~(phys_addr_t)0)
#define MEMBLOCK_ALLOC_ACCESSIBLE	0

phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
					phys_addr_t start, phys_addr_t end,
					ulong flags);
phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
				phys_addr_t max_addr);
phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
				  phys_addr_t max_addr);
phys_addr_t memblock_phys_mem_size(void);
phys_addr_t memblock_reserved_size(void);
phys_addr_t memblock_mem_size(unsigned long limit_pfn);
phys_addr_t memblock_start_of_DRAM(void);
phys_addr_t memblock_end_of_DRAM(void);
void memblock_enforce_memory_limit(phys_addr_t memory_limit);
void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
void memblock_mem_limit_remove_map(phys_addr_t limit);
bool memblock_is_memory(phys_addr_t addr);
int memblock_is_map_memory(phys_addr_t addr);
int memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
bool memblock_is_reserved(phys_addr_t addr);
bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);

extern void __memblock_dump_all(void);

static inline void memblock_dump_all(void)
{
	if (memblock_debug)
		__memblock_dump_all();
}

/**
 * memblock_set_current_limit - Set the current allocation limit to allow
 *                         limiting allocations to what is currently
 *                         accessible during boot
 * @limit: New limit value (physical address)
 */
void memblock_set_current_limit(phys_addr_t limit);


phys_addr_t memblock_get_current_limit(void);

/*
 * pfn conversion functions
 *
 * While the memory MEMBLOCKs should always be page aligned, the reserved
 * MEMBLOCKs may not be. This accessor attempt to provide a very clear
 * idea of what they return for such non aligned MEMBLOCKs.
 */

/**
 * memblock_region_memory_base_pfn - Return the lowest pfn intersecting with the memory region
 * @reg: memblock_region structure
 */
static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
{
	return PFN_UP(reg->base);
}

/**
 * memblock_region_memory_end_pfn - Return the end_pfn this region
 * @reg: memblock_region structure
 */
static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
{
	return PFN_DOWN(reg->base + reg->size);
}

/**
 * memblock_region_reserved_base_pfn - Return the lowest pfn intersecting with the reserved region
 * @reg: memblock_region structure
 */
static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
{
	return PFN_DOWN(reg->base);
}

/**
 * memblock_region_reserved_end_pfn - Return the end_pfn this region
 * @reg: memblock_region structure
 */
static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
{
	return PFN_UP(reg->base + reg->size);
}

#define for_each_memblock(memblock_type, region)					\
	for (region = memblock.memblock_type.regions;					\
	     region < (memblock.memblock_type.regions + memblock.memblock_type.cnt);	\
	     region++)

#define for_each_memblock_type(i, memblock_type, rgn)			\
	for (i = 0, rgn = &memblock_type->regions[0];			\
	     i < memblock_type->cnt;					\
	     i++, rgn = &memblock_type->regions[i])

#ifdef CONFIG_MEMTEST
extern void early_memtest(phys_addr_t start, phys_addr_t end);
#else
static inline void early_memtest(phys_addr_t start, phys_addr_t end)
{
}
#endif

extern unsigned long memblock_reserved_memory_within(phys_addr_t start_addr,
		phys_addr_t end_addr);
#else
static inline phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align)
{
	return 0;
}

static inline unsigned long memblock_reserved_memory_within(phys_addr_t start_addr,
		phys_addr_t end_addr)
{
	return 0;
}

#endif /* CONFIG_HAVE_MEMBLOCK */

#endif /* __KERNEL__ */

#endif /* _LINUX_MEMBLOCK_H */
Commit	Line	Data
95f72d1e YL	1	#ifndef _LINUX_MEMBLOCK_H
	2	#define _LINUX_MEMBLOCK_H
	3	#ifdef __KERNEL__
	4
f0b37fad	5	#ifdef CONFIG_HAVE_MEMBLOCK
95f72d1e YL	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
37d8d4bf	20	#define INIT_MEMBLOCK_REGIONS 128
70210ed9	21	#define INIT_PHYSMEM_REGIONS 4
95f72d1e	22
66b16edf	23	/* Definition of memblock flags. */
fc6daaf9 TL	24	enum {
	25	MEMBLOCK_NONE = 0x0, /* No special request */
	26	MEMBLOCK_HOTPLUG = 0x1, /* hotpluggable region */
a3f5bafc	27	MEMBLOCK_MIRROR = 0x2, /* mirrored region */
bf3d3cc5	28	MEMBLOCK_NOMAP = 0x4, /* don't add to kernel direct mapping */
fc6daaf9	29	};
66b16edf	30
e3239ff9	31	struct memblock_region {
2898cc4c BH	32	phys_addr_t base;
2898cc4c BH	33	phys_addr_t size;
66a20757	34	unsigned long flags;
7c0caeb8 TH	35	#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
	36	int nid;
	37	#endif
95f72d1e YL	38	};
95f72d1e YL	39
e3239ff9	40	struct memblock_type {
bf23c51f BH	41	unsigned long cnt; /* number of regions */
bf23c51f BH	42	unsigned long max; /* size of the allocated array */
1440c4e2	43	phys_addr_t total_size; /* size of all regions */
bf23c51f	44	struct memblock_region *regions;
0262d9c8	45	char *name;
95f72d1e YL	46	};
	47
	48	struct memblock {
79442ed1	49	bool bottom_up; /* is bottom up direction? */
2898cc4c	50	phys_addr_t current_limit;
e3239ff9 BH	51	struct memblock_type memory;
e3239ff9 BH	52	struct memblock_type reserved;
70210ed9 PH	53	#ifdef CONFIG_HAVE_MEMBLOCK_PHYS_MAP
	54	struct memblock_type physmem;
	55	#endif
95f72d1e YL	56	};
	57
	58	extern struct memblock memblock;
5e63cf43	59	extern int memblock_debug;
5e63cf43	60
036fbb21 KS	61	#ifdef CONFIG_ARCH_DISCARD_MEMBLOCK
	62	#define __init_memblock __meminit
	63	#define __initdata_memblock __meminitdata
3010f876	64	void memblock_discard(void);
036fbb21 KS	65	#else
	66	#define __init_memblock
	67	#define __initdata_memblock
	68	#endif
	69
5e63cf43 YL	70	#define memblock_dbg(fmt, ...) \
5e63cf43 YL	71	if (memblock_debug) printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
95f72d1e	72
87029ee9	73	phys_addr_t memblock_find_in_range_node(phys_addr_t size, phys_addr_t align,
ba6c19fd CG	74	phys_addr_t start, phys_addr_t end,
ba6c19fd CG	75	int nid, ulong flags);
fc769a8e TH	76	phys_addr_t memblock_find_in_range(phys_addr_t start, phys_addr_t end,
fc769a8e TH	77	phys_addr_t size, phys_addr_t align);
1aadc056	78	void memblock_allow_resize(void);
7fb0bc3f	79	int memblock_add_node(phys_addr_t base, phys_addr_t size, int nid);
581adcbe TH	80	int memblock_add(phys_addr_t base, phys_addr_t size);
	81	int memblock_remove(phys_addr_t base, phys_addr_t size);
	82	int memblock_free(phys_addr_t base, phys_addr_t size);
	83	int memblock_reserve(phys_addr_t base, phys_addr_t size);
6ede1fd3	84	void memblock_trim_memory(phys_addr_t align);
95cf82ec TC	85	bool memblock_overlaps_region(struct memblock_type *type,
95cf82ec TC	86	phys_addr_t base, phys_addr_t size);
66b16edf TC	87	int memblock_mark_hotplug(phys_addr_t base, phys_addr_t size);
66b16edf TC	88	int memblock_clear_hotplug(phys_addr_t base, phys_addr_t size);
a3f5bafc	89	int memblock_mark_mirror(phys_addr_t base, phys_addr_t size);
bf3d3cc5	90	int memblock_mark_nomap(phys_addr_t base, phys_addr_t size);
4c546b8a	91	int memblock_clear_nomap(phys_addr_t base, phys_addr_t size);
a3f5bafc	92	ulong choose_memblock_flags(void);
f1af9d3a PH	93
	94	/* Low level functions */
	95	int memblock_add_range(struct memblock_type *type,
	96	phys_addr_t base, phys_addr_t size,
	97	int nid, unsigned long flags);
	98
fc6daaf9 TL	99	void __next_mem_range(u64 *idx, int nid, ulong flags,
fc6daaf9 TL	100	struct memblock_type *type_a,
f1af9d3a PH	101	struct memblock_type type_b, phys_addr_t out_start,
	102	phys_addr_t out_end, int out_nid);
	103
fc6daaf9 TL	104	void __next_mem_range_rev(u64 *idx, int nid, ulong flags,
fc6daaf9 TL	105	struct memblock_type *type_a,
f1af9d3a PH	106	struct memblock_type type_b, phys_addr_t out_start,
	107	phys_addr_t out_end, int out_nid);
	108
8e7a7f86	109	void __next_reserved_mem_region(u64 idx, phys_addr_t out_start,
ba6c19fd	110	phys_addr_t *out_end);
8e7a7f86	111
3010f876 PT	112	void __memblock_free_early(phys_addr_t base, phys_addr_t size);
	113	void __memblock_free_late(phys_addr_t base, phys_addr_t size);
	114
f1af9d3a PH	115	/**
	116	* for_each_mem_range - iterate through memblock areas from type_a and not
	117	* included in type_b. Or just type_a if type_b is NULL.
	118	* @i: u64 used as loop variable
	119	* @type_a: ptr to memblock_type to iterate
	120	* @type_b: ptr to memblock_type which excludes from the iteration
	121	* @nid: node selector, %NUMA_NO_NODE for all nodes
fc6daaf9	122	* @flags: pick from blocks based on memory attributes
f1af9d3a PH	123	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	124	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	125	* @p_nid: ptr to int for nid of the range, can be %NULL
	126	*/
fc6daaf9	127	#define for_each_mem_range(i, type_a, type_b, nid, flags, \
f1af9d3a	128	p_start, p_end, p_nid) \
fc6daaf9	129	for (i = 0, __next_mem_range(&i, nid, flags, type_a, type_b, \
f1af9d3a PH	130	p_start, p_end, p_nid); \
f1af9d3a PH	131	i != (u64)ULLONG_MAX; \
fc6daaf9	132	__next_mem_range(&i, nid, flags, type_a, type_b, \
f1af9d3a PH	133	p_start, p_end, p_nid))
	134
	135	/**
	136	* for_each_mem_range_rev - reverse iterate through memblock areas from
	137	* type_a and not included in type_b. Or just type_a if type_b is NULL.
	138	* @i: u64 used as loop variable
	139	* @type_a: ptr to memblock_type to iterate
	140	* @type_b: ptr to memblock_type which excludes from the iteration
	141	* @nid: node selector, %NUMA_NO_NODE for all nodes
fc6daaf9	142	* @flags: pick from blocks based on memory attributes
f1af9d3a PH	143	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	144	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	145	* @p_nid: ptr to int for nid of the range, can be %NULL
	146	*/
fc6daaf9	147	#define for_each_mem_range_rev(i, type_a, type_b, nid, flags, \
f1af9d3a PH	148	p_start, p_end, p_nid) \
f1af9d3a PH	149	for (i = (u64)ULLONG_MAX, \
fc6daaf9	150	__next_mem_range_rev(&i, nid, flags, type_a, type_b,\
ba6c19fd	151	p_start, p_end, p_nid); \
f1af9d3a	152	i != (u64)ULLONG_MAX; \
fc6daaf9	153	__next_mem_range_rev(&i, nid, flags, type_a, type_b, \
f1af9d3a PH	154	p_start, p_end, p_nid))
f1af9d3a PH	155
8e7a7f86 RH	156	/**
	157	* for_each_reserved_mem_region - iterate over all reserved memblock areas
	158	* @i: u64 used as loop variable
	159	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	160	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	161	*
	162	* Walks over reserved areas of memblock. Available as soon as memblock
	163	* is initialized.
	164	*/
	165	#define for_each_reserved_mem_region(i, p_start, p_end) \
ba6c19fd	166	for (i = 0UL, __next_reserved_mem_region(&i, p_start, p_end); \
8e7a7f86 RH	167	i != (u64)ULLONG_MAX; \
	168	__next_reserved_mem_region(&i, p_start, p_end))
	169
55ac590c TC	170	static inline bool memblock_is_hotpluggable(struct memblock_region *m)
	171	{
	172	return m->flags & MEMBLOCK_HOTPLUG;
	173	}
	174
a3f5bafc TL	175	static inline bool memblock_is_mirror(struct memblock_region *m)
	176	{
	177	return m->flags & MEMBLOCK_MIRROR;
	178	}
	179
bf3d3cc5 AB	180	static inline bool memblock_is_nomap(struct memblock_region *m)
	181	{
	182	return m->flags & MEMBLOCK_NOMAP;
	183	}
	184
0ee332c1	185	#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
e76b63f8 YL	186	int memblock_search_pfn_nid(unsigned long pfn, unsigned long *start_pfn,
e76b63f8 YL	187	unsigned long *end_pfn);
0ee332c1 TH	188	void __next_mem_pfn_range(int idx, int nid, unsigned long out_start_pfn,
0ee332c1 TH	189	unsigned long out_end_pfn, int out_nid);
b92df1de	190	unsigned long memblock_next_valid_pfn(unsigned long pfn, unsigned long max_pfn);
0ee332c1 TH	191
	192	/**
	193	* for_each_mem_pfn_range - early memory pfn range iterator
	194	* @i: an integer used as loop variable
	195	* @nid: node selector, %MAX_NUMNODES for all nodes
	196	* @p_start: ptr to ulong for start pfn of the range, can be %NULL
	197	* @p_end: ptr to ulong for end pfn of the range, can be %NULL
	198	* @p_nid: ptr to int for nid of the range, can be %NULL
	199	*
f2d52fe5	200	* Walks over configured memory ranges.
0ee332c1 TH	201	*/
	202	#define for_each_mem_pfn_range(i, nid, p_start, p_end, p_nid) \
	203	for (i = -1, __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid); \
	204	i >= 0; __next_mem_pfn_range(&i, nid, p_start, p_end, p_nid))
	205	#endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
	206
35fd0808 TH	207	/**
	208	* for_each_free_mem_range - iterate through free memblock areas
	209	* @i: u64 used as loop variable
b1154233	210	* @nid: node selector, %NUMA_NO_NODE for all nodes
d30b5545	211	* @flags: pick from blocks based on memory attributes
35fd0808 TH	212	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	213	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	214	* @p_nid: ptr to int for nid of the range, can be %NULL
	215	*
	216	* Walks over free (memory && !reserved) areas of memblock. Available as
	217	* soon as memblock is initialized.
	218	*/
fc6daaf9	219	#define for_each_free_mem_range(i, nid, flags, p_start, p_end, p_nid) \
f1af9d3a	220	for_each_mem_range(i, &memblock.memory, &memblock.reserved, \
fc6daaf9	221	nid, flags, p_start, p_end, p_nid)
7bd0b0f0 TH	222
	223	/**
	224	* for_each_free_mem_range_reverse - rev-iterate through free memblock areas
	225	* @i: u64 used as loop variable
b1154233	226	* @nid: node selector, %NUMA_NO_NODE for all nodes
d30b5545	227	* @flags: pick from blocks based on memory attributes
7bd0b0f0 TH	228	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	229	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	230	* @p_nid: ptr to int for nid of the range, can be %NULL
	231	*
	232	* Walks over free (memory && !reserved) areas of memblock in reverse
	233	* order. Available as soon as memblock is initialized.
	234	*/
fc6daaf9 TL	235	#define for_each_free_mem_range_reverse(i, nid, flags, p_start, p_end, \
fc6daaf9 TL	236	p_nid) \
f1af9d3a	237	for_each_mem_range_rev(i, &memblock.memory, &memblock.reserved, \
fc6daaf9	238	nid, flags, p_start, p_end, p_nid)
7bd0b0f0	239
a4a3ede2 PT	240	/**
	241	* for_each_resv_unavail_range - iterate through reserved and unavailable memory
	242	* @i: u64 used as loop variable
	243	* @flags: pick from blocks based on memory attributes
	244	* @p_start: ptr to phys_addr_t for start address of the range, can be %NULL
	245	* @p_end: ptr to phys_addr_t for end address of the range, can be %NULL
	246	*
	247	* Walks over unavailable but reserved (reserved && !memory) areas of memblock.
	248	* Available as soon as memblock is initialized.
	249	* Note: because this memory does not belong to any physical node, flags and
	250	* nid arguments do not make sense and thus not exported as arguments.
	251	*/
	252	#define for_each_resv_unavail_range(i, p_start, p_end) \
	253	for_each_mem_range(i, &memblock.reserved, &memblock.memory, \
	254	NUMA_NO_NODE, MEMBLOCK_NONE, p_start, p_end, NULL)
	255
66b16edf TC	256	static inline void memblock_set_region_flags(struct memblock_region *r,
	257	unsigned long flags)
	258	{
	259	r->flags \|= flags;
	260	}
	261
	262	static inline void memblock_clear_region_flags(struct memblock_region *r,
	263	unsigned long flags)
	264	{
	265	r->flags &= ~flags;
	266	}
	267
7c0caeb8	268	#ifdef CONFIG_HAVE_MEMBLOCK_NODE_MAP
e7e8de59 TC	269	int memblock_set_node(phys_addr_t base, phys_addr_t size,
e7e8de59 TC	270	struct memblock_type *type, int nid);
7c0caeb8 TH	271
	272	static inline void memblock_set_region_node(struct memblock_region *r, int nid)
	273	{
	274	r->nid = nid;
	275	}
	276
	277	static inline int memblock_get_region_node(const struct memblock_region *r)
	278	{
	279	return r->nid;
	280	}
	281	#else
	282	static inline void memblock_set_region_node(struct memblock_region *r, int nid)
	283	{
	284	}
	285
	286	static inline int memblock_get_region_node(const struct memblock_region *r)
	287	{
	288	return 0;
	289	}
	290	#endif /* CONFIG_HAVE_MEMBLOCK_NODE_MAP */
	291
581adcbe TH	292	phys_addr_t memblock_alloc_nid(phys_addr_t size, phys_addr_t align, int nid);
581adcbe TH	293	phys_addr_t memblock_alloc_try_nid(phys_addr_t size, phys_addr_t align, int nid);
9d1e2492	294
581adcbe	295	phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align);
e63075a3	296
79442ed1 TC	297	/*
	298	* Set the allocation direction to bottom-up or top-down.
	299	*/
2cfb3665	300	static inline void __init memblock_set_bottom_up(bool enable)
79442ed1 TC	301	{
	302	memblock.bottom_up = enable;
	303	}
	304
	305	/*
	306	* Check if the allocation direction is bottom-up or not.
	307	* if this is true, that said, memblock will allocate memory
	308	* in bottom-up direction.
	309	*/
	310	static inline bool memblock_bottom_up(void)
	311	{
	312	return memblock.bottom_up;
	313	}
79442ed1	314
e63075a3	315	/* Flags for memblock_alloc_base() amd __memblock_alloc_base() */
2898cc4c	316	#define MEMBLOCK_ALLOC_ANYWHERE (~(phys_addr_t)0)
e63075a3 BH	317	#define MEMBLOCK_ALLOC_ACCESSIBLE 0
e63075a3 BH	318
2bfc2862	319	phys_addr_t __init memblock_alloc_range(phys_addr_t size, phys_addr_t align,
fc6daaf9 TL	320	phys_addr_t start, phys_addr_t end,
fc6daaf9 TL	321	ulong flags);
581adcbe TH	322	phys_addr_t memblock_alloc_base(phys_addr_t size, phys_addr_t align,
	323	phys_addr_t max_addr);
	324	phys_addr_t __memblock_alloc_base(phys_addr_t size, phys_addr_t align,
	325	phys_addr_t max_addr);
	326	phys_addr_t memblock_phys_mem_size(void);
8907de5d	327	phys_addr_t memblock_reserved_size(void);
595ad9af	328	phys_addr_t memblock_mem_size(unsigned long limit_pfn);
581adcbe TH	329	phys_addr_t memblock_start_of_DRAM(void);
	330	phys_addr_t memblock_end_of_DRAM(void);
	331	void memblock_enforce_memory_limit(phys_addr_t memory_limit);
c9ca9b4e	332	void memblock_cap_memory_range(phys_addr_t base, phys_addr_t size);
a571d4eb	333	void memblock_mem_limit_remove_map(phys_addr_t limit);
b4ad0c7e	334	bool memblock_is_memory(phys_addr_t addr);
bf3d3cc5	335	int memblock_is_map_memory(phys_addr_t addr);
581adcbe	336	int memblock_is_region_memory(phys_addr_t base, phys_addr_t size);
b4ad0c7e	337	bool memblock_is_reserved(phys_addr_t addr);
c5c5c9d1	338	bool memblock_is_region_reserved(phys_addr_t base, phys_addr_t size);
581adcbe	339
4ff7b82f TH	340	extern void __memblock_dump_all(void);
	341
	342	static inline void memblock_dump_all(void)
	343	{
	344	if (memblock_debug)
	345	__memblock_dump_all();
	346	}
95f72d1e	347
e63075a3 BH	348	/**
	349	* memblock_set_current_limit - Set the current allocation limit to allow
	350	* limiting allocations to what is currently
	351	* accessible during boot
	352	* @limit: New limit value (physical address)
	353	*/
581adcbe	354	void memblock_set_current_limit(phys_addr_t limit);
e63075a3	355
35a1f0bd	356
fec51014 LA	357	phys_addr_t memblock_get_current_limit(void);
fec51014 LA	358
5b385f25 BH	359	/*
	360	* pfn conversion functions
	361	*
	362	* While the memory MEMBLOCKs should always be page aligned, the reserved
	363	* MEMBLOCKs may not be. This accessor attempt to provide a very clear
	364	* idea of what they return for such non aligned MEMBLOCKs.
	365	*/
	366
	367	/**
c7fc2de0	368	* memblock_region_memory_base_pfn - Return the lowest pfn intersecting with the memory region
5b385f25 BH	369	* @reg: memblock_region structure
5b385f25 BH	370	*/
c7fc2de0	371	static inline unsigned long memblock_region_memory_base_pfn(const struct memblock_region *reg)
5b385f25	372	{
c7fc2de0	373	return PFN_UP(reg->base);
5b385f25 BH	374	}
	375
	376	/**
c7fc2de0	377	* memblock_region_memory_end_pfn - Return the end_pfn this region
5b385f25 BH	378	* @reg: memblock_region structure
5b385f25 BH	379	*/
c7fc2de0	380	static inline unsigned long memblock_region_memory_end_pfn(const struct memblock_region *reg)
5b385f25	381	{
c7fc2de0	382	return PFN_DOWN(reg->base + reg->size);
5b385f25 BH	383	}
	384
	385	/**
c7fc2de0	386	* memblock_region_reserved_base_pfn - Return the lowest pfn intersecting with the reserved region
5b385f25 BH	387	* @reg: memblock_region structure
5b385f25 BH	388	*/
c7fc2de0	389	static inline unsigned long memblock_region_reserved_base_pfn(const struct memblock_region *reg)
5b385f25	390	{
c7fc2de0	391	return PFN_DOWN(reg->base);
5b385f25 BH	392	}
	393
	394	/**
c7fc2de0	395	* memblock_region_reserved_end_pfn - Return the end_pfn this region
5b385f25 BH	396	* @reg: memblock_region structure
5b385f25 BH	397	*/
c7fc2de0	398	static inline unsigned long memblock_region_reserved_end_pfn(const struct memblock_region *reg)
5b385f25	399	{
c7fc2de0	400	return PFN_UP(reg->base + reg->size);
5b385f25 BH	401	}
	402
	403	#define for_each_memblock(memblock_type, region) \
ba6c19fd	404	for (region = memblock.memblock_type.regions; \
5b385f25 BH	405	region < (memblock.memblock_type.regions + memblock.memblock_type.cnt); \
	406	region++)
	407
66e8b438 GK	408	#define for_each_memblock_type(i, memblock_type, rgn) \
	409	for (i = 0, rgn = &memblock_type->regions[0]; \
	410	i < memblock_type->cnt; \
	411	i++, rgn = &memblock_type->regions[i])
5b385f25	412
4a20799d	413	#ifdef CONFIG_MEMTEST
7f70baee	414	extern void early_memtest(phys_addr_t start, phys_addr_t end);
4a20799d	415	#else
7f70baee	416	static inline void early_memtest(phys_addr_t start, phys_addr_t end)
4a20799d VM	417	{
	418	}
	419	#endif
	420
864b9a39 MH	421	extern unsigned long memblock_reserved_memory_within(phys_addr_t start_addr,
864b9a39 MH	422	phys_addr_t end_addr);
95dde501 YL	423	#else
	424	static inline phys_addr_t memblock_alloc(phys_addr_t size, phys_addr_t align)
	425	{
1f5026a7	426	return 0;
95dde501 YL	427	}
95dde501 YL	428
864b9a39 MH	429	static inline unsigned long memblock_reserved_memory_within(phys_addr_t start_addr,
	430	phys_addr_t end_addr)
	431	{
	432	return 0;
	433	}
	434
f0b37fad YL	435	#endif /* CONFIG_HAVE_MEMBLOCK */
f0b37fad YL	436
95f72d1e YL	437	#endif /* __KERNEL__ */
	438
	439	#endif /* _LINUX_MEMBLOCK_H */