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