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
87 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
90 __u8 request_interrupt_window;
95 __u8 ready_for_interrupt_injection;
99 /* in (pre_kvm_run), out (post_kvm_run) */
104 /* KVM_EXIT_UNKNOWN */
106 __u64 hardware_exit_reason;
108 /* KVM_EXIT_FAIL_ENTRY */
110 __u64 hardware_entry_failure_reason;
112 /* KVM_EXIT_EXCEPTION */
119 #define KVM_EXIT_IO_IN 0
120 #define KVM_EXIT_IO_OUT 1
122 __u8 size; /* bytes */
125 __u64 data_offset; /* relative to kvm_run start */
136 /* KVM_EXIT_HYPERCALL */
144 /* KVM_EXIT_TPR_ACCESS */
150 /* KVM_EXIT_S390_SIEIC */
153 __u64 mask; /* psw upper half */
154 __u64 addr; /* psw lower half */
158 /* KVM_EXIT_S390_RESET */
159 #define KVM_S390_RESET_POR 1
160 #define KVM_S390_RESET_CLEAR 2
161 #define KVM_S390_RESET_SUBSYSTEM 4
162 #define KVM_S390_RESET_CPU_INIT 8
163 #define KVM_S390_RESET_IPL 16
164 __u64 s390_reset_flags;
171 /* Fix the size of the union. */
176 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
178 struct kvm_coalesced_mmio_zone {
184 struct kvm_coalesced_mmio {
191 struct kvm_coalesced_mmio_ring {
193 struct kvm_coalesced_mmio coalesced_mmio[0];
196 #define KVM_COALESCED_MMIO_MAX \
197 ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
198 sizeof(struct kvm_coalesced_mmio))
200 /* for KVM_TRANSLATE */
201 struct kvm_translation {
203 __u64 linear_address;
206 __u64 physical_address;
213 /* for KVM_INTERRUPT */
214 struct kvm_interrupt {
219 struct kvm_breakpoint {
225 /* for KVM_DEBUG_GUEST */
226 struct kvm_debug_guest {
230 struct kvm_breakpoint breakpoints[4];
234 /* for KVM_GET_DIRTY_LOG */
235 struct kvm_dirty_log {
239 void __user *dirty_bitmap; /* one bit per page */
244 /* for KVM_SET_SIGNAL_MASK */
245 struct kvm_signal_mask {
250 /* for KVM_TPR_ACCESS_REPORTING */
251 struct kvm_tpr_access_ctl {
257 /* for KVM_SET_VAPIC_ADDR */
258 struct kvm_vapic_addr {
262 /* for KVM_SET_MPSTATE */
264 #define KVM_MP_STATE_RUNNABLE 0
265 #define KVM_MP_STATE_UNINITIALIZED 1
266 #define KVM_MP_STATE_INIT_RECEIVED 2
267 #define KVM_MP_STATE_HALTED 3
268 #define KVM_MP_STATE_SIPI_RECEIVED 4
270 struct kvm_mp_state {
274 struct kvm_s390_psw {
279 /* valid values for type in kvm_s390_interrupt */
280 #define KVM_S390_SIGP_STOP 0xfffe0000u
281 #define KVM_S390_PROGRAM_INT 0xfffe0001u
282 #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
283 #define KVM_S390_RESTART 0xfffe0003u
284 #define KVM_S390_INT_VIRTIO 0xffff2603u
285 #define KVM_S390_INT_SERVICE 0xffff2401u
286 #define KVM_S390_INT_EMERGENCY 0xffff1201u
288 struct kvm_s390_interrupt {
294 #define KVM_TRC_SHIFT 16
296 * kvm trace categories
298 #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
299 #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
304 #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
305 #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
306 #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
308 #define KVM_TRC_HEAD_SIZE 12
309 #define KVM_TRC_CYCLE_SIZE 8
310 #define KVM_TRC_EXTRA_MAX 7
312 /* This structure represents a single trace buffer record. */
313 struct kvm_trace_rec {
316 * bits 0 - 27 -> event id
317 * bits 28 -30 -> number of extra data args of size u32
318 * bits 31 -> binary indicator for if tsc is in record
326 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
327 } __attribute__((packed)) timestamp;
329 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
334 #define TRACE_REC_EVENT_ID(val) \
336 #define TRACE_REC_NUM_DATA_ARGS(val) \
337 (0x70000000 & ((val) << 28))
338 #define TRACE_REC_TCS(val) \
339 (0x80000000 & ((val) << 31))
344 * ioctls for /dev/kvm fds:
346 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
347 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
348 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
350 #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
352 * Check if a kvm extension is available. Argument is extension number,
353 * return is 1 (yes) or 0 (no, sorry).
355 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
357 * Get size for mmap(vcpu_fd)
359 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
360 #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
362 * ioctls for kvm trace
364 #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
365 #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
366 #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
368 * Extension capability list.
370 #define KVM_CAP_IRQCHIP 0
371 #define KVM_CAP_HLT 1
372 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
373 #define KVM_CAP_USER_MEMORY 3
374 #define KVM_CAP_SET_TSS_ADDR 4
375 #define KVM_CAP_VAPIC 6
376 #define KVM_CAP_EXT_CPUID 7
377 #define KVM_CAP_CLOCKSOURCE 8
378 #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
379 #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
380 #define KVM_CAP_PIT 11
381 #define KVM_CAP_NOP_IO_DELAY 12
382 #define KVM_CAP_PV_MMU 13
383 #define KVM_CAP_MP_STATE 14
384 #define KVM_CAP_COALESCED_MMIO 15
385 #define KVM_CAP_SYNC_MMU 16 /* Changes to host mmap are reflected in guest */
386 #if defined(CONFIG_X86)||defined(CONFIG_IA64)
387 #define KVM_CAP_DEVICE_ASSIGNMENT 17
389 #define KVM_CAP_IOMMU 18
394 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
395 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
396 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
397 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
398 struct kvm_userspace_memory_region)
399 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
401 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
404 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
405 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
406 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
407 /* Device model IOC */
408 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
409 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
410 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
411 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
412 #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
413 #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
414 #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
415 #define KVM_REGISTER_COALESCED_MMIO \
416 _IOW(KVMIO, 0x67, struct kvm_coalesced_mmio_zone)
417 #define KVM_UNREGISTER_COALESCED_MMIO \
418 _IOW(KVMIO, 0x68, struct kvm_coalesced_mmio_zone)
419 #define KVM_ASSIGN_PCI_DEVICE _IOR(KVMIO, 0x69, \
420 struct kvm_assigned_pci_dev)
421 #define KVM_ASSIGN_IRQ _IOR(KVMIO, 0x70, \
422 struct kvm_assigned_irq)
425 * ioctls for vcpu fds
427 #define KVM_RUN _IO(KVMIO, 0x80)
428 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
429 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
430 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
431 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
432 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
433 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
434 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
435 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
436 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
437 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
438 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
439 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
440 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
441 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
442 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
443 #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
444 #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
445 /* Available with KVM_CAP_VAPIC */
446 #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
447 /* Available with KVM_CAP_VAPIC */
448 #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
449 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
450 #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
451 /* store status for s390 */
452 #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
453 #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
454 #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
455 /* initial ipl psw for s390 */
456 #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
457 /* initial reset for s390 */
458 #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
459 #define KVM_GET_MP_STATE _IOR(KVMIO, 0x98, struct kvm_mp_state)
460 #define KVM_SET_MP_STATE _IOW(KVMIO, 0x99, struct kvm_mp_state)
462 #define KVM_TRC_INJ_VIRQ (KVM_TRC_HANDLER + 0x02)
463 #define KVM_TRC_REDELIVER_EVT (KVM_TRC_HANDLER + 0x03)
464 #define KVM_TRC_PEND_INTR (KVM_TRC_HANDLER + 0x04)
465 #define KVM_TRC_IO_READ (KVM_TRC_HANDLER + 0x05)
466 #define KVM_TRC_IO_WRITE (KVM_TRC_HANDLER + 0x06)
467 #define KVM_TRC_CR_READ (KVM_TRC_HANDLER + 0x07)
468 #define KVM_TRC_CR_WRITE (KVM_TRC_HANDLER + 0x08)
469 #define KVM_TRC_DR_READ (KVM_TRC_HANDLER + 0x09)
470 #define KVM_TRC_DR_WRITE (KVM_TRC_HANDLER + 0x0A)
471 #define KVM_TRC_MSR_READ (KVM_TRC_HANDLER + 0x0B)
472 #define KVM_TRC_MSR_WRITE (KVM_TRC_HANDLER + 0x0C)
473 #define KVM_TRC_CPUID (KVM_TRC_HANDLER + 0x0D)
474 #define KVM_TRC_INTR (KVM_TRC_HANDLER + 0x0E)
475 #define KVM_TRC_NMI (KVM_TRC_HANDLER + 0x0F)
476 #define KVM_TRC_VMMCALL (KVM_TRC_HANDLER + 0x10)
477 #define KVM_TRC_HLT (KVM_TRC_HANDLER + 0x11)
478 #define KVM_TRC_CLTS (KVM_TRC_HANDLER + 0x12)
479 #define KVM_TRC_LMSW (KVM_TRC_HANDLER + 0x13)
480 #define KVM_TRC_APIC_ACCESS (KVM_TRC_HANDLER + 0x14)
481 #define KVM_TRC_TDP_FAULT (KVM_TRC_HANDLER + 0x15)
482 #define KVM_TRC_GTLB_WRITE (KVM_TRC_HANDLER + 0x16)
483 #define KVM_TRC_STLB_WRITE (KVM_TRC_HANDLER + 0x17)
484 #define KVM_TRC_STLB_INVAL (KVM_TRC_HANDLER + 0x18)
485 #define KVM_TRC_PPC_INSTR (KVM_TRC_HANDLER + 0x19)
487 struct kvm_assigned_pci_dev {
488 __u32 assigned_dev_id;
497 struct kvm_assigned_irq {
498 __u32 assigned_dev_id;
507 #define KVM_DEV_ASSIGN_ENABLE_IOMMU (1 << 0)