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