[mirror_ubuntu-focal-kernel.git] / arch / x86 / kernel / cpu / intel_rdt.h

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

#include <linux/sched.h>
#include <linux/kernfs.h>
#include <linux/jump_label.h>

#define IA32_L3_QOS_CFG		0xc81
#define IA32_L3_CBM_BASE	0xc90
#define IA32_L2_CBM_BASE	0xd10
#define IA32_MBA_THRTL_BASE	0xd50

#define L3_QOS_CDP_ENABLE	0x01ULL

/*
 * Event IDs are used to program IA32_QM_EVTSEL before reading event
 * counter from IA32_QM_CTR
 */
#define QOS_L3_OCCUP_EVENT_ID		0x01
#define QOS_L3_MBM_TOTAL_EVENT_ID	0x02
#define QOS_L3_MBM_LOCAL_EVENT_ID	0x03

#define CQM_LIMBOCHECK_INTERVAL	1000

#define MBM_CNTR_WIDTH			24
#define MBM_OVERFLOW_INTERVAL		1000

#define RMID_VAL_ERROR			BIT_ULL(63)
#define RMID_VAL_UNAVAIL		BIT_ULL(62)

DECLARE_STATIC_KEY_FALSE(rdt_enable_key);

/**
 * struct mon_evt - Entry in the event list of a resource
 * @evtid:		event id
 * @name:		name of the event
 */
struct mon_evt {
	u32			evtid;
	char			*name;
	struct list_head	list;
};

/**
 * struct mon_data_bits - Monitoring details for each event file
 * @rid:               Resource id associated with the event file.
 * @evtid:             Event id associated with the event file
 * @domid:             The domain to which the event file belongs
 */
union mon_data_bits {
	void *priv;
	struct {
		unsigned int rid	: 10;
		unsigned int evtid	: 8;
		unsigned int domid	: 14;
	} u;
};

struct rmid_read {
	struct rdtgroup		*rgrp;
	struct rdt_domain	*d;
	int			evtid;
	bool			first;
	u64			val;
};

extern unsigned int intel_cqm_threshold;
extern bool rdt_alloc_capable;
extern bool rdt_mon_capable;
extern unsigned int rdt_mon_features;

enum rdt_group_type {
	RDTCTRL_GROUP = 0,
	RDTMON_GROUP,
	RDT_NUM_GROUP,
};

/**
 * struct mongroup - store mon group's data in resctrl fs.
 * @mon_data_kn		kernlfs node for the mon_data directory
 * @parent:			parent rdtgrp
 * @crdtgrp_list:		child rdtgroup node list
 * @rmid:			rmid for this rdtgroup
 */
struct mongroup {
	struct kernfs_node	*mon_data_kn;
	struct rdtgroup		*parent;
	struct list_head	crdtgrp_list;
	u32			rmid;
};

/**
 * struct rdtgroup - store rdtgroup's data in resctrl file system.
 * @kn:				kernfs node
 * @rdtgroup_list:		linked list for all rdtgroups
 * @closid:			closid for this rdtgroup
 * @cpu_mask:			CPUs assigned to this rdtgroup
 * @flags:			status bits
 * @waitcount:			how many cpus expect to find this
 *				group when they acquire rdtgroup_mutex
 * @type:			indicates type of this rdtgroup - either
 *				monitor only or ctrl_mon group
 * @mon:			mongroup related data
 */
struct rdtgroup {
	struct kernfs_node	*kn;
	struct list_head	rdtgroup_list;
	u32			closid;
	struct cpumask		cpu_mask;
	int			flags;
	atomic_t		waitcount;
	enum rdt_group_type	type;
	struct mongroup		mon;
};

/* rdtgroup.flags */
#define	RDT_DELETED		1

/* rftype.flags */
#define RFTYPE_FLAGS_CPUS_LIST	1

/*
 * Define the file type flags for base and info directories.
 */
#define RFTYPE_INFO			BIT(0)
#define RFTYPE_BASE			BIT(1)
#define RF_CTRLSHIFT			4
#define RF_MONSHIFT			5
#define RFTYPE_CTRL			BIT(RF_CTRLSHIFT)
#define RFTYPE_MON			BIT(RF_MONSHIFT)
#define RFTYPE_RES_CACHE		BIT(8)
#define RFTYPE_RES_MB			BIT(9)
#define RF_CTRL_INFO			(RFTYPE_INFO | RFTYPE_CTRL)
#define RF_MON_INFO			(RFTYPE_INFO | RFTYPE_MON)
#define RF_CTRL_BASE			(RFTYPE_BASE | RFTYPE_CTRL)

/* List of all resource groups */
extern struct list_head rdt_all_groups;

extern int max_name_width, max_data_width;

int __init rdtgroup_init(void);

/**
 * struct rftype - describe each file in the resctrl file system
 * @name:	File name
 * @mode:	Access mode
 * @kf_ops:	File operations
 * @flags:	File specific RFTYPE_FLAGS_* flags
 * @fflags:	File specific RF_* or RFTYPE_* flags
 * @seq_show:	Show content of the file
 * @write:	Write to the file
 */
struct rftype {
	char			*name;
	umode_t			mode;
	struct kernfs_ops	*kf_ops;
	unsigned long		flags;
	unsigned long		fflags;

	int (*seq_show)(struct kernfs_open_file *of,
			struct seq_file *sf, void *v);
	/*
	 * write() is the generic write callback which maps directly to
	 * kernfs write operation and overrides all other operations.
	 * Maximum write size is determined by ->max_write_len.
	 */
	ssize_t (*write)(struct kernfs_open_file *of,
			 char *buf, size_t nbytes, loff_t off);
};

/**
 * struct mbm_state - status for each MBM counter in each domain
 * @chunks:	Total data moved (multiply by rdt_group.mon_scale to get bytes)
 * @prev_msr	Value of IA32_QM_CTR for this RMID last time we read it
 */
struct mbm_state {
	u64	chunks;
	u64	prev_msr;
};

/**
 * struct rdt_domain - group of cpus sharing an RDT resource
 * @list:	all instances of this resource
 * @id:		unique id for this instance
 * @cpu_mask:	which cpus share this resource
 * @rmid_busy_llc:
 *		bitmap of which limbo RMIDs are above threshold
 * @mbm_total:	saved state for MBM total bandwidth
 * @mbm_local:	saved state for MBM local bandwidth
 * @mbm_over:	worker to periodically read MBM h/w counters
 * @cqm_limbo:	worker to periodically read CQM h/w counters
 * @mbm_work_cpu:
 *		worker cpu for MBM h/w counters
 * @cqm_work_cpu:
 *		worker cpu for CQM h/w counters
 * @ctrl_val:	array of cache or mem ctrl values (indexed by CLOSID)
 * @new_ctrl:	new ctrl value to be loaded
 * @have_new_ctrl: did user provide new_ctrl for this domain
 */
struct rdt_domain {
	struct list_head	list;
	int			id;
	struct cpumask		cpu_mask;
	unsigned long		*rmid_busy_llc;
	struct mbm_state	*mbm_total;
	struct mbm_state	*mbm_local;
	struct delayed_work	mbm_over;
	struct delayed_work	cqm_limbo;
	int			mbm_work_cpu;
	int			cqm_work_cpu;
	u32			*ctrl_val;
	u32			new_ctrl;
	bool			have_new_ctrl;
};

/**
 * struct msr_param - set a range of MSRs from a domain
 * @res:       The resource to use
 * @low:       Beginning index from base MSR
 * @high:      End index
 */
struct msr_param {
	struct rdt_resource	*res;
	int			low;
	int			high;
};

/**
 * struct rdt_cache - Cache allocation related data
 * @cbm_len:		Length of the cache bit mask
 * @min_cbm_bits:	Minimum number of consecutive bits to be set
 * @cbm_idx_mult:	Multiplier of CBM index
 * @cbm_idx_offset:	Offset of CBM index. CBM index is computed by:
 *			closid * cbm_idx_multi + cbm_idx_offset
 *			in a cache bit mask
 * @shareable_bits:	Bitmask of shareable resource with other
 *			executing entities
 */
struct rdt_cache {
	unsigned int	cbm_len;
	unsigned int	min_cbm_bits;
	unsigned int	cbm_idx_mult;
	unsigned int	cbm_idx_offset;
	unsigned int	shareable_bits;
};

/**
 * struct rdt_membw - Memory bandwidth allocation related data
 * @max_delay:		Max throttle delay. Delay is the hardware
 *			representation for memory bandwidth.
 * @min_bw:		Minimum memory bandwidth percentage user can request
 * @bw_gran:		Granularity at which the memory bandwidth is allocated
 * @delay_linear:	True if memory B/W delay is in linear scale
 * @mb_map:		Mapping of memory B/W percentage to memory B/W delay
 */
struct rdt_membw {
	u32		max_delay;
	u32		min_bw;
	u32		bw_gran;
	u32		delay_linear;
	u32		*mb_map;
};

static inline bool is_llc_occupancy_enabled(void)
{
	return (rdt_mon_features & (1 << QOS_L3_OCCUP_EVENT_ID));
}

static inline bool is_mbm_total_enabled(void)
{
	return (rdt_mon_features & (1 << QOS_L3_MBM_TOTAL_EVENT_ID));
}

static inline bool is_mbm_local_enabled(void)
{
	return (rdt_mon_features & (1 << QOS_L3_MBM_LOCAL_EVENT_ID));
}

static inline bool is_mbm_enabled(void)
{
	return (is_mbm_total_enabled() || is_mbm_local_enabled());
}

static inline bool is_mbm_event(int e)
{
	return (e >= QOS_L3_MBM_TOTAL_EVENT_ID &&
		e <= QOS_L3_MBM_LOCAL_EVENT_ID);
}

/**
 * struct rdt_resource - attributes of an RDT resource
 * @rid:		The index of the resource
 * @alloc_enabled:	Is allocation enabled on this machine
 * @mon_enabled:		Is monitoring enabled for this feature
 * @alloc_capable:	Is allocation available on this machine
 * @mon_capable:		Is monitor feature available on this machine
 * @name:		Name to use in "schemata" file
 * @num_closid:		Number of CLOSIDs available
 * @cache_level:	Which cache level defines scope of this resource
 * @default_ctrl:	Specifies default cache cbm or memory B/W percent.
 * @msr_base:		Base MSR address for CBMs
 * @msr_update:		Function pointer to update QOS MSRs
 * @data_width:		Character width of data when displaying
 * @domains:		All domains for this resource
 * @cache:		Cache allocation related data
 * @format_str:		Per resource format string to show domain value
 * @parse_ctrlval:	Per resource function pointer to parse control values
 * @evt_list:			List of monitoring events
 * @num_rmid:			Number of RMIDs available
 * @mon_scale:			cqm counter * mon_scale = occupancy in bytes
 * @fflags:			flags to choose base and info files
 */
struct rdt_resource {
	int			rid;
	bool			alloc_enabled;
	bool			mon_enabled;
	bool			alloc_capable;
	bool			mon_capable;
	char			*name;
	int			num_closid;
	int			cache_level;
	u32			default_ctrl;
	unsigned int		msr_base;
	void (*msr_update)	(struct rdt_domain *d, struct msr_param *m,
				 struct rdt_resource *r);
	int			data_width;
	struct list_head	domains;
	struct rdt_cache	cache;
	struct rdt_membw	membw;
	const char		*format_str;
	int (*parse_ctrlval)	(char *buf, struct rdt_resource *r,
				 struct rdt_domain *d);
	struct list_head	evt_list;
	int			num_rmid;
	unsigned int		mon_scale;
	unsigned long		fflags;
};

int parse_cbm(char *buf, struct rdt_resource *r, struct rdt_domain *d);
int parse_bw(char *buf, struct rdt_resource *r,  struct rdt_domain *d);

extern struct mutex rdtgroup_mutex;

extern struct rdt_resource rdt_resources_all[];
extern struct rdtgroup rdtgroup_default;
DECLARE_STATIC_KEY_FALSE(rdt_alloc_enable_key);

int __init rdtgroup_init(void);

enum {
	RDT_RESOURCE_L3,
	RDT_RESOURCE_L3DATA,
	RDT_RESOURCE_L3CODE,
	RDT_RESOURCE_L2,
	RDT_RESOURCE_MBA,

	/* Must be the last */
	RDT_NUM_RESOURCES,
};

#define for_each_capable_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->alloc_capable || r->mon_capable)

#define for_each_alloc_capable_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->alloc_capable)

#define for_each_mon_capable_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->mon_capable)

#define for_each_alloc_enabled_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->alloc_enabled)

#define for_each_mon_enabled_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->mon_enabled)

/* CPUID.(EAX=10H, ECX=ResID=1).EAX */
union cpuid_0x10_1_eax {
	struct {
		unsigned int cbm_len:5;
	} split;
	unsigned int full;
};

/* CPUID.(EAX=10H, ECX=ResID=3).EAX */
union cpuid_0x10_3_eax {
	struct {
		unsigned int max_delay:12;
	} split;
	unsigned int full;
};

/* CPUID.(EAX=10H, ECX=ResID).EDX */
union cpuid_0x10_x_edx {
	struct {
		unsigned int cos_max:16;
	} split;
	unsigned int full;
};

void rdt_ctrl_update(void *arg);
struct rdtgroup *rdtgroup_kn_lock_live(struct kernfs_node *kn);
void rdtgroup_kn_unlock(struct kernfs_node *kn);
struct rdt_domain *rdt_find_domain(struct rdt_resource *r, int id,
				   struct list_head **pos);
ssize_t rdtgroup_schemata_write(struct kernfs_open_file *of,
				char *buf, size_t nbytes, loff_t off);
int rdtgroup_schemata_show(struct kernfs_open_file *of,
			   struct seq_file *s, void *v);
struct rdt_domain *get_domain_from_cpu(int cpu, struct rdt_resource *r);
int alloc_rmid(void);
void free_rmid(u32 rmid);
int rdt_get_mon_l3_config(struct rdt_resource *r);
void mon_event_count(void *info);
int rdtgroup_mondata_show(struct seq_file *m, void *arg);
void rmdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
				    unsigned int dom_id);
void mkdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
				    struct rdt_domain *d);
void mon_event_read(struct rmid_read *rr, struct rdt_domain *d,
		    struct rdtgroup *rdtgrp, int evtid, int first);
void mbm_setup_overflow_handler(struct rdt_domain *dom,
				unsigned long delay_ms);
void mbm_handle_overflow(struct work_struct *work);
void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms);
void cqm_handle_limbo(struct work_struct *work);
bool has_busy_rmid(struct rdt_resource *r, struct rdt_domain *d);
void __check_limbo(struct rdt_domain *d, bool force_free);

#endif /* _ASM_X86_INTEL_RDT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
113c6097 FY	2	#ifndef _ASM_X86_INTEL_RDT_H
	3	#define _ASM_X86_INTEL_RDT_H
	4
5b825c3a	5	#include <linux/sched.h>
8ff42c02	6	#include <linux/kernfs.h>
5ff193fb FY	7	#include <linux/jump_label.h>
	8
	9	#define IA32_L3_QOS_CFG 0xc81
113c6097	10	#define IA32_L3_CBM_BASE 0xc90
c1c7c3f9	11	#define IA32_L2_CBM_BASE 0xd10
05b93417	12	#define IA32_MBA_THRTL_BASE 0xd50
113c6097	13
5ff193fb FY	14	#define L3_QOS_CDP_ENABLE 0x01ULL
5ff193fb FY	15
6a445edc VS	16	/*
	17	* Event IDs are used to program IA32_QM_EVTSEL before reading event
	18	* counter from IA32_QM_CTR
	19	*/
	20	#define QOS_L3_OCCUP_EVENT_ID 0x01
	21	#define QOS_L3_MBM_TOTAL_EVENT_ID 0x02
	22	#define QOS_L3_MBM_LOCAL_EVENT_ID 0x03
9f52425b	23
24247aee VS	24	#define CQM_LIMBOCHECK_INTERVAL 1000
24247aee VS	25
9f52425b	26	#define MBM_CNTR_WIDTH 24
e3302683	27	#define MBM_OVERFLOW_INTERVAL 1000
9f52425b	28
edf6fa1c VS	29	#define RMID_VAL_ERROR BIT_ULL(63)
edf6fa1c VS	30	#define RMID_VAL_UNAVAIL BIT_ULL(62)
6a445edc	31
e3302683 VS	32	DECLARE_STATIC_KEY_FALSE(rdt_enable_key);
e3302683 VS	33
6a445edc VS	34	/**
	35	* struct mon_evt - Entry in the event list of a resource
	36	* @evtid: event id
	37	* @name: name of the event
	38	*/
	39	struct mon_evt {
	40	u32 evtid;
	41	char *name;
	42	struct list_head list;
	43	};
	44
d89b7379 VS	45	/**
	46	* struct mon_data_bits - Monitoring details for each event file
	47	* @rid: Resource id associated with the event file.
	48	* @evtid: Event id associated with the event file
	49	* @domid: The domain to which the event file belongs
	50	*/
	51	union mon_data_bits {
	52	void *priv;
	53	struct {
	54	unsigned int rid : 10;
	55	unsigned int evtid : 8;
	56	unsigned int domid : 14;
	57	} u;
	58	};
	59
	60	struct rmid_read {
	61	struct rdtgroup *rgrp;
9f52425b	62	struct rdt_domain *d;
d89b7379	63	int evtid;
a4de1dfd	64	bool first;
d89b7379 VS	65	u64 val;
	66	};
	67
6a445edc VS	68	extern unsigned int intel_cqm_threshold;
	69	extern bool rdt_alloc_capable;
	70	extern bool rdt_mon_capable;
	71	extern unsigned int rdt_mon_features;
c7d9aac6 VS	72
	73	enum rdt_group_type {
	74	RDTCTRL_GROUP = 0,
	75	RDTMON_GROUP,
	76	RDT_NUM_GROUP,
	77	};
	78
	79	/**
	80	* struct mongroup - store mon group's data in resctrl fs.
d89b7379	81	* @mon_data_kn kernlfs node for the mon_data directory
c7d9aac6 VS	82	* @parent: parent rdtgrp
	83	* @crdtgrp_list: child rdtgroup node list
	84	* @rmid: rmid for this rdtgroup
	85	*/
	86	struct mongroup {
d89b7379	87	struct kernfs_node *mon_data_kn;
c7d9aac6 VS	88	struct rdtgroup *parent;
	89	struct list_head crdtgrp_list;
	90	u32 rmid;
	91	};
	92
5ff193fb FY	93	/**
	94	* struct rdtgroup - store rdtgroup's data in resctrl file system.
	95	* @kn: kernfs node
	96	* @rdtgroup_list: linked list for all rdtgroups
	97	* @closid: closid for this rdtgroup
12e0110c	98	* @cpu_mask: CPUs assigned to this rdtgroup
60cf5e10 FY	99	* @flags: status bits
60cf5e10 FY	100	* @waitcount: how many cpus expect to find this
12e0110c	101	* group when they acquire rdtgroup_mutex
c7d9aac6 VS	102	* @type: indicates type of this rdtgroup - either
	103	* monitor only or ctrl_mon group
	104	* @mon: mongroup related data
5ff193fb FY	105	*/
	106	struct rdtgroup {
	107	struct kernfs_node *kn;
	108	struct list_head rdtgroup_list;
0734ded1	109	u32 closid;
12e0110c	110	struct cpumask cpu_mask;
60cf5e10 FY	111	int flags;
60cf5e10 FY	112	atomic_t waitcount;
c7d9aac6 VS	113	enum rdt_group_type type;
c7d9aac6 VS	114	struct mongroup mon;
5ff193fb FY	115	};
5ff193fb FY	116
60cf5e10 FY	117	/* rdtgroup.flags */
	118	#define RDT_DELETED 1
	119
4ffa3c97 JO	120	/* rftype.flags */
	121	#define RFTYPE_FLAGS_CPUS_LIST 1
	122
5dc1d5c6 TL	123	/*
	124	* Define the file type flags for base and info directories.
	125	*/
	126	#define RFTYPE_INFO BIT(0)
	127	#define RFTYPE_BASE BIT(1)
	128	#define RF_CTRLSHIFT 4
d4ab3320	129	#define RF_MONSHIFT 5
5dc1d5c6	130	#define RFTYPE_CTRL BIT(RF_CTRLSHIFT)
d4ab3320	131	#define RFTYPE_MON BIT(RF_MONSHIFT)
5dc1d5c6 TL	132	#define RFTYPE_RES_CACHE BIT(8)
	133	#define RFTYPE_RES_MB BIT(9)
	134	#define RF_CTRL_INFO (RFTYPE_INFO \| RFTYPE_CTRL)
d4ab3320	135	#define RF_MON_INFO (RFTYPE_INFO \| RFTYPE_MON)
5dc1d5c6 TL	136	#define RF_CTRL_BASE (RFTYPE_BASE \| RFTYPE_CTRL)
5dc1d5c6 TL	137
5ff193fb FY	138	/* List of all resource groups */
	139	extern struct list_head rdt_all_groups;
	140
de016df8 VS	141	extern int max_name_width, max_data_width;
de016df8 VS	142
5ff193fb FY	143	int __init rdtgroup_init(void);
5ff193fb FY	144
4e978d06 FY	145	/**
4e978d06 FY	146	* struct rftype - describe each file in the resctrl file system
17f8ba1d TG	147	* @name: File name
	148	* @mode: Access mode
	149	* @kf_ops: File operations
4ffa3c97	150	* @flags: File specific RFTYPE_FLAGS_* flags
5dc1d5c6	151	* @fflags: File specific RF_* or RFTYPE_* flags
17f8ba1d TG	152	* @seq_show: Show content of the file
17f8ba1d TG	153	* @write: Write to the file
4e978d06 FY	154	*/
	155	struct rftype {
	156	char *name;
	157	umode_t mode;
	158	struct kernfs_ops *kf_ops;
4ffa3c97	159	unsigned long flags;
5dc1d5c6	160	unsigned long fflags;
4e978d06 FY	161
	162	int (seq_show)(struct kernfs_open_file of,
	163	struct seq_file sf, void v);
	164	/*
	165	* write() is the generic write callback which maps directly to
	166	* kernfs write operation and overrides all other operations.
	167	* Maximum write size is determined by ->max_write_len.
	168	*/
	169	ssize_t (write)(struct kernfs_open_file of,
	170	char *buf, size_t nbytes, loff_t off);
	171	};
	172
9f52425b TL	173	/**
	174	* struct mbm_state - status for each MBM counter in each domain
	175	* @chunks: Total data moved (multiply by rdt_group.mon_scale to get bytes)
	176	* @prev_msr Value of IA32_QM_CTR for this RMID last time we read it
	177	*/
	178	struct mbm_state {
	179	u64 chunks;
	180	u64 prev_msr;
	181	};
	182
0921c547 TG	183	/**
	184	* struct rdt_domain - group of cpus sharing an RDT resource
	185	* @list: all instances of this resource
	186	* @id: unique id for this instance
	187	* @cpu_mask: which cpus share this resource
edf6fa1c VS	188	* @rmid_busy_llc:
edf6fa1c VS	189	* bitmap of which limbo RMIDs are above threshold
9f52425b TL	190	* @mbm_total: saved state for MBM total bandwidth
9f52425b TL	191	* @mbm_local: saved state for MBM local bandwidth
e3302683	192	* @mbm_over: worker to periodically read MBM h/w counters
24247aee	193	* @cqm_limbo: worker to periodically read CQM h/w counters
e3302683 VS	194	* @mbm_work_cpu:
e3302683 VS	195	* worker cpu for MBM h/w counters
24247aee VS	196	* @cqm_work_cpu:
24247aee VS	197	* worker cpu for CQM h/w counters
0921c547 TG	198	* @ctrl_val: array of cache or mem ctrl values (indexed by CLOSID)
	199	* @new_ctrl: new ctrl value to be loaded
	200	* @have_new_ctrl: did user provide new_ctrl for this domain
	201	*/
	202	struct rdt_domain {
	203	struct list_head list;
	204	int id;
	205	struct cpumask cpu_mask;
edf6fa1c	206	unsigned long *rmid_busy_llc;
9f52425b TL	207	struct mbm_state *mbm_total;
9f52425b TL	208	struct mbm_state *mbm_local;
e3302683	209	struct delayed_work mbm_over;
24247aee	210	struct delayed_work cqm_limbo;
e3302683	211	int mbm_work_cpu;
24247aee	212	int cqm_work_cpu;
0921c547 TG	213	u32 *ctrl_val;
	214	u32 new_ctrl;
	215	bool have_new_ctrl;
	216	};
	217
	218	/**
	219	* struct msr_param - set a range of MSRs from a domain
	220	* @res: The resource to use
	221	* @low: Beginning index from base MSR
	222	* @high: End index
	223	*/
	224	struct msr_param {
	225	struct rdt_resource *res;
	226	int low;
	227	int high;
	228	};
	229
d3e11b4d TG	230	/**
	231	* struct rdt_cache - Cache allocation related data
	232	* @cbm_len: Length of the cache bit mask
	233	* @min_cbm_bits: Minimum number of consecutive bits to be set
	234	* @cbm_idx_mult: Multiplier of CBM index
	235	* @cbm_idx_offset: Offset of CBM index. CBM index is computed by:
	236	* closid * cbm_idx_multi + cbm_idx_offset
	237	* in a cache bit mask
0dd2d749 FY	238	* @shareable_bits: Bitmask of shareable resource with other
0dd2d749 FY	239	* executing entities
d3e11b4d TG	240	*/
	241	struct rdt_cache {
	242	unsigned int cbm_len;
	243	unsigned int min_cbm_bits;
	244	unsigned int cbm_idx_mult;
	245	unsigned int cbm_idx_offset;
0dd2d749	246	unsigned int shareable_bits;
d3e11b4d TG	247	};
d3e11b4d TG	248
05b93417 VS	249	/**
	250	* struct rdt_membw - Memory bandwidth allocation related data
	251	* @max_delay: Max throttle delay. Delay is the hardware
	252	* representation for memory bandwidth.
	253	* @min_bw: Minimum memory bandwidth percentage user can request
	254	* @bw_gran: Granularity at which the memory bandwidth is allocated
	255	* @delay_linear: True if memory B/W delay is in linear scale
	256	* @mb_map: Mapping of memory B/W percentage to memory B/W delay
	257	*/
	258	struct rdt_membw {
	259	u32 max_delay;
	260	u32 min_bw;
	261	u32 bw_gran;
	262	u32 delay_linear;
	263	u32 *mb_map;
	264	};
	265
6a445edc VS	266	static inline bool is_llc_occupancy_enabled(void)
	267	{
	268	return (rdt_mon_features & (1 << QOS_L3_OCCUP_EVENT_ID));
	269	}
	270
9f52425b TL	271	static inline bool is_mbm_total_enabled(void)
	272	{
	273	return (rdt_mon_features & (1 << QOS_L3_MBM_TOTAL_EVENT_ID));
	274	}
	275
	276	static inline bool is_mbm_local_enabled(void)
	277	{
	278	return (rdt_mon_features & (1 << QOS_L3_MBM_LOCAL_EVENT_ID));
	279	}
	280
	281	static inline bool is_mbm_enabled(void)
	282	{
	283	return (is_mbm_total_enabled() \|\| is_mbm_local_enabled());
	284	}
	285
a4de1dfd VS	286	static inline bool is_mbm_event(int e)
	287	{
	288	return (e >= QOS_L3_MBM_TOTAL_EVENT_ID &&
	289	e <= QOS_L3_MBM_LOCAL_EVENT_ID);
	290	}
	291
c1c7c3f9 FY	292	/**
c1c7c3f9 FY	293	* struct rdt_resource - attributes of an RDT resource
d89b7379	294	* @rid: The index of the resource
1b5c0b75	295	* @alloc_enabled: Is allocation enabled on this machine
6a445edc	296	* @mon_enabled: Is monitoring enabled for this feature
1b5c0b75	297	* @alloc_capable: Is allocation available on this machine
6a445edc	298	* @mon_capable: Is monitor feature available on this machine
d3e11b4d TG	299	* @name: Name to use in "schemata" file
	300	* @num_closid: Number of CLOSIDs available
	301	* @cache_level: Which cache level defines scope of this resource
	302	* @default_ctrl: Specifies default cache cbm or memory B/W percent.
	303	* @msr_base: Base MSR address for CBMs
0921c547	304	* @msr_update: Function pointer to update QOS MSRs
d3e11b4d TG	305	* @data_width: Character width of data when displaying
	306	* @domains: All domains for this resource
	307	* @cache: Cache allocation related data
c6ea67de VS	308	* @format_str: Per resource format string to show domain value
c6ea67de VS	309	* @parse_ctrlval: Per resource function pointer to parse control values
6a445edc VS	310	* @evt_list: List of monitoring events
	311	* @num_rmid: Number of RMIDs available
	312	* @mon_scale: cqm counter * mon_scale = occupancy in bytes
5dc1d5c6	313	* @fflags: flags to choose base and info files
c1c7c3f9 FY	314	*/
c1c7c3f9 FY	315	struct rdt_resource {
d89b7379	316	int rid;
1b5c0b75	317	bool alloc_enabled;
6a445edc	318	bool mon_enabled;
1b5c0b75	319	bool alloc_capable;
6a445edc	320	bool mon_capable;
c1c7c3f9 FY	321	char *name;
c1c7c3f9 FY	322	int num_closid;
d3e11b4d	323	int cache_level;
2545e9f5	324	u32 default_ctrl;
d3e11b4d	325	unsigned int msr_base;
0921c547 TG	326	void (msr_update) (struct rdt_domain d, struct msr_param *m,
0921c547 TG	327	struct rdt_resource *r);
de016df8	328	int data_width;
c1c7c3f9	329	struct list_head domains;
a83827d0 TG	330	struct rdt_cache cache;
a83827d0 TG	331	struct rdt_membw membw;
c6ea67de VS	332	const char *format_str;
	333	int (parse_ctrlval) (char buf, struct rdt_resource *r,
	334	struct rdt_domain *d);
6a445edc VS	335	struct list_head evt_list;
	336	int num_rmid;
	337	unsigned int mon_scale;
5dc1d5c6	338	unsigned long fflags;
c1c7c3f9 FY	339	};
c1c7c3f9 FY	340
c6ea67de	341	int parse_cbm(char buf, struct rdt_resource r, struct rdt_domain *d);
64e8ed3d	342	int parse_bw(char buf, struct rdt_resource r, struct rdt_domain *d);
6a507a6a	343
2264d9c7 TL	344	extern struct mutex rdtgroup_mutex;
2264d9c7 TL	345
c1c7c3f9	346	extern struct rdt_resource rdt_resources_all[];
5ff193fb	347	extern struct rdtgroup rdtgroup_default;
1b5c0b75	348	DECLARE_STATIC_KEY_FALSE(rdt_alloc_enable_key);
5ff193fb FY	349
5ff193fb FY	350	int __init rdtgroup_init(void);
c1c7c3f9 FY	351
	352	enum {
	353	RDT_RESOURCE_L3,
	354	RDT_RESOURCE_L3DATA,
	355	RDT_RESOURCE_L3CODE,
	356	RDT_RESOURCE_L2,
05b93417	357	RDT_RESOURCE_MBA,
c1c7c3f9 FY	358
	359	/* Must be the last */
	360	RDT_NUM_RESOURCES,
	361	};
	362
895c663e VS	363	#define for_each_capable_rdt_resource(r) \
	364	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	365	r++) \
	366	if (r->alloc_capable \|\| r->mon_capable)
	367
1b5c0b75	368	#define for_each_alloc_capable_rdt_resource(r) \
c1c7c3f9	369	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
17f8ba1d	370	r++) \
1b5c0b75	371	if (r->alloc_capable)
c1c7c3f9	372
6a445edc VS	373	#define for_each_mon_capable_rdt_resource(r) \
	374	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	375	r++) \
	376	if (r->mon_capable)
	377
1b5c0b75	378	#define for_each_alloc_enabled_rdt_resource(r) \
2264d9c7 TL	379	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
2264d9c7 TL	380	r++) \
1b5c0b75	381	if (r->alloc_enabled)
2264d9c7	382
d4ab3320 VS	383	#define for_each_mon_enabled_rdt_resource(r) \
	384	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	385	r++) \
	386	if (r->mon_enabled)
	387
c1c7c3f9 FY	388	/* CPUID.(EAX=10H, ECX=ResID=1).EAX */
	389	union cpuid_0x10_1_eax {
	390	struct {
	391	unsigned int cbm_len:5;
	392	} split;
	393	unsigned int full;
	394	};
	395
ab66a33b VS	396	/* CPUID.(EAX=10H, ECX=ResID=3).EAX */
	397	union cpuid_0x10_3_eax {
	398	struct {
	399	unsigned int max_delay:12;
	400	} split;
	401	unsigned int full;
	402	};
	403
2545e9f5 VS	404	/* CPUID.(EAX=10H, ECX=ResID).EDX */
2545e9f5 VS	405	union cpuid_0x10_x_edx {
c1c7c3f9 FY	406	struct {
	407	unsigned int cos_max:16;
	408	} split;
	409	unsigned int full;
	410	};
2264d9c7	411
2545e9f5	412	void rdt_ctrl_update(void *arg);
60cf5e10 FY	413	struct rdtgroup rdtgroup_kn_lock_live(struct kernfs_node kn);
60cf5e10 FY	414	void rdtgroup_kn_unlock(struct kernfs_node *kn);
d89b7379 VS	415	struct rdt_domain rdt_find_domain(struct rdt_resource r, int id,
d89b7379 VS	416	struct list_head **pos);
60ec2440 TL	417	ssize_t rdtgroup_schemata_write(struct kernfs_open_file *of,
	418	char *buf, size_t nbytes, loff_t off);
	419	int rdtgroup_schemata_show(struct kernfs_open_file *of,
	420	struct seq_file s, void v);
edf6fa1c	421	struct rdt_domain get_domain_from_cpu(int cpu, struct rdt_resource r);
c7d9aac6 VS	422	int alloc_rmid(void);
c7d9aac6 VS	423	void free_rmid(u32 rmid);
6a445edc	424	int rdt_get_mon_l3_config(struct rdt_resource *r);
d89b7379 VS	425	void mon_event_count(void *info);
d89b7379 VS	426	int rdtgroup_mondata_show(struct seq_file m, void arg);
895c663e VS	427	void rmdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
	428	unsigned int dom_id);
	429	void mkdir_mondata_subdir_allrdtgrp(struct rdt_resource *r,
	430	struct rdt_domain *d);
a4de1dfd VS	431	void mon_event_read(struct rmid_read rr, struct rdt_domain d,
a4de1dfd VS	432	struct rdtgroup *rdtgrp, int evtid, int first);
24247aee VS	433	void mbm_setup_overflow_handler(struct rdt_domain *dom,
24247aee VS	434	unsigned long delay_ms);
e3302683	435	void mbm_handle_overflow(struct work_struct *work);
24247aee VS	436	void cqm_setup_limbo_handler(struct rdt_domain *dom, unsigned long delay_ms);
	437	void cqm_handle_limbo(struct work_struct *work);
	438	bool has_busy_rmid(struct rdt_resource r, struct rdt_domain d);
	439	void __check_limbo(struct rdt_domain *d, bool force_free);
4f341a5e	440
113c6097	441	#endif /* _ASM_X86_INTEL_RDT_H */