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/ioctl.h>
13 #define KVM_API_VERSION 12
15 /* Architectural interrupt line count. */
16 #define KVM_NR_INTERRUPTS 256
18 /* for KVM_CREATE_MEMORY_REGION */
19 struct kvm_memory_region {
22 __u64 guest_phys_addr;
23 __u64 memory_size; /* bytes */
26 /* for KVM_SET_USER_MEMORY_REGION */
27 struct kvm_userspace_memory_region {
30 __u64 guest_phys_addr;
31 __u64 memory_size; /* bytes */
32 __u64 userspace_addr; /* start of the userspace allocated memory */
35 /* for kvm_memory_region::flags */
36 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
38 struct kvm_memory_alias {
39 __u32 slot; /* this has a different namespace than memory slots */
41 __u64 guest_phys_addr;
43 __u64 target_phys_addr;
46 /* for KVM_IRQ_LINE */
47 struct kvm_irq_level {
49 * ACPI gsi notion of irq.
50 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
51 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
57 /* for KVM_GET_IRQCHIP and KVM_SET_IRQCHIP */
58 struct kvm_pic_state {
59 __u8 last_irr; /* edge detection */
60 __u8 irr; /* interrupt request register */
61 __u8 imr; /* interrupt mask register */
62 __u8 isr; /* interrupt service register */
63 __u8 priority_add; /* highest irq priority */
70 __u8 rotate_on_auto_eoi;
71 __u8 special_fully_nested_mode;
72 __u8 init4; /* true if 4 byte init */
73 __u8 elcr; /* PIIX edge/trigger selection */
77 #define KVM_IOAPIC_NUM_PINS 24
78 struct kvm_ioapic_state {
90 __u8 delivery_status:1;
99 } redirtbl[KVM_IOAPIC_NUM_PINS];
102 #define KVM_IRQCHIP_PIC_MASTER 0
103 #define KVM_IRQCHIP_PIC_SLAVE 1
104 #define KVM_IRQCHIP_IOAPIC 2
110 char dummy[512]; /* reserving space */
111 struct kvm_pic_state pic;
112 struct kvm_ioapic_state ioapic;
116 #define KVM_EXIT_UNKNOWN 0
117 #define KVM_EXIT_EXCEPTION 1
118 #define KVM_EXIT_IO 2
119 #define KVM_EXIT_HYPERCALL 3
120 #define KVM_EXIT_DEBUG 4
121 #define KVM_EXIT_HLT 5
122 #define KVM_EXIT_MMIO 6
123 #define KVM_EXIT_IRQ_WINDOW_OPEN 7
124 #define KVM_EXIT_SHUTDOWN 8
125 #define KVM_EXIT_FAIL_ENTRY 9
126 #define KVM_EXIT_INTR 10
127 #define KVM_EXIT_SET_TPR 11
129 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
132 __u8 request_interrupt_window;
137 __u8 ready_for_interrupt_injection;
141 /* in (pre_kvm_run), out (post_kvm_run) */
146 /* KVM_EXIT_UNKNOWN */
148 __u64 hardware_exit_reason;
150 /* KVM_EXIT_FAIL_ENTRY */
152 __u64 hardware_entry_failure_reason;
154 /* KVM_EXIT_EXCEPTION */
161 #define KVM_EXIT_IO_IN 0
162 #define KVM_EXIT_IO_OUT 1
164 __u8 size; /* bytes */
167 __u64 data_offset; /* relative to kvm_run start */
178 /* KVM_EXIT_HYPERCALL */
186 /* Fix the size of the union. */
191 /* for KVM_GET_REGS and KVM_SET_REGS */
193 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
194 __u64 rax, rbx, rcx, rdx;
195 __u64 rsi, rdi, rsp, rbp;
196 __u64 r8, r9, r10, r11;
197 __u64 r12, r13, r14, r15;
201 /* for KVM_GET_FPU and KVM_SET_FPU */
206 __u8 ftwx; /* in fxsave format */
216 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
217 #define KVM_APIC_REG_SIZE 0x400
218 struct kvm_lapic_state {
219 char regs[KVM_APIC_REG_SIZE];
227 __u8 present, dpl, db, s, l, g, avl;
238 /* for KVM_GET_SREGS and KVM_SET_SREGS */
240 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
241 struct kvm_segment cs, ds, es, fs, gs, ss;
242 struct kvm_segment tr, ldt;
243 struct kvm_dtable gdt, idt;
244 __u64 cr0, cr2, cr3, cr4, cr8;
247 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
250 struct kvm_msr_entry {
256 /* for KVM_GET_MSRS and KVM_SET_MSRS */
258 __u32 nmsrs; /* number of msrs in entries */
261 struct kvm_msr_entry entries[0];
264 /* for KVM_GET_MSR_INDEX_LIST */
265 struct kvm_msr_list {
266 __u32 nmsrs; /* number of msrs in entries */
270 /* for KVM_TRANSLATE */
271 struct kvm_translation {
273 __u64 linear_address;
276 __u64 physical_address;
283 /* for KVM_INTERRUPT */
284 struct kvm_interrupt {
289 struct kvm_breakpoint {
295 /* for KVM_DEBUG_GUEST */
296 struct kvm_debug_guest {
300 struct kvm_breakpoint breakpoints[4];
304 /* for KVM_GET_DIRTY_LOG */
305 struct kvm_dirty_log {
309 void __user *dirty_bitmap; /* one bit per page */
314 struct kvm_cpuid_entry {
323 /* for KVM_SET_CPUID */
327 struct kvm_cpuid_entry entries[0];
330 /* for KVM_SET_SIGNAL_MASK */
331 struct kvm_signal_mask {
339 * ioctls for /dev/kvm fds:
341 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
342 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
343 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
345 * Check if a kvm extension is available. Argument is extension number,
346 * return is 1 (yes) or 0 (no, sorry).
348 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
350 * Get size for mmap(vcpu_fd)
352 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
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
366 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
367 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
368 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
369 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
370 struct kvm_userspace_memory_region)
371 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
373 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
376 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
377 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
378 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
379 /* Device model IOC */
380 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
381 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
382 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
383 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
386 * ioctls for vcpu fds
388 #define KVM_RUN _IO(KVMIO, 0x80)
389 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
390 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
391 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
392 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
393 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
394 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
395 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
396 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
397 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
398 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
399 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
400 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
401 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
402 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
403 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)