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>
14 #define KVM_API_VERSION 12
16 /* Architectural interrupt line count. */
17 #define KVM_NR_INTERRUPTS 256
19 /* for KVM_CREATE_MEMORY_REGION */
20 struct kvm_memory_region {
23 __u64 guest_phys_addr;
24 __u64 memory_size; /* bytes */
27 /* for KVM_SET_USER_MEMORY_REGION */
28 struct kvm_userspace_memory_region {
31 __u64 guest_phys_addr;
32 __u64 memory_size; /* bytes */
33 __u64 userspace_addr; /* start of the userspace allocated memory */
36 /* for kvm_memory_region::flags */
37 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
40 /* for KVM_IRQ_LINE */
41 struct kvm_irq_level {
43 * ACPI gsi notion of irq.
44 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
45 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
56 char dummy[512]; /* reserving space */
57 struct kvm_pic_state pic;
58 struct kvm_ioapic_state ioapic;
62 #define KVM_EXIT_UNKNOWN 0
63 #define KVM_EXIT_EXCEPTION 1
65 #define KVM_EXIT_HYPERCALL 3
66 #define KVM_EXIT_DEBUG 4
67 #define KVM_EXIT_HLT 5
68 #define KVM_EXIT_MMIO 6
69 #define KVM_EXIT_IRQ_WINDOW_OPEN 7
70 #define KVM_EXIT_SHUTDOWN 8
71 #define KVM_EXIT_FAIL_ENTRY 9
72 #define KVM_EXIT_INTR 10
73 #define KVM_EXIT_SET_TPR 11
75 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
78 __u8 request_interrupt_window;
83 __u8 ready_for_interrupt_injection;
87 /* in (pre_kvm_run), out (post_kvm_run) */
92 /* KVM_EXIT_UNKNOWN */
94 __u64 hardware_exit_reason;
96 /* KVM_EXIT_FAIL_ENTRY */
98 __u64 hardware_entry_failure_reason;
100 /* KVM_EXIT_EXCEPTION */
107 #define KVM_EXIT_IO_IN 0
108 #define KVM_EXIT_IO_OUT 1
110 __u8 size; /* bytes */
113 __u64 data_offset; /* relative to kvm_run start */
124 /* KVM_EXIT_HYPERCALL */
132 /* Fix the size of the union. */
138 /* for KVM_GET_FPU and KVM_SET_FPU */
143 __u8 ftwx; /* in fxsave format */
155 /* for KVM_GET_SREGS and KVM_SET_SREGS */
157 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
158 struct kvm_segment cs, ds, es, fs, gs, ss;
159 struct kvm_segment tr, ldt;
160 struct kvm_dtable gdt, idt;
161 __u64 cr0, cr2, cr3, cr4, cr8;
164 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
167 struct kvm_msr_entry {
173 /* for KVM_GET_MSRS and KVM_SET_MSRS */
175 __u32 nmsrs; /* number of msrs in entries */
178 struct kvm_msr_entry entries[0];
181 /* for KVM_GET_MSR_INDEX_LIST */
182 struct kvm_msr_list {
183 __u32 nmsrs; /* number of msrs in entries */
187 /* for KVM_TRANSLATE */
188 struct kvm_translation {
190 __u64 linear_address;
193 __u64 physical_address;
200 /* for KVM_INTERRUPT */
201 struct kvm_interrupt {
206 struct kvm_breakpoint {
212 /* for KVM_DEBUG_GUEST */
213 struct kvm_debug_guest {
217 struct kvm_breakpoint breakpoints[4];
221 /* for KVM_GET_DIRTY_LOG */
222 struct kvm_dirty_log {
226 void __user *dirty_bitmap; /* one bit per page */
231 struct kvm_cpuid_entry {
240 /* for KVM_SET_CPUID */
244 struct kvm_cpuid_entry entries[0];
247 /* for KVM_SET_SIGNAL_MASK */
248 struct kvm_signal_mask {
256 * ioctls for /dev/kvm fds:
258 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
259 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
260 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
262 * Check if a kvm extension is available. Argument is extension number,
263 * return is 1 (yes) or 0 (no, sorry).
265 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
267 * Get size for mmap(vcpu_fd)
269 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
272 * Extension capability list.
274 #define KVM_CAP_IRQCHIP 0
275 #define KVM_CAP_HLT 1
276 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
277 #define KVM_CAP_USER_MEMORY 3
278 #define KVM_CAP_SET_TSS_ADDR 4
283 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
284 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
285 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
286 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
287 struct kvm_userspace_memory_region)
288 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
290 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
293 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
294 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
295 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
296 /* Device model IOC */
297 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
298 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
299 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
300 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
303 * ioctls for vcpu fds
305 #define KVM_RUN _IO(KVMIO, 0x80)
306 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
307 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
308 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
309 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
310 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
311 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
312 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
313 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
314 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
315 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
316 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
317 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
318 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
319 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
320 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)