xref: /openbmc/linux/arch/x86/kvm/pmu.h (revision 63f21f326fc9e068d04c2c1d0a722e8db65588ba)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __KVM_X86_PMU_H
3 #define __KVM_X86_PMU_H
4 
5 #include <linux/nospec.h>
6 
7 #include <asm/cpu_device_id.h>
8 
9 #define vcpu_to_pmu(vcpu) (&(vcpu)->arch.pmu)
10 #define pmu_to_vcpu(pmu)  (container_of((pmu), struct kvm_vcpu, arch.pmu))
11 #define pmc_to_pmu(pmc)   (&(pmc)->vcpu->arch.pmu)
12 
13 /* retrieve the 4 bits for EN and PMI out of IA32_FIXED_CTR_CTRL */
14 #define fixed_ctrl_field(ctrl_reg, idx) (((ctrl_reg) >> ((idx)*4)) & 0xf)
15 
16 #define VMWARE_BACKDOOR_PMC_HOST_TSC		0x10000
17 #define VMWARE_BACKDOOR_PMC_REAL_TIME		0x10001
18 #define VMWARE_BACKDOOR_PMC_APPARENT_TIME	0x10002
19 
20 static const struct x86_cpu_id vmx_icl_pebs_cpu[] = {
21 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_D, NULL),
22 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_X, NULL),
23 	{}
24 };
25 
26 struct kvm_event_hw_type_mapping {
27 	u8 eventsel;
28 	u8 unit_mask;
29 	unsigned event_type;
30 };
31 
32 struct kvm_pmu_ops {
33 	unsigned int (*pmc_perf_hw_id)(struct kvm_pmc *pmc);
34 	bool (*pmc_is_enabled)(struct kvm_pmc *pmc);
35 	struct kvm_pmc *(*pmc_idx_to_pmc)(struct kvm_pmu *pmu, int pmc_idx);
36 	struct kvm_pmc *(*rdpmc_ecx_to_pmc)(struct kvm_vcpu *vcpu,
37 		unsigned int idx, u64 *mask);
38 	struct kvm_pmc *(*msr_idx_to_pmc)(struct kvm_vcpu *vcpu, u32 msr);
39 	bool (*is_valid_rdpmc_ecx)(struct kvm_vcpu *vcpu, unsigned int idx);
40 	bool (*is_valid_msr)(struct kvm_vcpu *vcpu, u32 msr);
41 	int (*get_msr)(struct kvm_vcpu *vcpu, struct msr_data *msr_info);
42 	int (*set_msr)(struct kvm_vcpu *vcpu, struct msr_data *msr_info);
43 	void (*refresh)(struct kvm_vcpu *vcpu);
44 	void (*init)(struct kvm_vcpu *vcpu);
45 	void (*reset)(struct kvm_vcpu *vcpu);
46 	void (*deliver_pmi)(struct kvm_vcpu *vcpu);
47 	void (*cleanup)(struct kvm_vcpu *vcpu);
48 };
49 
50 void kvm_pmu_ops_update(const struct kvm_pmu_ops *pmu_ops);
51 
52 static inline u64 pmc_bitmask(struct kvm_pmc *pmc)
53 {
54 	struct kvm_pmu *pmu = pmc_to_pmu(pmc);
55 
56 	return pmu->counter_bitmask[pmc->type];
57 }
58 
59 static inline u64 pmc_read_counter(struct kvm_pmc *pmc)
60 {
61 	u64 counter, enabled, running;
62 
63 	counter = pmc->counter;
64 	if (pmc->perf_event && !pmc->is_paused)
65 		counter += perf_event_read_value(pmc->perf_event,
66 						 &enabled, &running);
67 	/* FIXME: Scaling needed? */
68 	return counter & pmc_bitmask(pmc);
69 }
70 
71 static inline void pmc_release_perf_event(struct kvm_pmc *pmc)
72 {
73 	if (pmc->perf_event) {
74 		perf_event_release_kernel(pmc->perf_event);
75 		pmc->perf_event = NULL;
76 		pmc->current_config = 0;
77 		pmc_to_pmu(pmc)->event_count--;
78 	}
79 }
80 
81 static inline void pmc_stop_counter(struct kvm_pmc *pmc)
82 {
83 	if (pmc->perf_event) {
84 		pmc->counter = pmc_read_counter(pmc);
85 		pmc_release_perf_event(pmc);
86 	}
87 }
88 
89 static inline bool pmc_is_gp(struct kvm_pmc *pmc)
90 {
91 	return pmc->type == KVM_PMC_GP;
92 }
93 
94 static inline bool pmc_is_fixed(struct kvm_pmc *pmc)
95 {
96 	return pmc->type == KVM_PMC_FIXED;
97 }
98 
99 static inline bool kvm_valid_perf_global_ctrl(struct kvm_pmu *pmu,
100 						 u64 data)
101 {
102 	return !(pmu->global_ctrl_mask & data);
103 }
104 
105 /* returns general purpose PMC with the specified MSR. Note that it can be
106  * used for both PERFCTRn and EVNTSELn; that is why it accepts base as a
107  * parameter to tell them apart.
108  */
109 static inline struct kvm_pmc *get_gp_pmc(struct kvm_pmu *pmu, u32 msr,
110 					 u32 base)
111 {
112 	if (msr >= base && msr < base + pmu->nr_arch_gp_counters) {
113 		u32 index = array_index_nospec(msr - base,
114 					       pmu->nr_arch_gp_counters);
115 
116 		return &pmu->gp_counters[index];
117 	}
118 
119 	return NULL;
120 }
121 
122 /* returns fixed PMC with the specified MSR */
123 static inline struct kvm_pmc *get_fixed_pmc(struct kvm_pmu *pmu, u32 msr)
124 {
125 	int base = MSR_CORE_PERF_FIXED_CTR0;
126 
127 	if (msr >= base && msr < base + pmu->nr_arch_fixed_counters) {
128 		u32 index = array_index_nospec(msr - base,
129 					       pmu->nr_arch_fixed_counters);
130 
131 		return &pmu->fixed_counters[index];
132 	}
133 
134 	return NULL;
135 }
136 
137 static inline u64 get_sample_period(struct kvm_pmc *pmc, u64 counter_value)
138 {
139 	u64 sample_period = (-counter_value) & pmc_bitmask(pmc);
140 
141 	if (!sample_period)
142 		sample_period = pmc_bitmask(pmc) + 1;
143 	return sample_period;
144 }
145 
146 static inline void pmc_update_sample_period(struct kvm_pmc *pmc)
147 {
148 	if (!pmc->perf_event || pmc->is_paused)
149 		return;
150 
151 	perf_event_period(pmc->perf_event,
152 			  get_sample_period(pmc, pmc->counter));
153 }
154 
155 static inline bool pmc_speculative_in_use(struct kvm_pmc *pmc)
156 {
157 	struct kvm_pmu *pmu = pmc_to_pmu(pmc);
158 
159 	if (pmc_is_fixed(pmc))
160 		return fixed_ctrl_field(pmu->fixed_ctr_ctrl,
161 					pmc->idx - INTEL_PMC_IDX_FIXED) & 0x3;
162 
163 	return pmc->eventsel & ARCH_PERFMON_EVENTSEL_ENABLE;
164 }
165 
166 void reprogram_gp_counter(struct kvm_pmc *pmc, u64 eventsel);
167 void reprogram_fixed_counter(struct kvm_pmc *pmc, u8 ctrl, int fixed_idx);
168 void reprogram_counter(struct kvm_pmu *pmu, int pmc_idx);
169 
170 void kvm_pmu_deliver_pmi(struct kvm_vcpu *vcpu);
171 void kvm_pmu_handle_event(struct kvm_vcpu *vcpu);
172 int kvm_pmu_rdpmc(struct kvm_vcpu *vcpu, unsigned pmc, u64 *data);
173 bool kvm_pmu_is_valid_rdpmc_ecx(struct kvm_vcpu *vcpu, unsigned int idx);
174 bool kvm_pmu_is_valid_msr(struct kvm_vcpu *vcpu, u32 msr);
175 int kvm_pmu_get_msr(struct kvm_vcpu *vcpu, struct msr_data *msr_info);
176 int kvm_pmu_set_msr(struct kvm_vcpu *vcpu, struct msr_data *msr_info);
177 void kvm_pmu_refresh(struct kvm_vcpu *vcpu);
178 void kvm_pmu_reset(struct kvm_vcpu *vcpu);
179 void kvm_pmu_init(struct kvm_vcpu *vcpu);
180 void kvm_pmu_cleanup(struct kvm_vcpu *vcpu);
181 void kvm_pmu_destroy(struct kvm_vcpu *vcpu);
182 int kvm_vm_ioctl_set_pmu_event_filter(struct kvm *kvm, void __user *argp);
183 void kvm_pmu_trigger_event(struct kvm_vcpu *vcpu, u64 perf_hw_id);
184 
185 bool is_vmware_backdoor_pmc(u32 pmc_idx);
186 
187 extern struct kvm_pmu_ops intel_pmu_ops;
188 extern struct kvm_pmu_ops amd_pmu_ops;
189 #endif /* __KVM_X86_PMU_H */
190