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. */
137 /* for KVM_GET_REGS and KVM_SET_REGS */
139 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
140 __u64 rax, rbx, rcx, rdx;
141 __u64 rsi, rdi, rsp, rbp;
142 __u64 r8, r9, r10, r11;
143 __u64 r12, r13, r14, r15;
147 /* for KVM_GET_FPU and KVM_SET_FPU */
152 __u8 ftwx; /* in fxsave format */
162 /* for KVM_GET_LAPIC and KVM_SET_LAPIC */
163 #define KVM_APIC_REG_SIZE 0x400
164 struct kvm_lapic_state {
165 char regs[KVM_APIC_REG_SIZE];
173 __u8 present, dpl, db, s, l, g, avl;
184 /* for KVM_GET_SREGS and KVM_SET_SREGS */
186 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
187 struct kvm_segment cs, ds, es, fs, gs, ss;
188 struct kvm_segment tr, ldt;
189 struct kvm_dtable gdt, idt;
190 __u64 cr0, cr2, cr3, cr4, cr8;
193 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
196 struct kvm_msr_entry {
202 /* for KVM_GET_MSRS and KVM_SET_MSRS */
204 __u32 nmsrs; /* number of msrs in entries */
207 struct kvm_msr_entry entries[0];
210 /* for KVM_GET_MSR_INDEX_LIST */
211 struct kvm_msr_list {
212 __u32 nmsrs; /* number of msrs in entries */
216 /* for KVM_TRANSLATE */
217 struct kvm_translation {
219 __u64 linear_address;
222 __u64 physical_address;
229 /* for KVM_INTERRUPT */
230 struct kvm_interrupt {
235 struct kvm_breakpoint {
241 /* for KVM_DEBUG_GUEST */
242 struct kvm_debug_guest {
246 struct kvm_breakpoint breakpoints[4];
250 /* for KVM_GET_DIRTY_LOG */
251 struct kvm_dirty_log {
255 void __user *dirty_bitmap; /* one bit per page */
260 struct kvm_cpuid_entry {
269 /* for KVM_SET_CPUID */
273 struct kvm_cpuid_entry entries[0];
276 /* for KVM_SET_SIGNAL_MASK */
277 struct kvm_signal_mask {
285 * ioctls for /dev/kvm fds:
287 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
288 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
289 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
291 * Check if a kvm extension is available. Argument is extension number,
292 * return is 1 (yes) or 0 (no, sorry).
294 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
296 * Get size for mmap(vcpu_fd)
298 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
301 * Extension capability list.
303 #define KVM_CAP_IRQCHIP 0
304 #define KVM_CAP_HLT 1
305 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
306 #define KVM_CAP_USER_MEMORY 3
307 #define KVM_CAP_SET_TSS_ADDR 4
312 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
313 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
314 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
315 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
316 struct kvm_userspace_memory_region)
317 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
319 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
322 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
323 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
324 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
325 /* Device model IOC */
326 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
327 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
328 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
329 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
332 * ioctls for vcpu fds
334 #define KVM_RUN _IO(KVMIO, 0x80)
335 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
336 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
337 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
338 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
339 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
340 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
341 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
342 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
343 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
344 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
345 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
346 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
347 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
348 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
349 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)