5 * Userspace interface for /dev/kvm - kernel based virtual machine
7 * Note: you must update KVM_API_VERSION if you change this interface.
10 #include <linux/types.h>
11 #include <linux/compiler.h>
12 #include <linux/ioctl.h>
15 #define KVM_API_VERSION 12
17 /* for KVM_TRACE_ENABLE, deprecated */
18 struct kvm_user_trace_setup {
19 __u32 buf_size; /* sub_buffer size of each per-cpu */
20 __u32 buf_nr; /* the number of sub_buffers of each per-cpu */
23 /* for KVM_CREATE_MEMORY_REGION */
24 struct kvm_memory_region {
27 __u64 guest_phys_addr;
28 __u64 memory_size; /* bytes */
31 /* for KVM_SET_USER_MEMORY_REGION */
32 struct kvm_userspace_memory_region {
35 __u64 guest_phys_addr;
36 __u64 memory_size; /* bytes */
37 __u64 userspace_addr; /* start of the userspace allocated memory */
40 /* for kvm_memory_region::flags */
41 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
44 /* for KVM_IRQ_LINE */
45 struct kvm_irq_level {
47 * ACPI gsi notion of irq.
48 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
49 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
63 char dummy[512]; /* reserving space */
65 struct kvm_pic_state pic;
67 #ifdef __KVM_HAVE_IOAPIC
68 struct kvm_ioapic_state ioapic;
73 /* for KVM_CREATE_PIT2 */
74 struct kvm_pit_config {
79 #define KVM_PIT_SPEAKER_DUMMY 1
81 #define KVM_EXIT_UNKNOWN 0
82 #define KVM_EXIT_EXCEPTION 1
84 #define KVM_EXIT_HYPERCALL 3
85 #define KVM_EXIT_DEBUG 4
86 #define KVM_EXIT_HLT 5
87 #define KVM_EXIT_MMIO 6
88 #define KVM_EXIT_IRQ_WINDOW_OPEN 7
89 #define KVM_EXIT_SHUTDOWN 8
90 #define KVM_EXIT_FAIL_ENTRY 9
91 #define KVM_EXIT_INTR 10
92 #define KVM_EXIT_SET_TPR 11
93 #define KVM_EXIT_TPR_ACCESS 12
94 #define KVM_EXIT_S390_SIEIC 13
95 #define KVM_EXIT_S390_RESET 14
96 #define KVM_EXIT_DCR 15
97 #define KVM_EXIT_NMI 16
98 #define KVM_EXIT_INTERNAL_ERROR 17
100 /* For KVM_EXIT_INTERNAL_ERROR */
101 #define KVM_INTERNAL_ERROR_EMULATION 1
103 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
106 __u8 request_interrupt_window;
111 __u8 ready_for_interrupt_injection;
115 /* in (pre_kvm_run), out (post_kvm_run) */
120 /* KVM_EXIT_UNKNOWN */
122 __u64 hardware_exit_reason;
124 /* KVM_EXIT_FAIL_ENTRY */
126 __u64 hardware_entry_failure_reason;
128 /* KVM_EXIT_EXCEPTION */
135 #define KVM_EXIT_IO_IN 0
136 #define KVM_EXIT_IO_OUT 1
138 __u8 size; /* bytes */
141 __u64 data_offset; /* relative to kvm_run start */
144 struct kvm_debug_exit_arch arch;
153 /* KVM_EXIT_HYPERCALL */
161 /* KVM_EXIT_TPR_ACCESS */
167 /* KVM_EXIT_S390_SIEIC */
170 __u64 mask; /* psw upper half */
171 __u64 addr; /* psw lower half */
175 /* KVM_EXIT_S390_RESET */
176 #define KVM_S390_RESET_POR 1
177 #define KVM_S390_RESET_CLEAR 2
178 #define KVM_S390_RESET_SUBSYSTEM 4
179 #define KVM_S390_RESET_CPU_INIT 8
180 #define KVM_S390_RESET_IPL 16
181 __u64 s390_reset_flags;
191 /* Fix the size of the union. */
196 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
198 struct kvm_coalesced_mmio_zone {
204 struct kvm_coalesced_mmio {
211 struct kvm_coalesced_mmio_ring {
213 struct kvm_coalesced_mmio coalesced_mmio[0];
216 #define KVM_COALESCED_MMIO_MAX \
217 ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
218 sizeof(struct kvm_coalesced_mmio))
220 /* for KVM_TRANSLATE */
221 struct kvm_translation {
223 __u64 linear_address;
226 __u64 physical_address;
233 /* for KVM_INTERRUPT */
234 struct kvm_interrupt {
239 /* for KVM_GET_DIRTY_LOG */
240 struct kvm_dirty_log {
244 void __user *dirty_bitmap; /* one bit per page */
249 /* for KVM_SET_SIGNAL_MASK */
250 struct kvm_signal_mask {
255 /* for KVM_TPR_ACCESS_REPORTING */
256 struct kvm_tpr_access_ctl {
262 /* for KVM_SET_VAPIC_ADDR */
263 struct kvm_vapic_addr {
267 /* for KVM_SET_MPSTATE */
269 #define KVM_MP_STATE_RUNNABLE 0
270 #define KVM_MP_STATE_UNINITIALIZED 1
271 #define KVM_MP_STATE_INIT_RECEIVED 2
272 #define KVM_MP_STATE_HALTED 3
273 #define KVM_MP_STATE_SIPI_RECEIVED 4
275 struct kvm_mp_state {
279 struct kvm_s390_psw {
284 /* valid values for type in kvm_s390_interrupt */
285 #define KVM_S390_SIGP_STOP 0xfffe0000u
286 #define KVM_S390_PROGRAM_INT 0xfffe0001u
287 #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
288 #define KVM_S390_RESTART 0xfffe0003u
289 #define KVM_S390_INT_VIRTIO 0xffff2603u
290 #define KVM_S390_INT_SERVICE 0xffff2401u
291 #define KVM_S390_INT_EMERGENCY 0xffff1201u
293 struct kvm_s390_interrupt {
299 /* for KVM_SET_GUEST_DEBUG */
301 #define KVM_GUESTDBG_ENABLE 0x00000001
302 #define KVM_GUESTDBG_SINGLESTEP 0x00000002
304 struct kvm_guest_debug {
307 struct kvm_guest_debug_arch arch;
310 #define KVM_TRC_SHIFT 16
312 * kvm trace categories
314 #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
315 #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
320 #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
321 #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
322 #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
324 #define KVM_TRC_HEAD_SIZE 12
325 #define KVM_TRC_CYCLE_SIZE 8
326 #define KVM_TRC_EXTRA_MAX 7
331 * ioctls for /dev/kvm fds:
333 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
334 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
335 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
337 #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
339 * Check if a kvm extension is available. Argument is extension number,
340 * return is 1 (yes) or 0 (no, sorry).
342 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
344 * Get size for mmap(vcpu_fd)
346 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
347 #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
349 * ioctls for kvm trace
351 #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
352 #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
353 #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
355 * Extension capability list.
357 #define KVM_CAP_IRQCHIP 0
358 #define KVM_CAP_HLT 1
359 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
360 #define KVM_CAP_USER_MEMORY 3
361 #define KVM_CAP_SET_TSS_ADDR 4
362 #define KVM_CAP_VAPIC 6
363 #define KVM_CAP_EXT_CPUID 7
364 #define KVM_CAP_CLOCKSOURCE 8
365 #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
366 #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
367 #define KVM_CAP_PIT 11
368 #define KVM_CAP_NOP_IO_DELAY 12
369 #define KVM_CAP_PV_MMU 13
370 #define KVM_CAP_MP_STATE 14
371 #define KVM_CAP_COALESCED_MMIO 15
372 #define KVM_CAP_SYNC_MMU 16 /* Changes to host mmap are reflected in guest */
373 #ifdef __KVM_HAVE_DEVICE_ASSIGNMENT
374 #define KVM_CAP_DEVICE_ASSIGNMENT 17
376 #define KVM_CAP_IOMMU 18
377 #ifdef __KVM_HAVE_MSI
378 #define KVM_CAP_DEVICE_MSI 20
380 /* Bug in KVM_SET_USER_MEMORY_REGION fixed: */
381 #define KVM_CAP_DESTROY_MEMORY_REGION_WORKS 21
382 #ifdef __KVM_HAVE_USER_NMI
383 #define KVM_CAP_USER_NMI 22
385 #ifdef __KVM_HAVE_GUEST_DEBUG
386 #define KVM_CAP_SET_GUEST_DEBUG 23
388 #ifdef __KVM_HAVE_PIT
389 #define KVM_CAP_REINJECT_CONTROL 24
391 #ifdef __KVM_HAVE_IOAPIC
392 #define KVM_CAP_IRQ_ROUTING 25
394 #define KVM_CAP_IRQ_INJECT_STATUS 26
395 #ifdef __KVM_HAVE_DEVICE_ASSIGNMENT
396 #define KVM_CAP_DEVICE_DEASSIGNMENT 27
398 #ifdef __KVM_HAVE_MSIX
399 #define KVM_CAP_DEVICE_MSIX 28
401 #define KVM_CAP_ASSIGN_DEV_IRQ 29
402 /* Another bug in KVM_SET_USER_MEMORY_REGION fixed: */
403 #define KVM_CAP_JOIN_MEMORY_REGIONS_WORKS 30
404 #ifdef __KVM_HAVE_MCE
405 #define KVM_CAP_MCE 31
407 #define KVM_CAP_IRQFD 32
408 #ifdef __KVM_HAVE_PIT
409 #define KVM_CAP_PIT2 33
411 #define KVM_CAP_SET_BOOT_CPU_ID 34
413 #ifdef KVM_CAP_IRQ_ROUTING
415 struct kvm_irq_routing_irqchip {
420 struct kvm_irq_routing_msi {
427 /* gsi routing entry types */
428 #define KVM_IRQ_ROUTING_IRQCHIP 1
429 #define KVM_IRQ_ROUTING_MSI 2
431 struct kvm_irq_routing_entry {
437 struct kvm_irq_routing_irqchip irqchip;
438 struct kvm_irq_routing_msi msi;
443 struct kvm_irq_routing {
446 struct kvm_irq_routing_entry entries[0];
464 #define KVM_IRQFD_FLAG_DEASSIGN (1 << 0)
476 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
478 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
481 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
482 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
483 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
484 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
485 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
486 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
487 struct kvm_userspace_memory_region)
488 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
489 /* Device model IOC */
490 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
491 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
492 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
493 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
494 #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
495 #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
496 #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
497 #define KVM_IRQ_LINE_STATUS _IOWR(KVMIO, 0x67, struct kvm_irq_level)
498 #define KVM_REGISTER_COALESCED_MMIO \
499 _IOW(KVMIO, 0x67, struct kvm_coalesced_mmio_zone)
500 #define KVM_UNREGISTER_COALESCED_MMIO \
501 _IOW(KVMIO, 0x68, struct kvm_coalesced_mmio_zone)
502 #define KVM_ASSIGN_PCI_DEVICE _IOR(KVMIO, 0x69, \
503 struct kvm_assigned_pci_dev)
504 #define KVM_SET_GSI_ROUTING _IOW(KVMIO, 0x6a, struct kvm_irq_routing)
505 /* deprecated, replaced by KVM_ASSIGN_DEV_IRQ */
506 #define KVM_ASSIGN_IRQ _IOR(KVMIO, 0x70, \
507 struct kvm_assigned_irq)
508 #define KVM_ASSIGN_DEV_IRQ _IOW(KVMIO, 0x70, struct kvm_assigned_irq)
509 #define KVM_REINJECT_CONTROL _IO(KVMIO, 0x71)
510 #define KVM_DEASSIGN_PCI_DEVICE _IOW(KVMIO, 0x72, \
511 struct kvm_assigned_pci_dev)
512 #define KVM_ASSIGN_SET_MSIX_NR \
513 _IOW(KVMIO, 0x73, struct kvm_assigned_msix_nr)
514 #define KVM_ASSIGN_SET_MSIX_ENTRY \
515 _IOW(KVMIO, 0x74, struct kvm_assigned_msix_entry)
516 #define KVM_DEASSIGN_DEV_IRQ _IOW(KVMIO, 0x75, struct kvm_assigned_irq)
517 #define KVM_IRQFD _IOW(KVMIO, 0x76, struct kvm_irqfd)
518 #define KVM_CREATE_PIT2 _IOW(KVMIO, 0x77, struct kvm_pit_config)
519 #define KVM_SET_BOOT_CPU_ID _IO(KVMIO, 0x78)
522 * ioctls for vcpu fds
524 #define KVM_RUN _IO(KVMIO, 0x80)
525 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
526 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
527 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
528 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
529 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
530 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
531 /* KVM_DEBUG_GUEST is no longer supported, use KVM_SET_GUEST_DEBUG instead */
532 #define KVM_DEBUG_GUEST __KVM_DEPRECATED_DEBUG_GUEST
533 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
534 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
535 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
536 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
537 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
538 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
539 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
540 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
541 #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
542 #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
543 /* Available with KVM_CAP_VAPIC */
544 #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
545 /* Available with KVM_CAP_VAPIC */
546 #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
547 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
548 #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
549 /* store status for s390 */
550 #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
551 #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
552 #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
553 /* initial ipl psw for s390 */
554 #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
555 /* initial reset for s390 */
556 #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
557 #define KVM_GET_MP_STATE _IOR(KVMIO, 0x98, struct kvm_mp_state)
558 #define KVM_SET_MP_STATE _IOW(KVMIO, 0x99, struct kvm_mp_state)
559 /* Available with KVM_CAP_NMI */
560 #define KVM_NMI _IO(KVMIO, 0x9a)
561 /* Available with KVM_CAP_SET_GUEST_DEBUG */
562 #define KVM_SET_GUEST_DEBUG _IOW(KVMIO, 0x9b, struct kvm_guest_debug)
564 #define KVM_X86_SETUP_MCE _IOW(KVMIO, 0x9c, __u64)
565 #define KVM_X86_GET_MCE_CAP_SUPPORTED _IOR(KVMIO, 0x9d, __u64)
566 #define KVM_X86_SET_MCE _IOW(KVMIO, 0x9e, struct kvm_x86_mce)
569 * Deprecated interfaces
571 struct kvm_breakpoint {
577 struct kvm_debug_guest {
580 struct kvm_breakpoint breakpoints[4];
584 #define __KVM_DEPRECATED_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
586 #define KVM_IA64_VCPU_GET_STACK _IOR(KVMIO, 0x9a, void *)
587 #define KVM_IA64_VCPU_SET_STACK _IOW(KVMIO, 0x9b, void *)
589 #define KVM_TRC_INJ_VIRQ (KVM_TRC_HANDLER + 0x02)
590 #define KVM_TRC_REDELIVER_EVT (KVM_TRC_HANDLER + 0x03)
591 #define KVM_TRC_PEND_INTR (KVM_TRC_HANDLER + 0x04)
592 #define KVM_TRC_IO_READ (KVM_TRC_HANDLER + 0x05)
593 #define KVM_TRC_IO_WRITE (KVM_TRC_HANDLER + 0x06)
594 #define KVM_TRC_CR_READ (KVM_TRC_HANDLER + 0x07)
595 #define KVM_TRC_CR_WRITE (KVM_TRC_HANDLER + 0x08)
596 #define KVM_TRC_DR_READ (KVM_TRC_HANDLER + 0x09)
597 #define KVM_TRC_DR_WRITE (KVM_TRC_HANDLER + 0x0A)
598 #define KVM_TRC_MSR_READ (KVM_TRC_HANDLER + 0x0B)
599 #define KVM_TRC_MSR_WRITE (KVM_TRC_HANDLER + 0x0C)
600 #define KVM_TRC_CPUID (KVM_TRC_HANDLER + 0x0D)
601 #define KVM_TRC_INTR (KVM_TRC_HANDLER + 0x0E)
602 #define KVM_TRC_NMI (KVM_TRC_HANDLER + 0x0F)
603 #define KVM_TRC_VMMCALL (KVM_TRC_HANDLER + 0x10)
604 #define KVM_TRC_HLT (KVM_TRC_HANDLER + 0x11)
605 #define KVM_TRC_CLTS (KVM_TRC_HANDLER + 0x12)
606 #define KVM_TRC_LMSW (KVM_TRC_HANDLER + 0x13)
607 #define KVM_TRC_APIC_ACCESS (KVM_TRC_HANDLER + 0x14)
608 #define KVM_TRC_TDP_FAULT (KVM_TRC_HANDLER + 0x15)
609 #define KVM_TRC_GTLB_WRITE (KVM_TRC_HANDLER + 0x16)
610 #define KVM_TRC_STLB_WRITE (KVM_TRC_HANDLER + 0x17)
611 #define KVM_TRC_STLB_INVAL (KVM_TRC_HANDLER + 0x18)
612 #define KVM_TRC_PPC_INSTR (KVM_TRC_HANDLER + 0x19)
614 #define KVM_DEV_ASSIGN_ENABLE_IOMMU (1 << 0)
616 struct kvm_assigned_pci_dev {
617 __u32 assigned_dev_id;
626 #define KVM_DEV_IRQ_HOST_INTX (1 << 0)
627 #define KVM_DEV_IRQ_HOST_MSI (1 << 1)
628 #define KVM_DEV_IRQ_HOST_MSIX (1 << 2)
630 #define KVM_DEV_IRQ_GUEST_INTX (1 << 8)
631 #define KVM_DEV_IRQ_GUEST_MSI (1 << 9)
632 #define KVM_DEV_IRQ_GUEST_MSIX (1 << 10)
634 #define KVM_DEV_IRQ_HOST_MASK 0x00ff
635 #define KVM_DEV_IRQ_GUEST_MASK 0xff00
637 struct kvm_assigned_irq {
638 __u32 assigned_dev_id;
653 struct kvm_assigned_msix_nr {
654 __u32 assigned_dev_id;
659 #define KVM_MAX_MSIX_PER_DEV 256
660 struct kvm_assigned_msix_entry {
661 __u32 assigned_dev_id;
663 __u16 entry; /* The index of entry in the MSI-X table */