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 */
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..
60 char dummy[512]; /* reserving space */
62 struct kvm_pic_state pic;
64 #ifdef __KVM_HAVE_IOAPIC
65 struct kvm_ioapic_state ioapic;
70 #define KVM_EXIT_UNKNOWN 0
71 #define KVM_EXIT_EXCEPTION 1
73 #define KVM_EXIT_HYPERCALL 3
74 #define KVM_EXIT_DEBUG 4
75 #define KVM_EXIT_HLT 5
76 #define KVM_EXIT_MMIO 6
77 #define KVM_EXIT_IRQ_WINDOW_OPEN 7
78 #define KVM_EXIT_SHUTDOWN 8
79 #define KVM_EXIT_FAIL_ENTRY 9
80 #define KVM_EXIT_INTR 10
81 #define KVM_EXIT_SET_TPR 11
82 #define KVM_EXIT_TPR_ACCESS 12
83 #define KVM_EXIT_S390_SIEIC 13
84 #define KVM_EXIT_S390_RESET 14
85 #define KVM_EXIT_DCR 15
86 #define KVM_EXIT_NMI 16
88 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
91 __u8 request_interrupt_window;
96 __u8 ready_for_interrupt_injection;
100 /* in (pre_kvm_run), out (post_kvm_run) */
105 /* KVM_EXIT_UNKNOWN */
107 __u64 hardware_exit_reason;
109 /* KVM_EXIT_FAIL_ENTRY */
111 __u64 hardware_entry_failure_reason;
113 /* KVM_EXIT_EXCEPTION */
120 #define KVM_EXIT_IO_IN 0
121 #define KVM_EXIT_IO_OUT 1
123 __u8 size; /* bytes */
126 __u64 data_offset; /* relative to kvm_run start */
129 struct kvm_debug_exit_arch arch;
138 /* KVM_EXIT_HYPERCALL */
146 /* KVM_EXIT_TPR_ACCESS */
152 /* KVM_EXIT_S390_SIEIC */
155 __u64 mask; /* psw upper half */
156 __u64 addr; /* psw lower half */
160 /* KVM_EXIT_S390_RESET */
161 #define KVM_S390_RESET_POR 1
162 #define KVM_S390_RESET_CLEAR 2
163 #define KVM_S390_RESET_SUBSYSTEM 4
164 #define KVM_S390_RESET_CPU_INIT 8
165 #define KVM_S390_RESET_IPL 16
166 __u64 s390_reset_flags;
173 /* Fix the size of the union. */
178 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
180 struct kvm_coalesced_mmio_zone {
186 struct kvm_coalesced_mmio {
193 struct kvm_coalesced_mmio_ring {
195 struct kvm_coalesced_mmio coalesced_mmio[0];
198 #define KVM_COALESCED_MMIO_MAX \
199 ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
200 sizeof(struct kvm_coalesced_mmio))
202 /* for KVM_TRANSLATE */
203 struct kvm_translation {
205 __u64 linear_address;
208 __u64 physical_address;
215 /* for KVM_INTERRUPT */
216 struct kvm_interrupt {
221 /* for KVM_GET_DIRTY_LOG */
222 struct kvm_dirty_log {
226 void __user *dirty_bitmap; /* one bit per page */
231 /* for KVM_SET_SIGNAL_MASK */
232 struct kvm_signal_mask {
237 /* for KVM_TPR_ACCESS_REPORTING */
238 struct kvm_tpr_access_ctl {
244 /* for KVM_SET_VAPIC_ADDR */
245 struct kvm_vapic_addr {
249 /* for KVM_SET_MPSTATE */
251 #define KVM_MP_STATE_RUNNABLE 0
252 #define KVM_MP_STATE_UNINITIALIZED 1
253 #define KVM_MP_STATE_INIT_RECEIVED 2
254 #define KVM_MP_STATE_HALTED 3
255 #define KVM_MP_STATE_SIPI_RECEIVED 4
257 struct kvm_mp_state {
261 struct kvm_s390_psw {
266 /* valid values for type in kvm_s390_interrupt */
267 #define KVM_S390_SIGP_STOP 0xfffe0000u
268 #define KVM_S390_PROGRAM_INT 0xfffe0001u
269 #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
270 #define KVM_S390_RESTART 0xfffe0003u
271 #define KVM_S390_INT_VIRTIO 0xffff2603u
272 #define KVM_S390_INT_SERVICE 0xffff2401u
273 #define KVM_S390_INT_EMERGENCY 0xffff1201u
275 struct kvm_s390_interrupt {
281 /* for KVM_SET_GUEST_DEBUG */
283 #define KVM_GUESTDBG_ENABLE 0x00000001
284 #define KVM_GUESTDBG_SINGLESTEP 0x00000002
286 struct kvm_guest_debug {
289 struct kvm_guest_debug_arch arch;
292 #define KVM_TRC_SHIFT 16
294 * kvm trace categories
296 #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
297 #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
302 #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
303 #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
304 #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
306 #define KVM_TRC_HEAD_SIZE 12
307 #define KVM_TRC_CYCLE_SIZE 8
308 #define KVM_TRC_EXTRA_MAX 7
310 /* This structure represents a single trace buffer record. */
311 struct kvm_trace_rec {
314 * bits 0 - 27 -> event id
315 * bits 28 -30 -> number of extra data args of size u32
316 * bits 31 -> binary indicator for if tsc is in record
324 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
325 } __attribute__((packed)) timestamp;
327 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
332 #define TRACE_REC_EVENT_ID(val) \
334 #define TRACE_REC_NUM_DATA_ARGS(val) \
335 (0x70000000 & ((val) << 28))
336 #define TRACE_REC_TCS(val) \
337 (0x80000000 & ((val) << 31))
342 * ioctls for /dev/kvm fds:
344 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
345 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
346 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
348 #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
350 * Check if a kvm extension is available. Argument is extension number,
351 * return is 1 (yes) or 0 (no, sorry).
353 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
355 * Get size for mmap(vcpu_fd)
357 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
358 #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
360 * ioctls for kvm trace
362 #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
363 #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
364 #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
366 * Extension capability list.
368 #define KVM_CAP_IRQCHIP 0
369 #define KVM_CAP_HLT 1
370 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
371 #define KVM_CAP_USER_MEMORY 3
372 #define KVM_CAP_SET_TSS_ADDR 4
373 #define KVM_CAP_VAPIC 6
374 #define KVM_CAP_EXT_CPUID 7
375 #define KVM_CAP_CLOCKSOURCE 8
376 #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
377 #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
378 #define KVM_CAP_PIT 11
379 #define KVM_CAP_NOP_IO_DELAY 12
380 #define KVM_CAP_PV_MMU 13
381 #define KVM_CAP_MP_STATE 14
382 #define KVM_CAP_COALESCED_MMIO 15
383 #define KVM_CAP_SYNC_MMU 16 /* Changes to host mmap are reflected in guest */
384 #ifdef __KVM_HAVE_DEVICE_ASSIGNMENT
385 #define KVM_CAP_DEVICE_ASSIGNMENT 17
387 #define KVM_CAP_IOMMU 18
388 #ifdef __KVM_HAVE_MSI
389 #define KVM_CAP_DEVICE_MSI 20
391 /* Bug in KVM_SET_USER_MEMORY_REGION fixed: */
392 #define KVM_CAP_DESTROY_MEMORY_REGION_WORKS 21
393 #ifdef __KVM_HAVE_USER_NMI
394 #define KVM_CAP_USER_NMI 22
396 #define KVM_CAP_SET_GUEST_DEBUG 23
401 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
402 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
403 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
404 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
405 struct kvm_userspace_memory_region)
406 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
408 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
411 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
412 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
413 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
414 /* Device model IOC */
415 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
416 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
417 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
418 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
419 #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
420 #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
421 #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
422 #define KVM_REGISTER_COALESCED_MMIO \
423 _IOW(KVMIO, 0x67, struct kvm_coalesced_mmio_zone)
424 #define KVM_UNREGISTER_COALESCED_MMIO \
425 _IOW(KVMIO, 0x68, struct kvm_coalesced_mmio_zone)
426 #define KVM_ASSIGN_PCI_DEVICE _IOR(KVMIO, 0x69, \
427 struct kvm_assigned_pci_dev)
428 #define KVM_ASSIGN_IRQ _IOR(KVMIO, 0x70, \
429 struct kvm_assigned_irq)
432 * ioctls for vcpu fds
434 #define KVM_RUN _IO(KVMIO, 0x80)
435 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
436 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
437 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
438 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
439 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
440 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
441 /* KVM_DEBUG_GUEST is no longer supported, use KVM_SET_GUEST_DEBUG instead */
442 #define KVM_DEBUG_GUEST __KVM_DEPRECATED_DEBUG_GUEST
443 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
444 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
445 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
446 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
447 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
448 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
449 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
450 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
451 #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
452 #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
453 /* Available with KVM_CAP_VAPIC */
454 #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
455 /* Available with KVM_CAP_VAPIC */
456 #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
457 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
458 #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
459 /* store status for s390 */
460 #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
461 #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
462 #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
463 /* initial ipl psw for s390 */
464 #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
465 /* initial reset for s390 */
466 #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
467 #define KVM_GET_MP_STATE _IOR(KVMIO, 0x98, struct kvm_mp_state)
468 #define KVM_SET_MP_STATE _IOW(KVMIO, 0x99, struct kvm_mp_state)
469 /* Available with KVM_CAP_NMI */
470 #define KVM_NMI _IO(KVMIO, 0x9a)
471 /* Available with KVM_CAP_SET_GUEST_DEBUG */
472 #define KVM_SET_GUEST_DEBUG _IOW(KVMIO, 0x9b, struct kvm_guest_debug)
475 * Deprecated interfaces
477 struct kvm_breakpoint {
483 struct kvm_debug_guest {
486 struct kvm_breakpoint breakpoints[4];
490 #define __KVM_DEPRECATED_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
492 #define KVM_TRC_INJ_VIRQ (KVM_TRC_HANDLER + 0x02)
493 #define KVM_TRC_REDELIVER_EVT (KVM_TRC_HANDLER + 0x03)
494 #define KVM_TRC_PEND_INTR (KVM_TRC_HANDLER + 0x04)
495 #define KVM_TRC_IO_READ (KVM_TRC_HANDLER + 0x05)
496 #define KVM_TRC_IO_WRITE (KVM_TRC_HANDLER + 0x06)
497 #define KVM_TRC_CR_READ (KVM_TRC_HANDLER + 0x07)
498 #define KVM_TRC_CR_WRITE (KVM_TRC_HANDLER + 0x08)
499 #define KVM_TRC_DR_READ (KVM_TRC_HANDLER + 0x09)
500 #define KVM_TRC_DR_WRITE (KVM_TRC_HANDLER + 0x0A)
501 #define KVM_TRC_MSR_READ (KVM_TRC_HANDLER + 0x0B)
502 #define KVM_TRC_MSR_WRITE (KVM_TRC_HANDLER + 0x0C)
503 #define KVM_TRC_CPUID (KVM_TRC_HANDLER + 0x0D)
504 #define KVM_TRC_INTR (KVM_TRC_HANDLER + 0x0E)
505 #define KVM_TRC_NMI (KVM_TRC_HANDLER + 0x0F)
506 #define KVM_TRC_VMMCALL (KVM_TRC_HANDLER + 0x10)
507 #define KVM_TRC_HLT (KVM_TRC_HANDLER + 0x11)
508 #define KVM_TRC_CLTS (KVM_TRC_HANDLER + 0x12)
509 #define KVM_TRC_LMSW (KVM_TRC_HANDLER + 0x13)
510 #define KVM_TRC_APIC_ACCESS (KVM_TRC_HANDLER + 0x14)
511 #define KVM_TRC_TDP_FAULT (KVM_TRC_HANDLER + 0x15)
512 #define KVM_TRC_GTLB_WRITE (KVM_TRC_HANDLER + 0x16)
513 #define KVM_TRC_STLB_WRITE (KVM_TRC_HANDLER + 0x17)
514 #define KVM_TRC_STLB_INVAL (KVM_TRC_HANDLER + 0x18)
515 #define KVM_TRC_PPC_INSTR (KVM_TRC_HANDLER + 0x19)
517 struct kvm_assigned_pci_dev {
518 __u32 assigned_dev_id;
527 struct kvm_assigned_irq {
528 __u32 assigned_dev_id;
542 #define KVM_DEV_ASSIGN_ENABLE_IOMMU (1 << 0)
544 #define KVM_DEV_IRQ_ASSIGN_ENABLE_MSI (1 << 0)