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_memory_region::flags */
27 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
29 struct kvm_memory_alias {
30 __u32 slot; /* this has a different namespace than memory slots */
32 __u64 guest_phys_addr;
34 __u64 target_phys_addr;
37 /* for KVM_IRQ_LINE */
38 struct kvm_irq_level {
40 * ACPI gsi notion of irq.
41 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
42 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
48 enum kvm_exit_reason {
50 KVM_EXIT_EXCEPTION = 1,
52 KVM_EXIT_HYPERCALL = 3,
56 KVM_EXIT_IRQ_WINDOW_OPEN = 7,
57 KVM_EXIT_SHUTDOWN = 8,
58 KVM_EXIT_FAIL_ENTRY = 9,
63 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
66 __u8 request_interrupt_window;
71 __u8 ready_for_interrupt_injection;
75 /* in (pre_kvm_run), out (post_kvm_run) */
80 /* KVM_EXIT_UNKNOWN */
82 __u64 hardware_exit_reason;
84 /* KVM_EXIT_FAIL_ENTRY */
86 __u64 hardware_entry_failure_reason;
88 /* KVM_EXIT_EXCEPTION */
95 #define KVM_EXIT_IO_IN 0
96 #define KVM_EXIT_IO_OUT 1
98 __u8 size; /* bytes */
101 __u64 data_offset; /* relative to kvm_run start */
112 /* KVM_EXIT_HYPERCALL */
120 /* Fix the size of the union. */
125 /* for KVM_GET_REGS and KVM_SET_REGS */
127 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
128 __u64 rax, rbx, rcx, rdx;
129 __u64 rsi, rdi, rsp, rbp;
130 __u64 r8, r9, r10, r11;
131 __u64 r12, r13, r14, r15;
135 /* for KVM_GET_FPU and KVM_SET_FPU */
140 __u8 ftwx; /* in fxsave format */
155 __u8 present, dpl, db, s, l, g, avl;
166 /* for KVM_GET_SREGS and KVM_SET_SREGS */
168 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
169 struct kvm_segment cs, ds, es, fs, gs, ss;
170 struct kvm_segment tr, ldt;
171 struct kvm_dtable gdt, idt;
172 __u64 cr0, cr2, cr3, cr4, cr8;
175 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
178 struct kvm_msr_entry {
184 /* for KVM_GET_MSRS and KVM_SET_MSRS */
186 __u32 nmsrs; /* number of msrs in entries */
189 struct kvm_msr_entry entries[0];
192 /* for KVM_GET_MSR_INDEX_LIST */
193 struct kvm_msr_list {
194 __u32 nmsrs; /* number of msrs in entries */
198 /* for KVM_TRANSLATE */
199 struct kvm_translation {
201 __u64 linear_address;
204 __u64 physical_address;
211 /* for KVM_INTERRUPT */
212 struct kvm_interrupt {
217 struct kvm_breakpoint {
223 /* for KVM_DEBUG_GUEST */
224 struct kvm_debug_guest {
228 struct kvm_breakpoint breakpoints[4];
232 /* for KVM_GET_DIRTY_LOG */
233 struct kvm_dirty_log {
237 void __user *dirty_bitmap; /* one bit per page */
242 struct kvm_cpuid_entry {
251 /* for KVM_SET_CPUID */
255 struct kvm_cpuid_entry entries[0];
258 /* for KVM_SET_SIGNAL_MASK */
259 struct kvm_signal_mask {
267 * ioctls for /dev/kvm fds:
269 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
270 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
271 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
273 * Check if a kvm extension is available. Argument is extension number,
274 * return is 1 (yes) or 0 (no, sorry).
276 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
278 * Get size for mmap(vcpu_fd)
280 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
283 * Extension capability list.
285 #define KVM_CAP_IRQCHIP 0
290 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
292 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
295 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
296 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
297 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
298 /* Device model IOC */
299 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
300 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
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)