Merge tag 'pull-request-2022-05-18' of https://gitlab.com/thuth/qemu into staging
[qemu.git] / include / sysemu / kvm.h
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 "qemu/queue.h"
18 #include "hw/core/cpu.h"
19 #include "exec/memattrs.h"
20 #include "qemu/accel.h"
21 #include "qom/object.h"
22
23 #ifdef NEED_CPU_H
24 # ifdef CONFIG_KVM
25 # include <linux/kvm.h>
26 # define CONFIG_KVM_IS_POSSIBLE
27 # endif
28 #else
29 # define CONFIG_KVM_IS_POSSIBLE
30 #endif
31
32 #ifdef CONFIG_KVM_IS_POSSIBLE
33
34 extern bool kvm_allowed;
35 extern bool kvm_kernel_irqchip;
36 extern bool kvm_split_irqchip;
37 extern bool kvm_async_interrupts_allowed;
38 extern bool kvm_halt_in_kernel_allowed;
39 extern bool kvm_eventfds_allowed;
40 extern bool kvm_irqfds_allowed;
41 extern bool kvm_resamplefds_allowed;
42 extern bool kvm_msi_via_irqfd_allowed;
43 extern bool kvm_gsi_routing_allowed;
44 extern bool kvm_gsi_direct_mapping;
45 extern bool kvm_readonly_mem_allowed;
46 extern bool kvm_direct_msi_allowed;
47 extern bool kvm_ioeventfd_any_length_allowed;
48 extern bool kvm_msi_use_devid;
49 extern bool kvm_has_guest_debug;
50 extern int kvm_sstep_flags;
51
52 #define kvm_enabled() (kvm_allowed)
53 /**
54 * kvm_irqchip_in_kernel:
55 *
56 * Returns: true if an in-kernel irqchip was created.
57 * What this actually means is architecture and machine model
58 * specific: on PC, for instance, it means that the LAPIC
59 * is in kernel. This function should never be used from generic
60 * target-independent code: use one of the following functions or
61 * some other specific check instead.
62 */
63 #define kvm_irqchip_in_kernel() (kvm_kernel_irqchip)
64
65 /**
66 * kvm_irqchip_is_split:
67 *
68 * Returns: true if the irqchip implementation is split between
69 * user and kernel space. The details are architecture and
70 * machine specific. On PC, it means that the PIC, IOAPIC, and
71 * PIT are in user space while the LAPIC is in the kernel.
72 */
73 #define kvm_irqchip_is_split() (kvm_split_irqchip)
74
75 /**
76 * kvm_async_interrupts_enabled:
77 *
78 * Returns: true if we can deliver interrupts to KVM
79 * asynchronously (ie by ioctl from any thread at any time)
80 * rather than having to do interrupt delivery synchronously
81 * (where the vcpu must be stopped at a suitable point first).
82 */
83 #define kvm_async_interrupts_enabled() (kvm_async_interrupts_allowed)
84
85 /**
86 * kvm_halt_in_kernel
87 *
88 * Returns: true if halted cpus should still get a KVM_RUN ioctl to run
89 * inside of kernel space. This only works if MP state is implemented.
90 */
91 #define kvm_halt_in_kernel() (kvm_halt_in_kernel_allowed)
92
93 /**
94 * kvm_eventfds_enabled:
95 *
96 * Returns: true if we can use eventfds to receive notifications
97 * from a KVM CPU (ie the kernel supports eventds and we are running
98 * with a configuration where it is meaningful to use them).
99 */
100 #define kvm_eventfds_enabled() (kvm_eventfds_allowed)
101
102 /**
103 * kvm_irqfds_enabled:
104 *
105 * Returns: true if we can use irqfds to inject interrupts into
106 * a KVM CPU (ie the kernel supports irqfds and we are running
107 * with a configuration where it is meaningful to use them).
108 */
109 #define kvm_irqfds_enabled() (kvm_irqfds_allowed)
110
111 /**
112 * kvm_resamplefds_enabled:
113 *
114 * Returns: true if we can use resamplefds to inject interrupts into
115 * a KVM CPU (ie the kernel supports resamplefds and we are running
116 * with a configuration where it is meaningful to use them).
117 */
118 #define kvm_resamplefds_enabled() (kvm_resamplefds_allowed)
119
120 /**
121 * kvm_msi_via_irqfd_enabled:
122 *
123 * Returns: true if we can route a PCI MSI (Message Signaled Interrupt)
124 * to a KVM CPU via an irqfd. This requires that the kernel supports
125 * this and that we're running in a configuration that permits it.
126 */
127 #define kvm_msi_via_irqfd_enabled() (kvm_msi_via_irqfd_allowed)
128
129 /**
130 * kvm_gsi_routing_enabled:
131 *
132 * Returns: true if GSI routing is enabled (ie the kernel supports
133 * it and we're running in a configuration that permits it).
134 */
135 #define kvm_gsi_routing_enabled() (kvm_gsi_routing_allowed)
136
137 /**
138 * kvm_gsi_direct_mapping:
139 *
140 * Returns: true if GSI direct mapping is enabled.
141 */
142 #define kvm_gsi_direct_mapping() (kvm_gsi_direct_mapping)
143
144 /**
145 * kvm_readonly_mem_enabled:
146 *
147 * Returns: true if KVM readonly memory is enabled (ie the kernel
148 * supports it and we're running in a configuration that permits it).
149 */
150 #define kvm_readonly_mem_enabled() (kvm_readonly_mem_allowed)
151
152 /**
153 * kvm_direct_msi_enabled:
154 *
155 * Returns: true if KVM allows direct MSI injection.
156 */
157 #define kvm_direct_msi_enabled() (kvm_direct_msi_allowed)
158
159 /**
160 * kvm_ioeventfd_any_length_enabled:
161 * Returns: true if KVM allows any length io eventfd.
162 */
163 #define kvm_ioeventfd_any_length_enabled() (kvm_ioeventfd_any_length_allowed)
164
165 /**
166 * kvm_msi_devid_required:
167 * Returns: true if KVM requires a device id to be provided while
168 * defining an MSI routing entry.
169 */
170 #define kvm_msi_devid_required() (kvm_msi_use_devid)
171
172 /*
173 * Does KVM support guest debugging
174 */
175 #define kvm_supports_guest_debug() (kvm_has_guest_debug)
176
177 /*
178 * kvm_supported_sstep_flags
179 * Returns: SSTEP_* flags that KVM supports for guest debug
180 */
181 #define kvm_get_supported_sstep_flags() (kvm_sstep_flags)
182
183 #else
184
185 #define kvm_enabled() (0)
186 #define kvm_irqchip_in_kernel() (false)
187 #define kvm_irqchip_is_split() (false)
188 #define kvm_async_interrupts_enabled() (false)
189 #define kvm_halt_in_kernel() (false)
190 #define kvm_eventfds_enabled() (false)
191 #define kvm_irqfds_enabled() (false)
192 #define kvm_resamplefds_enabled() (false)
193 #define kvm_msi_via_irqfd_enabled() (false)
194 #define kvm_gsi_routing_allowed() (false)
195 #define kvm_gsi_direct_mapping() (false)
196 #define kvm_readonly_mem_enabled() (false)
197 #define kvm_direct_msi_enabled() (false)
198 #define kvm_ioeventfd_any_length_enabled() (false)
199 #define kvm_msi_devid_required() (false)
200 #define kvm_supports_guest_debug() (false)
201 #define kvm_get_supported_sstep_flags() (0)
202
203 #endif /* CONFIG_KVM_IS_POSSIBLE */
204
205 struct kvm_run;
206 struct kvm_lapic_state;
207 struct kvm_irq_routing_entry;
208
209 typedef struct KVMCapabilityInfo {
210 const char *name;
211 int value;
212 } KVMCapabilityInfo;
213
214 #define KVM_CAP_INFO(CAP) { "KVM_CAP_" stringify(CAP), KVM_CAP_##CAP }
215 #define KVM_CAP_LAST_INFO { NULL, 0 }
216
217 struct KVMState;
218
219 #define TYPE_KVM_ACCEL ACCEL_CLASS_NAME("kvm")
220 typedef struct KVMState KVMState;
221 DECLARE_INSTANCE_CHECKER(KVMState, KVM_STATE,
222 TYPE_KVM_ACCEL)
223
224 extern KVMState *kvm_state;
225 typedef struct Notifier Notifier;
226
227 /* external API */
228
229 bool kvm_has_free_slot(MachineState *ms);
230 bool kvm_has_sync_mmu(void);
231 int kvm_has_vcpu_events(void);
232 int kvm_has_robust_singlestep(void);
233 int kvm_has_debugregs(void);
234 int kvm_max_nested_state_length(void);
235 int kvm_has_pit_state2(void);
236 int kvm_has_many_ioeventfds(void);
237 int kvm_has_gsi_routing(void);
238 int kvm_has_intx_set_mask(void);
239
240 /**
241 * kvm_arm_supports_user_irq
242 *
243 * Not all KVM implementations support notifications for kernel generated
244 * interrupt events to user space. This function indicates whether the current
245 * KVM implementation does support them.
246 *
247 * Returns: true if KVM supports using kernel generated IRQs from user space
248 */
249 bool kvm_arm_supports_user_irq(void);
250
251
252 #ifdef NEED_CPU_H
253 #include "cpu.h"
254
255 void kvm_flush_coalesced_mmio_buffer(void);
256
257 int kvm_insert_breakpoint(CPUState *cpu, target_ulong addr,
258 target_ulong len, int type);
259 int kvm_remove_breakpoint(CPUState *cpu, target_ulong addr,
260 target_ulong len, int type);
261 void kvm_remove_all_breakpoints(CPUState *cpu);
262 int kvm_update_guest_debug(CPUState *cpu, unsigned long reinject_trap);
263
264 int kvm_on_sigbus_vcpu(CPUState *cpu, int code, void *addr);
265 int kvm_on_sigbus(int code, void *addr);
266
267 /* internal API */
268
269 int kvm_ioctl(KVMState *s, int type, ...);
270
271 int kvm_vm_ioctl(KVMState *s, int type, ...);
272
273 int kvm_vcpu_ioctl(CPUState *cpu, int type, ...);
274
275 /**
276 * kvm_device_ioctl - call an ioctl on a kvm device
277 * @fd: The KVM device file descriptor as returned from KVM_CREATE_DEVICE
278 * @type: The device-ctrl ioctl number
279 *
280 * Returns: -errno on error, nonnegative on success
281 */
282 int kvm_device_ioctl(int fd, int type, ...);
283
284 /**
285 * kvm_vm_check_attr - check for existence of a specific vm attribute
286 * @s: The KVMState pointer
287 * @group: the group
288 * @attr: the attribute of that group to query for
289 *
290 * Returns: 1 if the attribute exists
291 * 0 if the attribute either does not exist or if the vm device
292 * interface is unavailable
293 */
294 int kvm_vm_check_attr(KVMState *s, uint32_t group, uint64_t attr);
295
296 /**
297 * kvm_device_check_attr - check for existence of a specific device attribute
298 * @fd: The device file descriptor
299 * @group: the group
300 * @attr: the attribute of that group to query for
301 *
302 * Returns: 1 if the attribute exists
303 * 0 if the attribute either does not exist or if the vm device
304 * interface is unavailable
305 */
306 int kvm_device_check_attr(int fd, uint32_t group, uint64_t attr);
307
308 /**
309 * kvm_device_access - set or get value of a specific device attribute
310 * @fd: The device file descriptor
311 * @group: the group
312 * @attr: the attribute of that group to set or get
313 * @val: pointer to a storage area for the value
314 * @write: true for set and false for get operation
315 * @errp: error object handle
316 *
317 * Returns: 0 on success
318 * < 0 on error
319 * Use kvm_device_check_attr() in order to check for the availability
320 * of optional attributes.
321 */
322 int kvm_device_access(int fd, int group, uint64_t attr,
323 void *val, bool write, Error **errp);
324
325 /**
326 * kvm_create_device - create a KVM device for the device control API
327 * @KVMState: The KVMState pointer
328 * @type: The KVM device type (see Documentation/virtual/kvm/devices in the
329 * kernel source)
330 * @test: If true, only test if device can be created, but don't actually
331 * create the device.
332 *
333 * Returns: -errno on error, nonnegative on success: @test ? 0 : device fd;
334 */
335 int kvm_create_device(KVMState *s, uint64_t type, bool test);
336
337 /**
338 * kvm_device_supported - probe whether KVM supports specific device
339 *
340 * @vmfd: The fd handler for VM
341 * @type: type of device
342 *
343 * @return: true if supported, otherwise false.
344 */
345 bool kvm_device_supported(int vmfd, uint64_t type);
346
347 /* Arch specific hooks */
348
349 extern const KVMCapabilityInfo kvm_arch_required_capabilities[];
350
351 void kvm_arch_pre_run(CPUState *cpu, struct kvm_run *run);
352 MemTxAttrs kvm_arch_post_run(CPUState *cpu, struct kvm_run *run);
353
354 int kvm_arch_handle_exit(CPUState *cpu, struct kvm_run *run);
355
356 int kvm_arch_process_async_events(CPUState *cpu);
357
358 int kvm_arch_get_registers(CPUState *cpu);
359
360 /* state subset only touched by the VCPU itself during runtime */
361 #define KVM_PUT_RUNTIME_STATE 1
362 /* state subset modified during VCPU reset */
363 #define KVM_PUT_RESET_STATE 2
364 /* full state set, modified during initialization or on vmload */
365 #define KVM_PUT_FULL_STATE 3
366
367 int kvm_arch_put_registers(CPUState *cpu, int level);
368
369 int kvm_arch_init(MachineState *ms, KVMState *s);
370
371 int kvm_arch_init_vcpu(CPUState *cpu);
372 int kvm_arch_destroy_vcpu(CPUState *cpu);
373
374 bool kvm_vcpu_id_is_valid(int vcpu_id);
375
376 /* Returns VCPU ID to be used on KVM_CREATE_VCPU ioctl() */
377 unsigned long kvm_arch_vcpu_id(CPUState *cpu);
378
379 #ifdef KVM_HAVE_MCE_INJECTION
380 void kvm_arch_on_sigbus_vcpu(CPUState *cpu, int code, void *addr);
381 #endif
382
383 void kvm_arch_init_irq_routing(KVMState *s);
384
385 int kvm_arch_fixup_msi_route(struct kvm_irq_routing_entry *route,
386 uint64_t address, uint32_t data, PCIDevice *dev);
387
388 /* Notify arch about newly added MSI routes */
389 int kvm_arch_add_msi_route_post(struct kvm_irq_routing_entry *route,
390 int vector, PCIDevice *dev);
391 /* Notify arch about released MSI routes */
392 int kvm_arch_release_virq_post(int virq);
393
394 int kvm_arch_msi_data_to_gsi(uint32_t data);
395
396 int kvm_set_irq(KVMState *s, int irq, int level);
397 int kvm_irqchip_send_msi(KVMState *s, MSIMessage msg);
398
399 void kvm_irqchip_add_irq_route(KVMState *s, int gsi, int irqchip, int pin);
400
401 void kvm_irqchip_add_change_notifier(Notifier *n);
402 void kvm_irqchip_remove_change_notifier(Notifier *n);
403 void kvm_irqchip_change_notify(void);
404
405 void kvm_get_apic_state(DeviceState *d, struct kvm_lapic_state *kapic);
406
407 struct kvm_guest_debug;
408 struct kvm_debug_exit_arch;
409
410 struct kvm_sw_breakpoint {
411 target_ulong pc;
412 target_ulong saved_insn;
413 int use_count;
414 QTAILQ_ENTRY(kvm_sw_breakpoint) entry;
415 };
416
417 struct kvm_sw_breakpoint *kvm_find_sw_breakpoint(CPUState *cpu,
418 target_ulong pc);
419
420 int kvm_sw_breakpoints_active(CPUState *cpu);
421
422 int kvm_arch_insert_sw_breakpoint(CPUState *cpu,
423 struct kvm_sw_breakpoint *bp);
424 int kvm_arch_remove_sw_breakpoint(CPUState *cpu,
425 struct kvm_sw_breakpoint *bp);
426 int kvm_arch_insert_hw_breakpoint(target_ulong addr,
427 target_ulong len, int type);
428 int kvm_arch_remove_hw_breakpoint(target_ulong addr,
429 target_ulong len, int type);
430 void kvm_arch_remove_all_hw_breakpoints(void);
431
432 void kvm_arch_update_guest_debug(CPUState *cpu, struct kvm_guest_debug *dbg);
433
434 bool kvm_arch_stop_on_emulation_error(CPUState *cpu);
435
436 int kvm_check_extension(KVMState *s, unsigned int extension);
437
438 int kvm_vm_check_extension(KVMState *s, unsigned int extension);
439
440 #define kvm_vm_enable_cap(s, capability, cap_flags, ...) \
441 ({ \
442 struct kvm_enable_cap cap = { \
443 .cap = capability, \
444 .flags = cap_flags, \
445 }; \
446 uint64_t args_tmp[] = { __VA_ARGS__ }; \
447 size_t n = MIN(ARRAY_SIZE(args_tmp), ARRAY_SIZE(cap.args)); \
448 memcpy(cap.args, args_tmp, n * sizeof(cap.args[0])); \
449 kvm_vm_ioctl(s, KVM_ENABLE_CAP, &cap); \
450 })
451
452 #define kvm_vcpu_enable_cap(cpu, capability, cap_flags, ...) \
453 ({ \
454 struct kvm_enable_cap cap = { \
455 .cap = capability, \
456 .flags = cap_flags, \
457 }; \
458 uint64_t args_tmp[] = { __VA_ARGS__ }; \
459 size_t n = MIN(ARRAY_SIZE(args_tmp), ARRAY_SIZE(cap.args)); \
460 memcpy(cap.args, args_tmp, n * sizeof(cap.args[0])); \
461 kvm_vcpu_ioctl(cpu, KVM_ENABLE_CAP, &cap); \
462 })
463
464 uint32_t kvm_arch_get_supported_cpuid(KVMState *env, uint32_t function,
465 uint32_t index, int reg);
466 uint64_t kvm_arch_get_supported_msr_feature(KVMState *s, uint32_t index);
467
468
469 void kvm_set_sigmask_len(KVMState *s, unsigned int sigmask_len);
470
471 #if !defined(CONFIG_USER_ONLY)
472 int kvm_physical_memory_addr_from_host(KVMState *s, void *ram_addr,
473 hwaddr *phys_addr);
474 #endif
475
476 #endif /* NEED_CPU_H */
477
478 void kvm_cpu_synchronize_state(CPUState *cpu);
479
480 void kvm_init_cpu_signals(CPUState *cpu);
481
482 /**
483 * kvm_irqchip_add_msi_route - Add MSI route for specific vector
484 * @s: KVM state
485 * @vector: which vector to add. This can be either MSI/MSIX
486 * vector. The function will automatically detect whether
487 * MSI/MSIX is enabled, and fetch corresponding MSI
488 * message.
489 * @dev: Owner PCI device to add the route. If @dev is specified
490 * as @NULL, an empty MSI message will be inited.
491 * @return: virq (>=0) when success, errno (<0) when failed.
492 */
493 int kvm_irqchip_add_msi_route(KVMState *s, int vector, PCIDevice *dev);
494 int kvm_irqchip_update_msi_route(KVMState *s, int virq, MSIMessage msg,
495 PCIDevice *dev);
496 void kvm_irqchip_commit_routes(KVMState *s);
497 void kvm_irqchip_release_virq(KVMState *s, int virq);
498
499 int kvm_irqchip_add_adapter_route(KVMState *s, AdapterInfo *adapter);
500 int kvm_irqchip_add_hv_sint_route(KVMState *s, uint32_t vcpu, uint32_t sint);
501
502 int kvm_irqchip_add_irqfd_notifier_gsi(KVMState *s, EventNotifier *n,
503 EventNotifier *rn, int virq);
504 int kvm_irqchip_remove_irqfd_notifier_gsi(KVMState *s, EventNotifier *n,
505 int virq);
506 int kvm_irqchip_add_irqfd_notifier(KVMState *s, EventNotifier *n,
507 EventNotifier *rn, qemu_irq irq);
508 int kvm_irqchip_remove_irqfd_notifier(KVMState *s, EventNotifier *n,
509 qemu_irq irq);
510 void kvm_irqchip_set_qemuirq_gsi(KVMState *s, qemu_irq irq, int gsi);
511 void kvm_pc_setup_irq_routing(bool pci_enabled);
512 void kvm_init_irq_routing(KVMState *s);
513
514 bool kvm_kernel_irqchip_allowed(void);
515 bool kvm_kernel_irqchip_required(void);
516 bool kvm_kernel_irqchip_split(void);
517
518 /**
519 * kvm_arch_irqchip_create:
520 * @KVMState: The KVMState pointer
521 *
522 * Allow architectures to create an in-kernel irq chip themselves.
523 *
524 * Returns: < 0: error
525 * 0: irq chip was not created
526 * > 0: irq chip was created
527 */
528 int kvm_arch_irqchip_create(KVMState *s);
529
530 /**
531 * kvm_set_one_reg - set a register value in KVM via KVM_SET_ONE_REG ioctl
532 * @id: The register ID
533 * @source: The pointer to the value to be set. It must point to a variable
534 * of the correct type/size for the register being accessed.
535 *
536 * Returns: 0 on success, or a negative errno on failure.
537 */
538 int kvm_set_one_reg(CPUState *cs, uint64_t id, void *source);
539
540 /**
541 * kvm_get_one_reg - get a register value from KVM via KVM_GET_ONE_REG ioctl
542 * @id: The register ID
543 * @target: The pointer where the value is to be stored. It must point to a
544 * variable of the correct type/size for the register being accessed.
545 *
546 * Returns: 0 on success, or a negative errno on failure.
547 */
548 int kvm_get_one_reg(CPUState *cs, uint64_t id, void *target);
549 struct ppc_radix_page_info *kvm_get_radix_page_info(void);
550 int kvm_get_max_memslots(void);
551
552 /* Notify resamplefd for EOI of specific interrupts. */
553 void kvm_resample_fd_notify(int gsi);
554
555 /**
556 * kvm_cpu_check_are_resettable - return whether CPUs can be reset
557 *
558 * Returns: true: CPUs are resettable
559 * false: CPUs are not resettable
560 */
561 bool kvm_cpu_check_are_resettable(void);
562
563 bool kvm_arch_cpu_check_are_resettable(void);
564
565 bool kvm_dirty_ring_enabled(void);
566 #endif