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/compiler.h>
12 #include <linux/ioctl.h>
15 #define KVM_API_VERSION 12
17 /* for KVM_TRACE_ENABLE */
18 struct kvm_user_trace_setup {
19 __u32 buf_size; /* sub_buffer size of each per-cpu */
20 __u32 buf_nr; /* the number of sub_buffers of each per-cpu */
23 /* for KVM_CREATE_MEMORY_REGION */
24 struct kvm_memory_region {
27 __u64 guest_phys_addr;
28 __u64 memory_size; /* bytes */
31 /* for KVM_SET_USER_MEMORY_REGION */
32 struct kvm_userspace_memory_region {
35 __u64 guest_phys_addr;
36 __u64 memory_size; /* bytes */
37 __u64 userspace_addr; /* start of the userspace allocated memory */
40 /* for kvm_memory_region::flags */
41 #define KVM_MEM_LOG_DIRTY_PAGES 1UL
44 /* for KVM_IRQ_LINE */
45 struct kvm_irq_level {
47 * ACPI gsi notion of irq.
48 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
49 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
60 char dummy[512]; /* reserving space */
62 struct kvm_pic_state pic;
64 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
65 struct kvm_ioapic_state ioapic;
70 #define KVM_EXIT_UNKNOWN 0
71 #define KVM_EXIT_EXCEPTION 1
73 #define KVM_EXIT_HYPERCALL 3
74 #define KVM_EXIT_DEBUG 4
75 #define KVM_EXIT_HLT 5
76 #define KVM_EXIT_MMIO 6
77 #define KVM_EXIT_IRQ_WINDOW_OPEN 7
78 #define KVM_EXIT_SHUTDOWN 8
79 #define KVM_EXIT_FAIL_ENTRY 9
80 #define KVM_EXIT_INTR 10
81 #define KVM_EXIT_SET_TPR 11
82 #define KVM_EXIT_TPR_ACCESS 12
83 #define KVM_EXIT_S390_SIEIC 13
84 #define KVM_EXIT_S390_RESET 14
86 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
89 __u8 request_interrupt_window;
94 __u8 ready_for_interrupt_injection;
98 /* in (pre_kvm_run), out (post_kvm_run) */
103 /* KVM_EXIT_UNKNOWN */
105 __u64 hardware_exit_reason;
107 /* KVM_EXIT_FAIL_ENTRY */
109 __u64 hardware_entry_failure_reason;
111 /* KVM_EXIT_EXCEPTION */
118 #define KVM_EXIT_IO_IN 0
119 #define KVM_EXIT_IO_OUT 1
121 __u8 size; /* bytes */
124 __u64 data_offset; /* relative to kvm_run start */
135 /* KVM_EXIT_HYPERCALL */
143 /* KVM_EXIT_TPR_ACCESS */
149 /* KVM_EXIT_S390_SIEIC */
152 __u64 mask; /* psw upper half */
153 __u64 addr; /* psw lower half */
157 /* KVM_EXIT_S390_RESET */
158 #define KVM_S390_RESET_POR 1
159 #define KVM_S390_RESET_CLEAR 2
160 #define KVM_S390_RESET_SUBSYSTEM 4
161 #define KVM_S390_RESET_CPU_INIT 8
162 #define KVM_S390_RESET_IPL 16
163 __u64 s390_reset_flags;
164 /* Fix the size of the union. */
169 /* for KVM_TRANSLATE */
170 struct kvm_translation {
172 __u64 linear_address;
175 __u64 physical_address;
182 /* for KVM_INTERRUPT */
183 struct kvm_interrupt {
188 struct kvm_breakpoint {
194 /* for KVM_DEBUG_GUEST */
195 struct kvm_debug_guest {
199 struct kvm_breakpoint breakpoints[4];
203 /* for KVM_GET_DIRTY_LOG */
204 struct kvm_dirty_log {
208 void __user *dirty_bitmap; /* one bit per page */
213 /* for KVM_SET_SIGNAL_MASK */
214 struct kvm_signal_mask {
219 /* for KVM_TPR_ACCESS_REPORTING */
220 struct kvm_tpr_access_ctl {
226 /* for KVM_SET_VAPIC_ADDR */
227 struct kvm_vapic_addr {
231 struct kvm_s390_psw {
236 /* valid values for type in kvm_s390_interrupt */
237 #define KVM_S390_SIGP_STOP 0xfffe0000u
238 #define KVM_S390_PROGRAM_INT 0xfffe0001u
239 #define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
240 #define KVM_S390_RESTART 0xfffe0003u
241 #define KVM_S390_INT_VIRTIO 0xffff2603u
242 #define KVM_S390_INT_SERVICE 0xffff2401u
243 #define KVM_S390_INT_EMERGENCY 0xffff1201u
245 struct kvm_s390_interrupt {
251 #define KVM_TRC_SHIFT 16
253 * kvm trace categories
255 #define KVM_TRC_ENTRYEXIT (1 << KVM_TRC_SHIFT)
256 #define KVM_TRC_HANDLER (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
261 #define KVM_TRC_VMENTRY (KVM_TRC_ENTRYEXIT + 0x01)
262 #define KVM_TRC_VMEXIT (KVM_TRC_ENTRYEXIT + 0x02)
263 #define KVM_TRC_PAGE_FAULT (KVM_TRC_HANDLER + 0x01)
265 #define KVM_TRC_HEAD_SIZE 12
266 #define KVM_TRC_CYCLE_SIZE 8
267 #define KVM_TRC_EXTRA_MAX 7
269 /* This structure represents a single trace buffer record. */
270 struct kvm_trace_rec {
278 __u32 cycle_lo, cycle_hi;
279 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
282 __u32 extra_u32[KVM_TRC_EXTRA_MAX];
290 * ioctls for /dev/kvm fds:
292 #define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
293 #define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
294 #define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
296 #define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
298 * Check if a kvm extension is available. Argument is extension number,
299 * return is 1 (yes) or 0 (no, sorry).
301 #define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
303 * Get size for mmap(vcpu_fd)
305 #define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
306 #define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
308 * ioctls for kvm trace
310 #define KVM_TRACE_ENABLE _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
311 #define KVM_TRACE_PAUSE _IO(KVMIO, 0x07)
312 #define KVM_TRACE_DISABLE _IO(KVMIO, 0x08)
314 * Extension capability list.
316 #define KVM_CAP_IRQCHIP 0
317 #define KVM_CAP_HLT 1
318 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
319 #define KVM_CAP_USER_MEMORY 3
320 #define KVM_CAP_SET_TSS_ADDR 4
321 #define KVM_CAP_VAPIC 6
322 #define KVM_CAP_EXT_CPUID 7
323 #define KVM_CAP_CLOCKSOURCE 8
324 #define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
325 #define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
326 #define KVM_CAP_PIT 11
327 #define KVM_CAP_NOP_IO_DELAY 12
328 #define KVM_CAP_PV_MMU 13
333 #define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
334 #define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
335 #define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
336 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
337 struct kvm_userspace_memory_region)
338 #define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
340 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
343 #define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
344 #define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
345 #define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
346 /* Device model IOC */
347 #define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
348 #define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
349 #define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
350 #define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
351 #define KVM_CREATE_PIT _IO(KVMIO, 0x64)
352 #define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
353 #define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
356 * ioctls for vcpu fds
358 #define KVM_RUN _IO(KVMIO, 0x80)
359 #define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
360 #define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
361 #define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
362 #define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
363 #define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
364 #define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
365 #define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
366 #define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
367 #define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
368 #define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
369 #define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
370 #define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
371 #define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
372 #define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
373 #define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
374 #define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
375 #define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
376 /* Available with KVM_CAP_VAPIC */
377 #define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
378 /* Available with KVM_CAP_VAPIC */
379 #define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
380 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
381 #define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
382 /* store status for s390 */
383 #define KVM_S390_STORE_STATUS_NOADDR (-1ul)
384 #define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
385 #define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
386 /* initial ipl psw for s390 */
387 #define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
388 /* initial reset for s390 */
389 #define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)