xref: /openbmc/qemu/include/sysemu/kvm.h (revision 56983463)
1 /*
2  * QEMU KVM support
3  *
4  * Copyright IBM, Corp. 2008
5  *
6  * Authors:
7  *  Anthony Liguori   <aliguori@us.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
10  * See the COPYING file in the top-level directory.
11  *
12  */
13 
14 #ifndef QEMU_KVM_H
15 #define QEMU_KVM_H
16 
17 #include <errno.h>
18 #include "config-host.h"
19 #include "qemu/queue.h"
20 #include "qom/cpu.h"
21 
22 #ifdef CONFIG_KVM
23 #include <linux/kvm.h>
24 #include <linux/kvm_para.h>
25 #else
26 /* These constants must never be used at runtime if kvm_enabled() is false.
27  * They exist so we don't need #ifdefs around KVM-specific code that already
28  * checks kvm_enabled() properly.
29  */
30 #define KVM_CPUID_SIGNATURE      0
31 #define KVM_CPUID_FEATURES       0
32 #define KVM_FEATURE_CLOCKSOURCE  0
33 #define KVM_FEATURE_NOP_IO_DELAY 0
34 #define KVM_FEATURE_MMU_OP       0
35 #define KVM_FEATURE_CLOCKSOURCE2 0
36 #define KVM_FEATURE_ASYNC_PF     0
37 #define KVM_FEATURE_STEAL_TIME   0
38 #define KVM_FEATURE_PV_EOI       0
39 #define KVM_FEATURE_CLOCKSOURCE_STABLE_BIT 0
40 #endif
41 
42 extern bool kvm_allowed;
43 extern bool kvm_kernel_irqchip;
44 extern bool kvm_async_interrupts_allowed;
45 extern bool kvm_halt_in_kernel_allowed;
46 extern bool kvm_irqfds_allowed;
47 extern bool kvm_msi_via_irqfd_allowed;
48 extern bool kvm_gsi_routing_allowed;
49 extern bool kvm_readonly_mem_allowed;
50 
51 #if defined CONFIG_KVM || !defined NEED_CPU_H
52 #define kvm_enabled()           (kvm_allowed)
53 /**
54  * kvm_irqchip_in_kernel:
55  *
56  * Returns: true if the user asked us to create an in-kernel
57  * irqchip via the "kernel_irqchip=on" machine option.
58  * What this actually means is architecture and machine model
59  * specific: on PC, for instance, it means that the LAPIC,
60  * IOAPIC and PIT are all in kernel. This function should never
61  * be used from generic target-independent code: use one of the
62  * following functions or some other specific check instead.
63  */
64 #define kvm_irqchip_in_kernel() (kvm_kernel_irqchip)
65 
66 /**
67  * kvm_async_interrupts_enabled:
68  *
69  * Returns: true if we can deliver interrupts to KVM
70  * asynchronously (ie by ioctl from any thread at any time)
71  * rather than having to do interrupt delivery synchronously
72  * (where the vcpu must be stopped at a suitable point first).
73  */
74 #define kvm_async_interrupts_enabled() (kvm_async_interrupts_allowed)
75 
76 /**
77  * kvm_halt_in_kernel
78  *
79  * Returns: true if halted cpus should still get a KVM_RUN ioctl to run
80  * inside of kernel space. This only works if MP state is implemented.
81  */
82 #define kvm_halt_in_kernel() (kvm_halt_in_kernel_allowed)
83 
84 /**
85  * kvm_irqfds_enabled:
86  *
87  * Returns: true if we can use irqfds to inject interrupts into
88  * a KVM CPU (ie the kernel supports irqfds and we are running
89  * with a configuration where it is meaningful to use them).
90  */
91 #define kvm_irqfds_enabled() (kvm_irqfds_allowed)
92 
93 /**
94  * kvm_msi_via_irqfd_enabled:
95  *
96  * Returns: true if we can route a PCI MSI (Message Signaled Interrupt)
97  * to a KVM CPU via an irqfd. This requires that the kernel supports
98  * this and that we're running in a configuration that permits it.
99  */
100 #define kvm_msi_via_irqfd_enabled() (kvm_msi_via_irqfd_allowed)
101 
102 /**
103  * kvm_gsi_routing_enabled:
104  *
105  * Returns: true if GSI routing is enabled (ie the kernel supports
106  * it and we're running in a configuration that permits it).
107  */
108 #define kvm_gsi_routing_enabled() (kvm_gsi_routing_allowed)
109 
110 /**
111  * kvm_readonly_mem_enabled:
112  *
113  * Returns: true if KVM readonly memory is enabled (ie the kernel
114  * supports it and we're running in a configuration that permits it).
115  */
116 #define kvm_readonly_mem_enabled() (kvm_readonly_mem_allowed)
117 
118 #else
119 #define kvm_enabled()           (0)
120 #define kvm_irqchip_in_kernel() (false)
121 #define kvm_async_interrupts_enabled() (false)
122 #define kvm_halt_in_kernel() (false)
123 #define kvm_irqfds_enabled() (false)
124 #define kvm_msi_via_irqfd_enabled() (false)
125 #define kvm_gsi_routing_allowed() (false)
126 #define kvm_readonly_mem_enabled() (false)
127 #endif
128 
129 struct kvm_run;
130 struct kvm_lapic_state;
131 
132 typedef struct KVMCapabilityInfo {
133     const char *name;
134     int value;
135 } KVMCapabilityInfo;
136 
137 #define KVM_CAP_INFO(CAP) { "KVM_CAP_" stringify(CAP), KVM_CAP_##CAP }
138 #define KVM_CAP_LAST_INFO { NULL, 0 }
139 
140 struct KVMState;
141 typedef struct KVMState KVMState;
142 extern KVMState *kvm_state;
143 
144 /* external API */
145 
146 int kvm_init(void);
147 
148 int kvm_has_sync_mmu(void);
149 int kvm_has_vcpu_events(void);
150 int kvm_has_robust_singlestep(void);
151 int kvm_has_debugregs(void);
152 int kvm_has_xsave(void);
153 int kvm_has_xcrs(void);
154 int kvm_has_pit_state2(void);
155 int kvm_has_many_ioeventfds(void);
156 int kvm_has_gsi_routing(void);
157 int kvm_has_intx_set_mask(void);
158 
159 int kvm_init_vcpu(CPUState *cpu);
160 int kvm_cpu_exec(CPUState *cpu);
161 
162 #ifdef NEED_CPU_H
163 
164 #if !defined(CONFIG_USER_ONLY)
165 void *kvm_ram_alloc(ram_addr_t size);
166 void *kvm_arch_ram_alloc(ram_addr_t size);
167 #endif
168 
169 void kvm_setup_guest_memory(void *start, size_t size);
170 void kvm_flush_coalesced_mmio_buffer(void);
171 
172 int kvm_insert_breakpoint(CPUArchState *env, target_ulong addr,
173                           target_ulong len, int type);
174 int kvm_remove_breakpoint(CPUArchState *env, target_ulong addr,
175                           target_ulong len, int type);
176 void kvm_remove_all_breakpoints(CPUState *cpu);
177 int kvm_update_guest_debug(CPUArchState *env, unsigned long reinject_trap);
178 #ifndef _WIN32
179 int kvm_set_signal_mask(CPUState *cpu, const sigset_t *sigset);
180 #endif
181 
182 int kvm_on_sigbus_vcpu(CPUState *cpu, int code, void *addr);
183 int kvm_on_sigbus(int code, void *addr);
184 
185 /* internal API */
186 
187 int kvm_ioctl(KVMState *s, int type, ...);
188 
189 int kvm_vm_ioctl(KVMState *s, int type, ...);
190 
191 int kvm_vcpu_ioctl(CPUState *cpu, int type, ...);
192 
193 /* Arch specific hooks */
194 
195 extern const KVMCapabilityInfo kvm_arch_required_capabilities[];
196 
197 void kvm_arch_pre_run(CPUState *cpu, struct kvm_run *run);
198 void kvm_arch_post_run(CPUState *cpu, struct kvm_run *run);
199 
200 int kvm_arch_handle_exit(CPUState *cpu, struct kvm_run *run);
201 
202 int kvm_arch_process_async_events(CPUState *cpu);
203 
204 int kvm_arch_get_registers(CPUState *cpu);
205 
206 /* state subset only touched by the VCPU itself during runtime */
207 #define KVM_PUT_RUNTIME_STATE   1
208 /* state subset modified during VCPU reset */
209 #define KVM_PUT_RESET_STATE     2
210 /* full state set, modified during initialization or on vmload */
211 #define KVM_PUT_FULL_STATE      3
212 
213 int kvm_arch_put_registers(CPUState *cpu, int level);
214 
215 int kvm_arch_init(KVMState *s);
216 
217 int kvm_arch_init_vcpu(CPUState *cpu);
218 
219 /* Returns VCPU ID to be used on KVM_CREATE_VCPU ioctl() */
220 unsigned long kvm_arch_vcpu_id(CPUState *cpu);
221 
222 void kvm_arch_reset_vcpu(CPUState *cpu);
223 
224 int kvm_arch_on_sigbus_vcpu(CPUState *cpu, int code, void *addr);
225 int kvm_arch_on_sigbus(int code, void *addr);
226 
227 void kvm_arch_init_irq_routing(KVMState *s);
228 
229 int kvm_set_irq(KVMState *s, int irq, int level);
230 int kvm_irqchip_send_msi(KVMState *s, MSIMessage msg);
231 
232 void kvm_irqchip_add_irq_route(KVMState *s, int gsi, int irqchip, int pin);
233 void kvm_irqchip_commit_routes(KVMState *s);
234 
235 void kvm_put_apic_state(DeviceState *d, struct kvm_lapic_state *kapic);
236 void kvm_get_apic_state(DeviceState *d, struct kvm_lapic_state *kapic);
237 
238 struct kvm_guest_debug;
239 struct kvm_debug_exit_arch;
240 
241 struct kvm_sw_breakpoint {
242     target_ulong pc;
243     target_ulong saved_insn;
244     int use_count;
245     QTAILQ_ENTRY(kvm_sw_breakpoint) entry;
246 };
247 
248 QTAILQ_HEAD(kvm_sw_breakpoint_head, kvm_sw_breakpoint);
249 
250 struct kvm_sw_breakpoint *kvm_find_sw_breakpoint(CPUState *cpu,
251                                                  target_ulong pc);
252 
253 int kvm_sw_breakpoints_active(CPUState *cpu);
254 
255 int kvm_arch_insert_sw_breakpoint(CPUState *cpu,
256                                   struct kvm_sw_breakpoint *bp);
257 int kvm_arch_remove_sw_breakpoint(CPUState *cpu,
258                                   struct kvm_sw_breakpoint *bp);
259 int kvm_arch_insert_hw_breakpoint(target_ulong addr,
260                                   target_ulong len, int type);
261 int kvm_arch_remove_hw_breakpoint(target_ulong addr,
262                                   target_ulong len, int type);
263 void kvm_arch_remove_all_hw_breakpoints(void);
264 
265 void kvm_arch_update_guest_debug(CPUState *cpu, struct kvm_guest_debug *dbg);
266 
267 bool kvm_arch_stop_on_emulation_error(CPUState *cpu);
268 
269 int kvm_check_extension(KVMState *s, unsigned int extension);
270 
271 uint32_t kvm_arch_get_supported_cpuid(KVMState *env, uint32_t function,
272                                       uint32_t index, int reg);
273 void kvm_cpu_synchronize_state(CPUState *cpu);
274 
275 /* generic hooks - to be moved/refactored once there are more users */
276 
277 static inline void cpu_synchronize_state(CPUState *cpu)
278 {
279     if (kvm_enabled()) {
280         kvm_cpu_synchronize_state(cpu);
281     }
282 }
283 
284 #if !defined(CONFIG_USER_ONLY)
285 int kvm_physical_memory_addr_from_host(KVMState *s, void *ram_addr,
286                                        hwaddr *phys_addr);
287 #endif
288 
289 #endif /* NEED_CPU_H */
290 
291 void kvm_cpu_synchronize_post_reset(CPUState *cpu);
292 void kvm_cpu_synchronize_post_init(CPUState *cpu);
293 
294 static inline void cpu_synchronize_post_reset(CPUState *cpu)
295 {
296     if (kvm_enabled()) {
297         kvm_cpu_synchronize_post_reset(cpu);
298     }
299 }
300 
301 static inline void cpu_synchronize_post_init(CPUState *cpu)
302 {
303     if (kvm_enabled()) {
304         kvm_cpu_synchronize_post_init(cpu);
305     }
306 }
307 
308 int kvm_irqchip_add_msi_route(KVMState *s, MSIMessage msg);
309 int kvm_irqchip_update_msi_route(KVMState *s, int virq, MSIMessage msg);
310 void kvm_irqchip_release_virq(KVMState *s, int virq);
311 
312 int kvm_irqchip_add_irqfd_notifier(KVMState *s, EventNotifier *n, int virq);
313 int kvm_irqchip_remove_irqfd_notifier(KVMState *s, EventNotifier *n, int virq);
314 void kvm_pc_gsi_handler(void *opaque, int n, int level);
315 void kvm_pc_setup_irq_routing(bool pci_enabled);
316 void kvm_init_irq_routing(KVMState *s);
317 #endif
318