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
16 * Architectural interrupt line count, and the size of the bitmap needed
19 #define KVM_NR_INTERRUPTS 256
20 #define KVM_IRQ_BITMAP_SIZE_BYTES ((KVM_NR_INTERRUPTS + 7) / 8)
21 #define KVM_IRQ_BITMAP_SIZE(type) (KVM_IRQ_BITMAP_SIZE_BYTES / sizeof(type))
24 /* for KVM_CREATE_MEMORY_REGION */
25 struct kvm_memory_region {
28 __u64 guest_phys_addr;
29 __u64 memory_size; /* bytes */
32 /* for kvm_memory_region::flags */
33 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
35 struct kvm_memory_alias {
36 __u32 slot; /* this has a different namespace than memory slots */
38 __u64 guest_phys_addr;
40 __u64 target_phys_addr;
43 enum kvm_exit_reason {
45 KVM_EXIT_EXCEPTION = 1,
47 KVM_EXIT_HYPERCALL = 3,
51 KVM_EXIT_IRQ_WINDOW_OPEN = 7,
52 KVM_EXIT_SHUTDOWN = 8,
53 KVM_EXIT_FAIL_ENTRY = 9,
57 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
60 __u8 request_interrupt_window;
65 __u8 ready_for_interrupt_injection;
69 /* in (pre_kvm_run), out (post_kvm_run) */
74 /* KVM_EXIT_UNKNOWN */
76 __u64 hardware_exit_reason;
78 /* KVM_EXIT_FAIL_ENTRY */
80 __u64 hardware_entry_failure_reason;
82 /* KVM_EXIT_EXCEPTION */
89 #define KVM_EXIT_IO_IN 0
90 #define KVM_EXIT_IO_OUT 1
92 __u8 size; /* bytes */
95 __u64 data_offset; /* relative to kvm_run start */
106 /* KVM_EXIT_HYPERCALL */
113 /* Fix the size of the union. */
118 /* for KVM_GET_REGS and KVM_SET_REGS */
120 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
121 __u64 rax, rbx, rcx, rdx;
122 __u64 rsi, rdi, rsp, rbp;
123 __u64 r8, r9, r10, r11;
124 __u64 r12, r13, r14, r15;
128 /* for KVM_GET_FPU and KVM_SET_FPU */
133 __u8 ftwx; /* in fxsave format */
148 __u8 present, dpl, db, s, l, g, avl;
159 /* for KVM_GET_SREGS and KVM_SET_SREGS */
161 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
162 struct kvm_segment cs, ds, es, fs, gs, ss;
163 struct kvm_segment tr, ldt;
164 struct kvm_dtable gdt, idt;
165 __u64 cr0, cr2, cr3, cr4, cr8;
168 __u64 interrupt_bitmap[KVM_IRQ_BITMAP_SIZE(__u64)];
171 struct kvm_msr_entry {
177 /* for KVM_GET_MSRS and KVM_SET_MSRS */
179 __u32 nmsrs; /* number of msrs in entries */
182 struct kvm_msr_entry entries[0];
185 /* for KVM_GET_MSR_INDEX_LIST */
186 struct kvm_msr_list {
187 __u32 nmsrs; /* number of msrs in entries */
191 /* for KVM_TRANSLATE */
192 struct kvm_translation {
194 __u64 linear_address;
197 __u64 physical_address;
204 /* for KVM_INTERRUPT */
205 struct kvm_interrupt {
210 struct kvm_breakpoint {
216 /* for KVM_DEBUG_GUEST */
217 struct kvm_debug_guest {
221 struct kvm_breakpoint breakpoints[4];
225 /* for KVM_GET_DIRTY_LOG */
226 struct kvm_dirty_log {
230 void __user *dirty_bitmap; /* one bit per page */
235 struct kvm_cpuid_entry {
244 /* for KVM_SET_CPUID */
248 struct kvm_cpuid_entry entries[0];
251 /* for KVM_SET_SIGNAL_MASK */
252 struct kvm_signal_mask {
260 * ioctls for /dev/kvm fds:
262 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
263 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
264 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
266 * Check if a kvm extension is available. Argument is extension number,
267 * return is 1 (yes) or 0 (no, sorry).
269 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
271 * Get size for mmap(vcpu_fd)
273 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
278 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
280 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
283 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
284 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
285 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
288 * ioctls for vcpu fds
290 #define KVM_RUN _IO(KVMIO, 0x80)
291 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
292 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
293 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
294 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
295 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
296 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
297 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
298 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
299 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
300 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
301 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
302 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
303 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)