5 * Userspace interface for /dev/kvm - kernel based virtual machine
7 * Note: this interface is considered experimental and may change without
11 #include <asm/types.h>
12 #include <linux/ioctl.h>
14 #define KVM_API_VERSION 12
17 * Architectural interrupt line count, and the size of the bitmap needed
20 #define KVM_NR_INTERRUPTS 256
21 #define KVM_IRQ_BITMAP_SIZE_BYTES ((KVM_NR_INTERRUPTS + 7) / 8)
22 #define KVM_IRQ_BITMAP_SIZE(type) (KVM_IRQ_BITMAP_SIZE_BYTES / sizeof(type))
25 /* for KVM_CREATE_MEMORY_REGION */
26 struct kvm_memory_region {
29 __u64 guest_phys_addr;
30 __u64 memory_size; /* bytes */
33 /* for kvm_memory_region::flags */
34 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
36 struct kvm_memory_alias {
37 __u32 slot; /* this has a different namespace than memory slots */
39 __u64 guest_phys_addr;
41 __u64 target_phys_addr;
44 enum kvm_exit_reason {
46 KVM_EXIT_EXCEPTION = 1,
48 KVM_EXIT_HYPERCALL = 3,
52 KVM_EXIT_IRQ_WINDOW_OPEN = 7,
53 KVM_EXIT_SHUTDOWN = 8,
54 KVM_EXIT_FAIL_ENTRY = 9,
58 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
61 __u8 request_interrupt_window;
66 __u8 ready_for_interrupt_injection;
70 /* in (pre_kvm_run), out (post_kvm_run) */
75 /* KVM_EXIT_UNKNOWN */
77 __u64 hardware_exit_reason;
79 /* KVM_EXIT_FAIL_ENTRY */
81 __u64 hardware_entry_failure_reason;
83 /* KVM_EXIT_EXCEPTION */
90 #define KVM_EXIT_IO_IN 0
91 #define KVM_EXIT_IO_OUT 1
93 __u8 size; /* bytes */
96 __u64 data_offset; /* relative to kvm_run start */
107 /* KVM_EXIT_HYPERCALL */
114 /* Fix the size of the union. */
119 /* for KVM_GET_REGS and KVM_SET_REGS */
121 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
122 __u64 rax, rbx, rcx, rdx;
123 __u64 rsi, rdi, rsp, rbp;
124 __u64 r8, r9, r10, r11;
125 __u64 r12, r13, r14, r15;
129 /* for KVM_GET_FPU and KVM_SET_FPU */
134 __u8 ftwx; /* in fxsave format */
149 __u8 present, dpl, db, s, l, g, avl;
160 /* for KVM_GET_SREGS and KVM_SET_SREGS */
162 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
163 struct kvm_segment cs, ds, es, fs, gs, ss;
164 struct kvm_segment tr, ldt;
165 struct kvm_dtable gdt, idt;
166 __u64 cr0, cr2, cr3, cr4, cr8;
169 __u64 interrupt_bitmap[KVM_IRQ_BITMAP_SIZE(__u64)];
172 struct kvm_msr_entry {
178 /* for KVM_GET_MSRS and KVM_SET_MSRS */
180 __u32 nmsrs; /* number of msrs in entries */
183 struct kvm_msr_entry entries[0];
186 /* for KVM_GET_MSR_INDEX_LIST */
187 struct kvm_msr_list {
188 __u32 nmsrs; /* number of msrs in entries */
192 /* for KVM_TRANSLATE */
193 struct kvm_translation {
195 __u64 linear_address;
198 __u64 physical_address;
205 /* for KVM_INTERRUPT */
206 struct kvm_interrupt {
211 struct kvm_breakpoint {
217 /* for KVM_DEBUG_GUEST */
218 struct kvm_debug_guest {
222 struct kvm_breakpoint breakpoints[4];
226 /* for KVM_GET_DIRTY_LOG */
227 struct kvm_dirty_log {
231 void __user *dirty_bitmap; /* one bit per page */
236 struct kvm_cpuid_entry {
245 /* for KVM_SET_CPUID */
249 struct kvm_cpuid_entry entries[0];
252 /* for KVM_SET_SIGNAL_MASK */
253 struct kvm_signal_mask {
261 * ioctls for /dev/kvm fds:
263 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
264 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
265 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
267 * Check if a kvm extension is available. Argument is extension number,
268 * return is 1 (yes) or 0 (no, sorry).
270 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
272 * Get size for mmap(vcpu_fd)
274 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
279 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
281 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
284 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
285 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
286 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
289 * ioctls for vcpu fds
291 #define KVM_RUN _IO(KVMIO, 0x80)
292 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
293 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
294 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
295 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
296 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
297 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
298 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
299 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
300 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
301 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
302 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
303 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
304 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)