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

#ifndef _ASM_X86_INTEL_RDT_H
#define _ASM_X86_INTEL_RDT_H

#ifdef CONFIG_INTEL_RDT_A

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

#include <asm/intel_rdt_common.h>

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

#define L3_QOS_CDP_ENABLE	0x01ULL

/**
 * 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
 */
struct rdtgroup {
	struct kernfs_node	*kn;
	struct list_head	rdtgroup_list;
	int			closid;
	struct cpumask		cpu_mask;
	int			flags;
	atomic_t		waitcount;
};

/* rdtgroup.flags */
#define	RDT_DELETED		1

/* 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
 * @seq_show:	Show content of the file
 * @write:	Write to the file
 */
struct rftype {
	char			*name;
	umode_t			mode;
	struct kernfs_ops	*kf_ops;

	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 rdt_resource - attributes of an RDT resource
 * @enabled:			Is this feature enabled on this machine
 * @capable:			Is this feature available on this machine
 * @name:			Name to use in "schemata" file
 * @num_closid:			Number of CLOSIDs available
 * @max_cbm:			Largest Cache Bit Mask allowed
 * @data_width:			Character width of data when displaying
 * @min_cbm_bits:		Minimum number of consecutive bits to be set
 *				in a cache bit mask
 * @domains:			All domains for this resource
 * @msr_base:			Base MSR address for CBMs
 * @cache_level:		Which cache level defines scope of this domain
 * @cbm_idx_multi:		Multiplier of CBM index
 * @cbm_idx_offset:		Offset of CBM index. CBM index is computed by:
 *				closid * cbm_idx_multi + cbm_idx_offset
 */
struct rdt_resource {
	bool			enabled;
	bool			capable;
	char			*name;
	int			num_closid;
	int			cbm_len;
	int			min_cbm_bits;
	u32			max_cbm;
	int			data_width;
	struct list_head	domains;
	int			msr_base;
	int			cache_level;
	int			cbm_idx_multi;
	int			cbm_idx_offset;
};

/**
 * 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
 * @cbm:	array of cache bit masks (indexed by CLOSID)
 * @new_cbm:	new cbm value to be loaded
 * @have_new_cbm: did user provide new_cbm for this domain
 */
struct rdt_domain {
	struct list_head	list;
	int			id;
	struct cpumask		cpu_mask;
	u32			*cbm;
	u32			new_cbm;
	bool			have_new_cbm;
};

/**
 * 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;
};

extern struct mutex rdtgroup_mutex;

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

int __init rdtgroup_init(void);

enum {
	RDT_RESOURCE_L3,
	RDT_RESOURCE_L3DATA,
	RDT_RESOURCE_L3CODE,
	RDT_RESOURCE_L2,

	/* 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->capable)

#define for_each_enabled_rdt_resource(r)				      \
	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	     r++)							      \
		if (r->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=1).EDX */
union cpuid_0x10_1_edx {
	struct {
		unsigned int cos_max:16;
	} split;
	unsigned int full;
};

DECLARE_PER_CPU_READ_MOSTLY(int, cpu_closid);

void rdt_cbm_update(void *arg);
struct rdtgroup *rdtgroup_kn_lock_live(struct kernfs_node *kn);
void rdtgroup_kn_unlock(struct kernfs_node *kn);
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);

/*
 * intel_rdt_sched_in() - Writes the task's CLOSid to IA32_PQR_MSR
 *
 * Following considerations are made so that this has minimal impact
 * on scheduler hot path:
 * - This will stay as no-op unless we are running on an Intel SKU
 *   which supports resource control and we enable by mounting the
 *   resctrl file system.
 * - Caches the per cpu CLOSid values and does the MSR write only
 *   when a task with a different CLOSid is scheduled in.
 *
 * Must be called with preemption disabled.
 */
static inline void intel_rdt_sched_in(void)
{
	if (static_branch_likely(&rdt_enable_key)) {
		struct intel_pqr_state *state = this_cpu_ptr(&pqr_state);
		int closid;

		/*
		 * If this task has a closid assigned, use it.
		 * Else use the closid assigned to this cpu.
		 */
		closid = current->closid;
		if (closid == 0)
			closid = this_cpu_read(cpu_closid);

		if (closid != state->closid) {
			state->closid = closid;
			wrmsr(MSR_IA32_PQR_ASSOC, state->rmid, closid);
		}
	}
}

#else

static inline void intel_rdt_sched_in(void) {}

#endif /* CONFIG_INTEL_RDT_A */
#endif /* _ASM_X86_INTEL_RDT_H */
Commit	Line	Data
113c6097 FY	1	#ifndef _ASM_X86_INTEL_RDT_H
	2	#define _ASM_X86_INTEL_RDT_H
	3
4f341a5e FY	4	#ifdef CONFIG_INTEL_RDT_A
4f341a5e FY	5
5b825c3a	6	#include <linux/sched.h>
8ff42c02	7	#include <linux/kernfs.h>
5ff193fb FY	8	#include <linux/jump_label.h>
5ff193fb FY	9
4f341a5e FY	10	#include <asm/intel_rdt_common.h>
4f341a5e FY	11
5ff193fb	12	#define IA32_L3_QOS_CFG 0xc81
113c6097	13	#define IA32_L3_CBM_BASE 0xc90
c1c7c3f9	14	#define IA32_L2_CBM_BASE 0xd10
113c6097	15
5ff193fb FY	16	#define L3_QOS_CDP_ENABLE 0x01ULL
	17
	18	/**
	19	* struct rdtgroup - store rdtgroup's data in resctrl file system.
	20	* @kn: kernfs node
	21	* @rdtgroup_list: linked list for all rdtgroups
	22	* @closid: closid for this rdtgroup
12e0110c	23	* @cpu_mask: CPUs assigned to this rdtgroup
60cf5e10 FY	24	* @flags: status bits
60cf5e10 FY	25	* @waitcount: how many cpus expect to find this
12e0110c	26	* group when they acquire rdtgroup_mutex
5ff193fb FY	27	*/
	28	struct rdtgroup {
	29	struct kernfs_node *kn;
	30	struct list_head rdtgroup_list;
	31	int closid;
12e0110c	32	struct cpumask cpu_mask;
60cf5e10 FY	33	int flags;
60cf5e10 FY	34	atomic_t waitcount;
5ff193fb FY	35	};
5ff193fb FY	36
60cf5e10 FY	37	/* rdtgroup.flags */
	38	#define RDT_DELETED 1
	39
5ff193fb FY	40	/* List of all resource groups */
	41	extern struct list_head rdt_all_groups;
	42
de016df8 VS	43	extern int max_name_width, max_data_width;
de016df8 VS	44
5ff193fb FY	45	int __init rdtgroup_init(void);
5ff193fb FY	46
4e978d06 FY	47	/**
4e978d06 FY	48	* struct rftype - describe each file in the resctrl file system
17f8ba1d TG	49	* @name: File name
	50	* @mode: Access mode
	51	* @kf_ops: File operations
	52	* @seq_show: Show content of the file
	53	* @write: Write to the file
4e978d06 FY	54	*/
	55	struct rftype {
	56	char *name;
	57	umode_t mode;
	58	struct kernfs_ops *kf_ops;
	59
	60	int (seq_show)(struct kernfs_open_file of,
	61	struct seq_file sf, void v);
	62	/*
	63	* write() is the generic write callback which maps directly to
	64	* kernfs write operation and overrides all other operations.
	65	* Maximum write size is determined by ->max_write_len.
	66	*/
	67	ssize_t (write)(struct kernfs_open_file of,
	68	char *buf, size_t nbytes, loff_t off);
	69	};
	70
c1c7c3f9 FY	71	/**
	72	* struct rdt_resource - attributes of an RDT resource
	73	* @enabled: Is this feature enabled on this machine
	74	* @capable: Is this feature available on this machine
	75	* @name: Name to use in "schemata" file
	76	* @num_closid: Number of CLOSIDs available
	77	* @max_cbm: Largest Cache Bit Mask allowed
17f8ba1d	78	* @data_width: Character width of data when displaying
c1c7c3f9 FY	79	* @min_cbm_bits: Minimum number of consecutive bits to be set
	80	* in a cache bit mask
	81	* @domains: All domains for this resource
c1c7c3f9	82	* @msr_base: Base MSR address for CBMs
c1c7c3f9 FY	83	* @cache_level: Which cache level defines scope of this domain
	84	* @cbm_idx_multi: Multiplier of CBM index
	85	* @cbm_idx_offset: Offset of CBM index. CBM index is computed by:
	86	* closid * cbm_idx_multi + cbm_idx_offset
	87	*/
	88	struct rdt_resource {
	89	bool enabled;
	90	bool capable;
	91	char *name;
	92	int num_closid;
	93	int cbm_len;
	94	int min_cbm_bits;
	95	u32 max_cbm;
de016df8	96	int data_width;
c1c7c3f9	97	struct list_head domains;
c1c7c3f9	98	int msr_base;
c1c7c3f9 FY	99	int cache_level;
	100	int cbm_idx_multi;
	101	int cbm_idx_offset;
	102	};
	103
2264d9c7 TL	104	/**
	105	* struct rdt_domain - group of cpus sharing an RDT resource
	106	* @list: all instances of this resource
	107	* @id: unique id for this instance
	108	* @cpu_mask: which cpus share this resource
	109	* @cbm: array of cache bit masks (indexed by CLOSID)
c4026b7b TL	110	* @new_cbm: new cbm value to be loaded
c4026b7b TL	111	* @have_new_cbm: did user provide new_cbm for this domain
2264d9c7 TL	112	*/
	113	struct rdt_domain {
	114	struct list_head list;
	115	int id;
	116	struct cpumask cpu_mask;
	117	u32 *cbm;
c4026b7b TL	118	u32 new_cbm;
c4026b7b TL	119	bool have_new_cbm;
2264d9c7 TL	120	};
	121
	122	/**
	123	* struct msr_param - set a range of MSRs from a domain
	124	* @res: The resource to use
	125	* @low: Beginning index from base MSR
	126	* @high: End index
	127	*/
	128	struct msr_param {
	129	struct rdt_resource *res;
	130	int low;
	131	int high;
	132	};
	133
	134	extern struct mutex rdtgroup_mutex;
	135
c1c7c3f9	136	extern struct rdt_resource rdt_resources_all[];
5ff193fb FY	137	extern struct rdtgroup rdtgroup_default;
	138	DECLARE_STATIC_KEY_FALSE(rdt_enable_key);
	139
	140	int __init rdtgroup_init(void);
c1c7c3f9 FY	141
	142	enum {
	143	RDT_RESOURCE_L3,
	144	RDT_RESOURCE_L3DATA,
	145	RDT_RESOURCE_L3CODE,
	146	RDT_RESOURCE_L2,
	147
	148	/* Must be the last */
	149	RDT_NUM_RESOURCES,
	150	};
	151
	152	#define for_each_capable_rdt_resource(r) \
	153	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
17f8ba1d	154	r++) \
c1c7c3f9 FY	155	if (r->capable)
c1c7c3f9 FY	156
2264d9c7 TL	157	#define for_each_enabled_rdt_resource(r) \
	158	for (r = rdt_resources_all; r < rdt_resources_all + RDT_NUM_RESOURCES;\
	159	r++) \
	160	if (r->enabled)
	161
c1c7c3f9 FY	162	/* CPUID.(EAX=10H, ECX=ResID=1).EAX */
	163	union cpuid_0x10_1_eax {
	164	struct {
	165	unsigned int cbm_len:5;
	166	} split;
	167	unsigned int full;
	168	};
	169
	170	/* CPUID.(EAX=10H, ECX=ResID=1).EDX */
	171	union cpuid_0x10_1_edx {
	172	struct {
	173	unsigned int cos_max:16;
	174	} split;
	175	unsigned int full;
	176	};
2264d9c7	177
12e0110c TL	178	DECLARE_PER_CPU_READ_MOSTLY(int, cpu_closid);
12e0110c TL	179
2264d9c7	180	void rdt_cbm_update(void *arg);
60cf5e10 FY	181	struct rdtgroup rdtgroup_kn_lock_live(struct kernfs_node kn);
60cf5e10 FY	182	void rdtgroup_kn_unlock(struct kernfs_node *kn);
60ec2440 TL	183	ssize_t rdtgroup_schemata_write(struct kernfs_open_file *of,
	184	char *buf, size_t nbytes, loff_t off);
	185	int rdtgroup_schemata_show(struct kernfs_open_file *of,
	186	struct seq_file s, void v);
4f341a5e FY	187
	188	/*
	189	* intel_rdt_sched_in() - Writes the task's CLOSid to IA32_PQR_MSR
	190	*
	191	* Following considerations are made so that this has minimal impact
	192	* on scheduler hot path:
	193	* - This will stay as no-op unless we are running on an Intel SKU
	194	* which supports resource control and we enable by mounting the
	195	* resctrl file system.
	196	* - Caches the per cpu CLOSid values and does the MSR write only
	197	* when a task with a different CLOSid is scheduled in.
74fcdae1 FY	198	*
74fcdae1 FY	199	* Must be called with preemption disabled.
4f341a5e FY	200	*/
	201	static inline void intel_rdt_sched_in(void)
	202	{
	203	if (static_branch_likely(&rdt_enable_key)) {
	204	struct intel_pqr_state *state = this_cpu_ptr(&pqr_state);
	205	int closid;
	206
	207	/*
	208	* If this task has a closid assigned, use it.
	209	* Else use the closid assigned to this cpu.
	210	*/
	211	closid = current->closid;
	212	if (closid == 0)
	213	closid = this_cpu_read(cpu_closid);
	214
	215	if (closid != state->closid) {
	216	state->closid = closid;
	217	wrmsr(MSR_IA32_PQR_ASSOC, state->rmid, closid);
	218	}
	219	}
	220	}
	221
	222	#else
	223
	224	static inline void intel_rdt_sched_in(void) {}
	225
	226	#endif /* CONFIG_INTEL_RDT_A */
113c6097	227	#endif /* _ASM_X86_INTEL_RDT_H */