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