xref: /linux/arch/x86/kvm/lapic.h (revision c7fdfd2bee1cf1448e5244da1a734e680f634b02)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __KVM_X86_LAPIC_H
3 #define __KVM_X86_LAPIC_H
4 
5 #include <kvm/iodev.h>
6 
7 #include <asm/apic.h>
8 
9 #include <linux/kvm_host.h>
10 
11 #include "hyperv.h"
12 #include "smm.h"
13 
14 #define KVM_APIC_INIT		0
15 #define KVM_APIC_SIPI		1
16 
17 #define APIC_SHORT_MASK			0xc0000
18 #define APIC_DEST_NOSHORT		0x0
19 #define APIC_DEST_MASK			0x800
20 
21 #define APIC_BUS_CYCLE_NS_DEFAULT	1
22 
23 #define APIC_BROADCAST			0xFF
24 #define X2APIC_BROADCAST		0xFFFFFFFFul
25 
26 #define X2APIC_MSR(r) (APIC_BASE_MSR + ((r) >> 4))
27 
28 enum lapic_mode {
29 	LAPIC_MODE_DISABLED = 0,
30 	LAPIC_MODE_INVALID = X2APIC_ENABLE,
31 	LAPIC_MODE_XAPIC = MSR_IA32_APICBASE_ENABLE,
32 	LAPIC_MODE_X2APIC = MSR_IA32_APICBASE_ENABLE | X2APIC_ENABLE,
33 };
34 
35 enum lapic_lvt_entry {
36 	LVT_TIMER,
37 	LVT_THERMAL_MONITOR,
38 	LVT_PERFORMANCE_COUNTER,
39 	LVT_LINT0,
40 	LVT_LINT1,
41 	LVT_ERROR,
42 	LVT_CMCI,
43 
44 	KVM_APIC_MAX_NR_LVT_ENTRIES,
45 };
46 
47 #define APIC_LVTx(x) ((x) == LVT_CMCI ? APIC_LVTCMCI : APIC_LVTT + 0x10 * (x))
48 
49 struct kvm_timer {
50 	struct hrtimer timer;
51 	s64 period; 				/* unit: ns */
52 	ktime_t target_expiration;
53 	u32 timer_mode;
54 	u32 timer_mode_mask;
55 	u64 tscdeadline;
56 	u64 expired_tscdeadline;
57 	u32 timer_advance_ns;
58 	atomic_t pending;			/* accumulated triggered timers */
59 	bool hv_timer_in_use;
60 };
61 
62 struct kvm_lapic {
63 	unsigned long base_address;
64 	struct kvm_io_device dev;
65 	struct kvm_timer lapic_timer;
66 	u32 divide_count;
67 	struct kvm_vcpu *vcpu;
68 	bool apicv_active;
69 	bool sw_enabled;
70 	bool irr_pending;
71 	bool lvt0_in_nmi_mode;
72 	/* Select registers in the vAPIC cannot be read/written. */
73 	bool guest_apic_protected;
74 	/* Number of bits set in ISR. */
75 	s16 isr_count;
76 	/* The highest vector set in ISR; if -1 - invalid, must scan ISR. */
77 	int highest_isr_cache;
78 	/**
79 	 * APIC register page.  The layout matches the register layout seen by
80 	 * the guest 1:1, because it is accessed by the vmx microcode.
81 	 * Note: Only one register, the TPR, is used by the microcode.
82 	 */
83 	void *regs;
84 	gpa_t vapic_addr;
85 	struct gfn_to_hva_cache vapic_cache;
86 	unsigned long pending_events;
87 	unsigned int sipi_vector;
88 	int nr_lvt_entries;
89 };
90 
91 struct rtc_status;
92 
93 int kvm_create_lapic(struct kvm_vcpu *vcpu);
94 void kvm_free_lapic(struct kvm_vcpu *vcpu);
95 
96 int kvm_apic_has_interrupt(struct kvm_vcpu *vcpu);
97 void kvm_apic_ack_interrupt(struct kvm_vcpu *vcpu, int vector);
98 int kvm_apic_accept_pic_intr(struct kvm_vcpu *vcpu);
99 int kvm_apic_accept_events(struct kvm_vcpu *vcpu);
100 void kvm_lapic_reset(struct kvm_vcpu *vcpu, bool init_event);
101 u64 kvm_lapic_get_cr8(struct kvm_vcpu *vcpu);
102 void kvm_lapic_set_tpr(struct kvm_vcpu *vcpu, unsigned long cr8);
103 void kvm_lapic_update_cr8_intercept(struct kvm_vcpu *vcpu);
104 void kvm_lapic_set_eoi(struct kvm_vcpu *vcpu);
105 void kvm_apic_set_version(struct kvm_vcpu *vcpu);
106 void kvm_apic_after_set_mcg_cap(struct kvm_vcpu *vcpu);
107 bool kvm_apic_match_dest(struct kvm_vcpu *vcpu, struct kvm_lapic *source,
108 			   int shorthand, unsigned int dest, int dest_mode);
109 void kvm_apic_clear_irr(struct kvm_vcpu *vcpu, int vec);
110 bool __kvm_apic_update_irr(unsigned long *pir, void *regs, int *max_irr);
111 bool kvm_apic_update_irr(struct kvm_vcpu *vcpu, unsigned long *pir, int *max_irr);
112 void kvm_apic_update_ppr(struct kvm_vcpu *vcpu);
113 int kvm_apic_set_irq(struct kvm_vcpu *vcpu, struct kvm_lapic_irq *irq,
114 		     struct rtc_status *rtc_status);
115 int kvm_apic_local_deliver(struct kvm_lapic *apic, int lvt_type);
116 void kvm_apic_update_apicv(struct kvm_vcpu *vcpu);
117 int kvm_alloc_apic_access_page(struct kvm *kvm);
118 void kvm_inhibit_apic_access_page(struct kvm_vcpu *vcpu);
119 
120 bool kvm_irq_delivery_to_apic_fast(struct kvm *kvm, struct kvm_lapic *src,
121 				   struct kvm_lapic_irq *irq, int *r);
122 int __kvm_irq_delivery_to_apic(struct kvm *kvm, struct kvm_lapic *src,
123 			       struct kvm_lapic_irq *irq,
124 			       struct rtc_status *rtc_status);
125 
126 static inline int kvm_irq_delivery_to_apic(struct kvm *kvm,
127 					   struct kvm_lapic *src,
128 					   struct kvm_lapic_irq *irq)
129 {
130 	return __kvm_irq_delivery_to_apic(kvm, src, irq, NULL);
131 }
132 
133 void kvm_apic_send_ipi(struct kvm_lapic *apic, u32 icr_low, u32 icr_high);
134 
135 int kvm_apic_set_base(struct kvm_vcpu *vcpu, u64 value, bool host_initiated);
136 int kvm_apic_get_state(struct kvm_vcpu *vcpu, struct kvm_lapic_state *s);
137 int kvm_apic_set_state(struct kvm_vcpu *vcpu, struct kvm_lapic_state *s);
138 int kvm_lapic_find_highest_irr(struct kvm_vcpu *vcpu);
139 
140 u64 kvm_get_lapic_tscdeadline_msr(struct kvm_vcpu *vcpu);
141 void kvm_set_lapic_tscdeadline_msr(struct kvm_vcpu *vcpu, u64 data);
142 
143 void kvm_apic_write_nodecode(struct kvm_vcpu *vcpu, u32 offset);
144 void kvm_apic_set_eoi_accelerated(struct kvm_vcpu *vcpu, int vector);
145 
146 int kvm_lapic_set_vapic_addr(struct kvm_vcpu *vcpu, gpa_t vapic_addr);
147 void kvm_lapic_sync_from_vapic(struct kvm_vcpu *vcpu);
148 void kvm_lapic_sync_to_vapic(struct kvm_vcpu *vcpu);
149 
150 int kvm_x2apic_icr_write_fast(struct kvm_lapic *apic, u64 data);
151 int kvm_x2apic_msr_write(struct kvm_vcpu *vcpu, u32 msr, u64 data);
152 int kvm_x2apic_msr_read(struct kvm_vcpu *vcpu, u32 msr, u64 *data);
153 
154 int kvm_hv_vapic_msr_write(struct kvm_vcpu *vcpu, u32 msr, u64 data);
155 int kvm_hv_vapic_msr_read(struct kvm_vcpu *vcpu, u32 msr, u64 *data);
156 
157 int kvm_lapic_set_pv_eoi(struct kvm_vcpu *vcpu, u64 data, unsigned long len);
158 void kvm_lapic_exit(void);
159 
160 u64 kvm_x2apic_disable_read_intercept_reg_mask(struct kvm_vcpu *vcpu);
161 
162 static inline void kvm_lapic_set_irr(int vec, struct kvm_lapic *apic)
163 {
164 	apic_set_vector(vec, apic->regs + APIC_IRR);
165 	/*
166 	 * irr_pending must be true if any interrupt is pending; set it after
167 	 * APIC_IRR to avoid race with apic_clear_irr
168 	 */
169 	apic->irr_pending = true;
170 }
171 
172 static inline u32 kvm_lapic_get_reg(struct kvm_lapic *apic, int reg_off)
173 {
174 	return apic_get_reg(apic->regs, reg_off);
175 }
176 
177 DECLARE_STATIC_KEY_FALSE(kvm_has_noapic_vcpu);
178 
179 static inline bool lapic_in_kernel(struct kvm_vcpu *vcpu)
180 {
181 	if (static_branch_unlikely(&kvm_has_noapic_vcpu))
182 		return vcpu->arch.apic;
183 	return true;
184 }
185 
186 extern struct static_key_false_deferred apic_hw_disabled;
187 
188 static inline bool kvm_apic_hw_enabled(struct kvm_lapic *apic)
189 {
190 	if (static_branch_unlikely(&apic_hw_disabled.key))
191 		return apic->vcpu->arch.apic_base & MSR_IA32_APICBASE_ENABLE;
192 	return true;
193 }
194 
195 extern struct static_key_false_deferred apic_sw_disabled;
196 
197 static inline bool kvm_apic_sw_enabled(struct kvm_lapic *apic)
198 {
199 	if (static_branch_unlikely(&apic_sw_disabled.key))
200 		return apic->sw_enabled;
201 	return true;
202 }
203 
204 static inline bool kvm_apic_present(struct kvm_vcpu *vcpu)
205 {
206 	return lapic_in_kernel(vcpu) && kvm_apic_hw_enabled(vcpu->arch.apic);
207 }
208 
209 static inline int kvm_lapic_enabled(struct kvm_vcpu *vcpu)
210 {
211 	return kvm_apic_present(vcpu) && kvm_apic_sw_enabled(vcpu->arch.apic);
212 }
213 
214 static inline int apic_x2apic_mode(struct kvm_lapic *apic)
215 {
216 	return apic->vcpu->arch.apic_base & X2APIC_ENABLE;
217 }
218 
219 static inline bool kvm_vcpu_apicv_active(struct kvm_vcpu *vcpu)
220 {
221 	return lapic_in_kernel(vcpu) && vcpu->arch.apic->apicv_active;
222 }
223 
224 static inline bool kvm_apic_has_pending_init_or_sipi(struct kvm_vcpu *vcpu)
225 {
226 	return lapic_in_kernel(vcpu) && vcpu->arch.apic->pending_events;
227 }
228 
229 static inline bool kvm_apic_init_sipi_allowed(struct kvm_vcpu *vcpu)
230 {
231 	return !is_smm(vcpu) &&
232 	       !kvm_x86_call(apic_init_signal_blocked)(vcpu);
233 }
234 
235 static inline int kvm_lapic_latched_init(struct kvm_vcpu *vcpu)
236 {
237 	return lapic_in_kernel(vcpu) && test_bit(KVM_APIC_INIT, &vcpu->arch.apic->pending_events);
238 }
239 
240 bool kvm_apic_pending_eoi(struct kvm_vcpu *vcpu, int vector);
241 
242 bool kvm_lapic_suppress_eoi_broadcast(struct kvm_lapic *apic);
243 
244 void kvm_wait_lapic_expire(struct kvm_vcpu *vcpu);
245 
246 void kvm_bitmap_or_dest_vcpus(struct kvm *kvm, struct kvm_lapic_irq *irq,
247 			      unsigned long *vcpu_bitmap);
248 
249 bool kvm_intr_is_single_vcpu(struct kvm *kvm, struct kvm_lapic_irq *irq,
250 			     struct kvm_vcpu **dest_vcpu);
251 void kvm_lapic_switch_to_sw_timer(struct kvm_vcpu *vcpu);
252 void kvm_lapic_switch_to_hv_timer(struct kvm_vcpu *vcpu);
253 void kvm_lapic_expired_hv_timer(struct kvm_vcpu *vcpu);
254 bool kvm_lapic_hv_timer_in_use(struct kvm_vcpu *vcpu);
255 void kvm_lapic_restart_hv_timer(struct kvm_vcpu *vcpu);
256 
257 static inline enum lapic_mode kvm_apic_mode(u64 apic_base)
258 {
259 	return apic_base & (MSR_IA32_APICBASE_ENABLE | X2APIC_ENABLE);
260 }
261 
262 static inline enum lapic_mode kvm_get_apic_mode(struct kvm_vcpu *vcpu)
263 {
264 	return kvm_apic_mode(vcpu->arch.apic_base);
265 }
266 
267 static inline u8 kvm_xapic_id(struct kvm_lapic *apic)
268 {
269 	return kvm_lapic_get_reg(apic, APIC_ID) >> 24;
270 }
271 
272 #endif
273