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 <asm/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 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
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
87 #define KVM_EXIT_NMI_WINDOW_OPEN 17
89 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
92 __u8 request_interrupt_window;
93 __u8 request_nmi_window;
98 __u8 ready_for_interrupt_injection;
100 __u8 ready_for_nmi_injection;
103 /* in (pre_kvm_run), out (post_kvm_run) */
108 /* KVM_EXIT_UNKNOWN */
110 __u64 hardware_exit_reason;
112 /* KVM_EXIT_FAIL_ENTRY */
114 __u64 hardware_entry_failure_reason;
116 /* KVM_EXIT_EXCEPTION */
123 #define KVM_EXIT_IO_IN 0
124 #define KVM_EXIT_IO_OUT 1
126 __u8 size; /* bytes */
129 __u64 data_offset; /* relative to kvm_run start */
140 /* KVM_EXIT_HYPERCALL */
148 /* KVM_EXIT_TPR_ACCESS */
154 /* KVM_EXIT_S390_SIEIC */
157 __u64 mask; /* psw upper half */
158 __u64 addr; /* psw lower half */
162 /* KVM_EXIT_S390_RESET */
163 #define KVM_S390_RESET_POR 1
164 #define KVM_S390_RESET_CLEAR 2
165 #define KVM_S390_RESET_SUBSYSTEM 4
166 #define KVM_S390_RESET_CPU_INIT 8
167 #define KVM_S390_RESET_IPL 16
168 __u64 s390_reset_flags;
175 /* Fix the size of the union. */
180 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
182 struct kvm_coalesced_mmio_zone {
188 struct kvm_coalesced_mmio {
195 struct kvm_coalesced_mmio_ring {
197 struct kvm_coalesced_mmio coalesced_mmio[0];
200 #define KVM_COALESCED_MMIO_MAX \
201 ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
202 sizeof(struct kvm_coalesced_mmio))
204 /* for KVM_TRANSLATE */
205 struct kvm_translation {
207 __u64 linear_address;
210 __u64 physical_address;
217 /* for KVM_INTERRUPT */
218 struct kvm_interrupt {
223 struct kvm_breakpoint {
229 /* for KVM_DEBUG_GUEST */
230 struct kvm_debug_guest {
234 struct kvm_breakpoint breakpoints[4];
238 /* for KVM_GET_DIRTY_LOG */
239 struct kvm_dirty_log {
243 void __user *dirty_bitmap; /* one bit per page */
248 /* for KVM_SET_SIGNAL_MASK */
249 struct kvm_signal_mask {
254 /* for KVM_TPR_ACCESS_REPORTING */
255 struct kvm_tpr_access_ctl {
261 /* for KVM_SET_VAPIC_ADDR */
262 struct kvm_vapic_addr {
266 /* for KVM_SET_MPSTATE */
268 #define KVM_MP_STATE_RUNNABLE 0
269 #define KVM_MP_STATE_UNINITIALIZED 1
270 #define KVM_MP_STATE_INIT_RECEIVED 2
271 #define KVM_MP_STATE_HALTED 3
272 #define KVM_MP_STATE_SIPI_RECEIVED 4
274 struct kvm_mp_state {
278 struct kvm_s390_psw {
283 /* valid values for type in kvm_s390_interrupt */
284 #define KVM_S390_SIGP_STOP 0xfffe0000u
285 #define KVM_S390_PROGRAM_INT 0xfffe0001u
286 #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
287 #define KVM_S390_RESTART 0xfffe0003u
288 #define KVM_S390_INT_VIRTIO 0xffff2603u
289 #define KVM_S390_INT_SERVICE 0xffff2401u
290 #define KVM_S390_INT_EMERGENCY 0xffff1201u
292 struct kvm_s390_interrupt {
298 #define KVM_TRC_SHIFT 16
300 * kvm trace categories
302 #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
303 #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
308 #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
309 #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
310 #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
312 #define KVM_TRC_HEAD_SIZE 12
313 #define KVM_TRC_CYCLE_SIZE 8
314 #define KVM_TRC_EXTRA_MAX 7
316 /* This structure represents a single trace buffer record. */
317 struct kvm_trace_rec {
320 * bits 0 - 27 -> event id
321 * bits 28 -30 -> number of extra data args of size u32
322 * bits 31 -> binary indicator for if tsc is in record
330 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
331 } __attribute__((packed)) timestamp;
333 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
338 #define TRACE_REC_EVENT_ID(val) \
340 #define TRACE_REC_NUM_DATA_ARGS(val) \
341 (0x70000000 & ((val) << 28))
342 #define TRACE_REC_TCS(val) \
343 (0x80000000 & ((val) << 31))
348 * ioctls for /dev/kvm fds:
350 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
351 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
352 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
354 #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
356 * Check if a kvm extension is available. Argument is extension number,
357 * return is 1 (yes) or 0 (no, sorry).
359 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
361 * Get size for mmap(vcpu_fd)
363 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
364 #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
366 * ioctls for kvm trace
368 #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
369 #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
370 #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
372 * Extension capability list.
374 #define KVM_CAP_IRQCHIP 0
375 #define KVM_CAP_HLT 1
376 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
377 #define KVM_CAP_USER_MEMORY 3
378 #define KVM_CAP_SET_TSS_ADDR 4
379 #define KVM_CAP_VAPIC 6
380 #define KVM_CAP_EXT_CPUID 7
381 #define KVM_CAP_CLOCKSOURCE 8
382 #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
383 #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
384 #define KVM_CAP_PIT 11
385 #define KVM_CAP_NOP_IO_DELAY 12
386 #define KVM_CAP_PV_MMU 13
387 #define KVM_CAP_MP_STATE 14
388 #define KVM_CAP_COALESCED_MMIO 15
389 #define KVM_CAP_SYNC_MMU 16 /* Changes to host mmap are reflected in guest */
390 #if defined(CONFIG_X86)||defined(CONFIG_IA64)
391 #define KVM_CAP_DEVICE_ASSIGNMENT 17
393 #define KVM_CAP_IOMMU 18
394 #define KVM_CAP_NMI 19
399 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
400 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
401 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
402 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
403 struct kvm_userspace_memory_region)
404 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
406 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
409 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
410 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
411 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
412 /* Device model IOC */
413 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
414 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
415 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
416 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
417 #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
418 #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
419 #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
420 #define KVM_REGISTER_COALESCED_MMIO \
421 _IOW(KVMIO, 0x67, struct kvm_coalesced_mmio_zone)
422 #define KVM_UNREGISTER_COALESCED_MMIO \
423 _IOW(KVMIO, 0x68, struct kvm_coalesced_mmio_zone)
424 #define KVM_ASSIGN_PCI_DEVICE _IOR(KVMIO, 0x69, \
425 struct kvm_assigned_pci_dev)
426 #define KVM_ASSIGN_IRQ _IOR(KVMIO, 0x70, \
427 struct kvm_assigned_irq)
430 * ioctls for vcpu fds
432 #define KVM_RUN _IO(KVMIO, 0x80)
433 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
434 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
435 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
436 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
437 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
438 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
439 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
440 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
441 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
442 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
443 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
444 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
445 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
446 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
447 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
448 #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
449 #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
450 /* Available with KVM_CAP_VAPIC */
451 #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
452 /* Available with KVM_CAP_VAPIC */
453 #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
454 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
455 #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
456 /* store status for s390 */
457 #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
458 #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
459 #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
460 /* initial ipl psw for s390 */
461 #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
462 /* initial reset for s390 */
463 #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
464 #define KVM_GET_MP_STATE _IOR(KVMIO, 0x98, struct kvm_mp_state)
465 #define KVM_SET_MP_STATE _IOW(KVMIO, 0x99, struct kvm_mp_state)
466 /* Available with KVM_CAP_NMI */
467 #define KVM_NMI _IO(KVMIO, 0x9a)
469 #define KVM_TRC_INJ_VIRQ (KVM_TRC_HANDLER + 0x02)
470 #define KVM_TRC_REDELIVER_EVT (KVM_TRC_HANDLER + 0x03)
471 #define KVM_TRC_PEND_INTR (KVM_TRC_HANDLER + 0x04)
472 #define KVM_TRC_IO_READ (KVM_TRC_HANDLER + 0x05)
473 #define KVM_TRC_IO_WRITE (KVM_TRC_HANDLER + 0x06)
474 #define KVM_TRC_CR_READ (KVM_TRC_HANDLER + 0x07)
475 #define KVM_TRC_CR_WRITE (KVM_TRC_HANDLER + 0x08)
476 #define KVM_TRC_DR_READ (KVM_TRC_HANDLER + 0x09)
477 #define KVM_TRC_DR_WRITE (KVM_TRC_HANDLER + 0x0A)
478 #define KVM_TRC_MSR_READ (KVM_TRC_HANDLER + 0x0B)
479 #define KVM_TRC_MSR_WRITE (KVM_TRC_HANDLER + 0x0C)
480 #define KVM_TRC_CPUID (KVM_TRC_HANDLER + 0x0D)
481 #define KVM_TRC_INTR (KVM_TRC_HANDLER + 0x0E)
482 #define KVM_TRC_NMI (KVM_TRC_HANDLER + 0x0F)
483 #define KVM_TRC_VMMCALL (KVM_TRC_HANDLER + 0x10)
484 #define KVM_TRC_HLT (KVM_TRC_HANDLER + 0x11)
485 #define KVM_TRC_CLTS (KVM_TRC_HANDLER + 0x12)
486 #define KVM_TRC_LMSW (KVM_TRC_HANDLER + 0x13)
487 #define KVM_TRC_APIC_ACCESS (KVM_TRC_HANDLER + 0x14)
488 #define KVM_TRC_TDP_FAULT (KVM_TRC_HANDLER + 0x15)
489 #define KVM_TRC_GTLB_WRITE (KVM_TRC_HANDLER + 0x16)
490 #define KVM_TRC_STLB_WRITE (KVM_TRC_HANDLER + 0x17)
491 #define KVM_TRC_STLB_INVAL (KVM_TRC_HANDLER + 0x18)
492 #define KVM_TRC_PPC_INSTR (KVM_TRC_HANDLER + 0x19)
494 struct kvm_assigned_pci_dev {
495 __u32 assigned_dev_id;
504 struct kvm_assigned_irq {
505 __u32 assigned_dev_id;
514 #define KVM_DEV_ASSIGN_ENABLE_IOMMU (1 << 0)