[linux-2.6-block.git] / include / linux / memory-tiers.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_MEMORY_TIERS_H
#define _LINUX_MEMORY_TIERS_H

#include <linux/types.h>
#include <linux/nodemask.h>
#include <linux/kref.h>
#include <linux/mmzone.h>
#include <linux/notifier.h>
/*
 * Each tier cover a abstrace distance chunk size of 128
 */
#define MEMTIER_CHUNK_BITS	7
#define MEMTIER_CHUNK_SIZE	(1 << MEMTIER_CHUNK_BITS)
/*
 * Smaller abstract distance values imply faster (higher) memory tiers. Offset
 * the DRAM adistance so that we can accommodate devices with a slightly lower
 * adistance value (slightly faster) than default DRAM adistance to be part of
 * the same memory tier.
 */
#define MEMTIER_ADISTANCE_DRAM	((4 * MEMTIER_CHUNK_SIZE) + (MEMTIER_CHUNK_SIZE >> 1))

struct memory_tier;
struct memory_dev_type {
	/* list of memory types that are part of same tier as this type */
	struct list_head tier_sibling;
	/* list of memory types that are managed by one driver */
	struct list_head list;
	/* abstract distance for this specific memory type */
	int adistance;
	/* Nodes of same abstract distance */
	nodemask_t nodes;
	struct kref kref;
};

struct access_coordinate;

#ifdef CONFIG_NUMA
extern bool numa_demotion_enabled;
extern struct memory_dev_type *default_dram_type;
extern nodemask_t default_dram_nodes;
struct memory_dev_type *alloc_memory_type(int adistance);
void put_memory_type(struct memory_dev_type *memtype);
void init_node_memory_type(int node, struct memory_dev_type *default_type);
void clear_node_memory_type(int node, struct memory_dev_type *memtype);
int register_mt_adistance_algorithm(struct notifier_block *nb);
int unregister_mt_adistance_algorithm(struct notifier_block *nb);
int mt_calc_adistance(int node, int *adist);
int mt_set_default_dram_perf(int nid, struct access_coordinate *perf,
			     const char *source);
int mt_perf_to_adistance(struct access_coordinate *perf, int *adist);
struct memory_dev_type *mt_find_alloc_memory_type(int adist,
						  struct list_head *memory_types);
void mt_put_memory_types(struct list_head *memory_types);
#ifdef CONFIG_MIGRATION
int next_demotion_node(int node);
void node_get_allowed_targets(pg_data_t *pgdat, nodemask_t *targets);
bool node_is_toptier(int node);
#else
static inline int next_demotion_node(int node)
{
	return NUMA_NO_NODE;
}

static inline void node_get_allowed_targets(pg_data_t *pgdat, nodemask_t *targets)
{
	*targets = NODE_MASK_NONE;
}

static inline bool node_is_toptier(int node)
{
	return true;
}
#endif

#else

#define numa_demotion_enabled	false
#define default_dram_type	NULL
#define default_dram_nodes	NODE_MASK_NONE
/*
 * CONFIG_NUMA implementation returns non NULL error.
 */
static inline struct memory_dev_type *alloc_memory_type(int adistance)
{
	return NULL;
}

static inline void put_memory_type(struct memory_dev_type *memtype)
{

}

static inline void init_node_memory_type(int node, struct memory_dev_type *default_type)
{

}

static inline void clear_node_memory_type(int node, struct memory_dev_type *memtype)
{

}

static inline int next_demotion_node(int node)
{
	return NUMA_NO_NODE;
}

static inline void node_get_allowed_targets(pg_data_t *pgdat, nodemask_t *targets)
{
	*targets = NODE_MASK_NONE;
}

static inline bool node_is_toptier(int node)
{
	return true;
}

static inline int register_mt_adistance_algorithm(struct notifier_block *nb)
{
	return 0;
}

static inline int unregister_mt_adistance_algorithm(struct notifier_block *nb)
{
	return 0;
}

static inline int mt_calc_adistance(int node, int *adist)
{
	return NOTIFY_DONE;
}

static inline int mt_set_default_dram_perf(int nid, struct access_coordinate *perf,
					   const char *source)
{
	return -EIO;
}

static inline int mt_perf_to_adistance(struct access_coordinate *perf, int *adist)
{
	return -EIO;
}

static inline struct memory_dev_type *mt_find_alloc_memory_type(int adist,
								struct list_head *memory_types)
{
	return NULL;
}

static inline void mt_put_memory_types(struct list_head *memory_types)
{
}
#endif	/* CONFIG_NUMA */
#endif  /* _LINUX_MEMORY_TIERS_H */
Commit	Line	Data
992bf775 AK	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef _LINUX_MEMORY_TIERS_H
	3	#define _LINUX_MEMORY_TIERS_H
	4
7b88bda3 AK	5	#include <linux/types.h>
	6	#include <linux/nodemask.h>
	7	#include <linux/kref.h>
32008027	8	#include <linux/mmzone.h>
07a8bdd4	9	#include <linux/notifier.h>
992bf775 AK	10	/*
	11	* Each tier cover a abstrace distance chunk size of 128
	12	*/
	13	#define MEMTIER_CHUNK_BITS 7
	14	#define MEMTIER_CHUNK_SIZE (1 << MEMTIER_CHUNK_BITS)
	15	/*
	16	* Smaller abstract distance values imply faster (higher) memory tiers. Offset
	17	* the DRAM adistance so that we can accommodate devices with a slightly lower
	18	* adistance value (slightly faster) than default DRAM adistance to be part of
	19	* the same memory tier.
	20	*/
	21	#define MEMTIER_ADISTANCE_DRAM ((4 * MEMTIER_CHUNK_SIZE) + (MEMTIER_CHUNK_SIZE >> 1))
	22
7b88bda3 AK	23	struct memory_tier;
	24	struct memory_dev_type {
	25	/* list of memory types that are part of same tier as this type */
51a23b1b	26	struct list_head tier_sibling;
6bc2cfdf HY	27	/* list of memory types that are managed by one driver */
6bc2cfdf HY	28	struct list_head list;
7b88bda3 AK	29	/* abstract distance for this specific memory type */
	30	int adistance;
	31	/* Nodes of same abstract distance */
	32	nodemask_t nodes;
	33	struct kref kref;
7b88bda3 AK	34	};
7b88bda3 AK	35
6a954e94	36	struct access_coordinate;
3718c02d	37
91952440	38	#ifdef CONFIG_NUMA
91952440	39	extern bool numa_demotion_enabled;
3718c02d	40	extern struct memory_dev_type *default_dram_type;
823430c8	41	extern nodemask_t default_dram_nodes;
7b88bda3	42	struct memory_dev_type *alloc_memory_type(int adistance);
bded67f8	43	void put_memory_type(struct memory_dev_type *memtype);
7b88bda3 AK	44	void init_node_memory_type(int node, struct memory_dev_type *default_type);
7b88bda3 AK	45	void clear_node_memory_type(int node, struct memory_dev_type *memtype);
07a8bdd4 HY	46	int register_mt_adistance_algorithm(struct notifier_block *nb);
	47	int unregister_mt_adistance_algorithm(struct notifier_block *nb);
	48	int mt_calc_adistance(int node, int *adist);
6a954e94	49	int mt_set_default_dram_perf(int nid, struct access_coordinate *perf,
3718c02d	50	const char *source);
6a954e94	51	int mt_perf_to_adistance(struct access_coordinate perf, int adist);
a72a30af HRJC	52	struct memory_dev_type *mt_find_alloc_memory_type(int adist,
	53	struct list_head *memory_types);
	54	void mt_put_memory_types(struct list_head *memory_types);
6c542ab7 AK	55	#ifdef CONFIG_MIGRATION
6c542ab7 AK	56	int next_demotion_node(int node);
32008027	57	void node_get_allowed_targets(pg_data_t pgdat, nodemask_t targets);
467b171a	58	bool node_is_toptier(int node);
6c542ab7 AK	59	#else
	60	static inline int next_demotion_node(int node)
	61	{
	62	return NUMA_NO_NODE;
	63	}
32008027 JG	64
	65	static inline void node_get_allowed_targets(pg_data_t pgdat, nodemask_t targets)
	66	{
	67	*targets = NODE_MASK_NONE;
	68	}
467b171a AK	69
	70	static inline bool node_is_toptier(int node)
	71	{
	72	return true;
	73	}
6c542ab7	74	#endif
91952440 AK	75
	76	#else
	77
	78	#define numa_demotion_enabled false
3718c02d	79	#define default_dram_type NULL
823430c8	80	#define default_dram_nodes NODE_MASK_NONE
7b88bda3 AK	81	/*
	82	* CONFIG_NUMA implementation returns non NULL error.
	83	*/
	84	static inline struct memory_dev_type *alloc_memory_type(int adistance)
	85	{
	86	return NULL;
	87	}
	88
bded67f8	89	static inline void put_memory_type(struct memory_dev_type *memtype)
7b88bda3 AK	90	{
	91
	92	}
	93
	94	static inline void init_node_memory_type(int node, struct memory_dev_type *default_type)
	95	{
	96
	97	}
	98
	99	static inline void clear_node_memory_type(int node, struct memory_dev_type *memtype)
	100	{
	101
	102	}
6c542ab7 AK	103
	104	static inline int next_demotion_node(int node)
	105	{
	106	return NUMA_NO_NODE;
	107	}
32008027 JG	108
	109	static inline void node_get_allowed_targets(pg_data_t pgdat, nodemask_t targets)
	110	{
	111	*targets = NODE_MASK_NONE;
	112	}
467b171a AK	113
	114	static inline bool node_is_toptier(int node)
	115	{
	116	return true;
	117	}
07a8bdd4 HY	118
	119	static inline int register_mt_adistance_algorithm(struct notifier_block *nb)
	120	{
	121	return 0;
	122	}
	123
	124	static inline int unregister_mt_adistance_algorithm(struct notifier_block *nb)
	125	{
	126	return 0;
	127	}
	128
	129	static inline int mt_calc_adistance(int node, int *adist)
	130	{
	131	return NOTIFY_DONE;
	132	}
3718c02d	133
6a954e94	134	static inline int mt_set_default_dram_perf(int nid, struct access_coordinate *perf,
3718c02d HY	135	const char *source)
	136	{
	137	return -EIO;
	138	}
	139
6a954e94	140	static inline int mt_perf_to_adistance(struct access_coordinate perf, int adist)
3718c02d HY	141	{
	142	return -EIO;
	143	}
a72a30af HRJC	144
	145	static inline struct memory_dev_type *mt_find_alloc_memory_type(int adist,
	146	struct list_head *memory_types)
	147	{
	148	return NULL;
	149	}
	150
	151	static inline void mt_put_memory_types(struct list_head *memory_types)
	152	{
	153	}
91952440	154	#endif /* CONFIG_NUMA */
992bf775	155	#endif /* _LINUX_MEMORY_TIERS_H */