blob: b751552f2e302206f3e32b88acf65c8ddab960c6 [file] [log] [blame]
Avi Kivity6aa8b732006-12-10 02:21:36 -08001#ifndef __LINUX_KVM_H
2#define __LINUX_KVM_H
3
4/*
5 * Userspace interface for /dev/kvm - kernel based virtual machine
6 *
Rusty Russelldea8cae2007-07-17 23:12:26 +10007 * Note: you must update KVM_API_VERSION if you change this interface.
Avi Kivity6aa8b732006-12-10 02:21:36 -08008 */
9
10#include <asm/types.h>
11#include <linux/ioctl.h>
Jerone Youngf6a40e32007-11-19 17:06:31 -060012#include <asm/kvm.h>
Avi Kivity6aa8b732006-12-10 02:21:36 -080013
Avi Kivity2ff81f72007-04-29 16:25:49 +030014#define KVM_API_VERSION 12
Avi Kivity0b76e202006-12-22 01:06:02 -080015
Avi Kivity6aa8b732006-12-10 02:21:36 -080016/* for KVM_CREATE_MEMORY_REGION */
17struct kvm_memory_region {
18 __u32 slot;
19 __u32 flags;
20 __u64 guest_phys_addr;
21 __u64 memory_size; /* bytes */
22};
23
Izik Eidus6fc138d2007-10-09 19:20:39 +020024/* for KVM_SET_USER_MEMORY_REGION */
25struct kvm_userspace_memory_region {
26 __u32 slot;
27 __u32 flags;
28 __u64 guest_phys_addr;
29 __u64 memory_size; /* bytes */
30 __u64 userspace_addr; /* start of the userspace allocated memory */
31};
32
Avi Kivity6aa8b732006-12-10 02:21:36 -080033/* for kvm_memory_region::flags */
34#define KVM_MEM_LOG_DIRTY_PAGES 1UL
35
36
Eddie Dong97222cc2007-09-12 10:58:04 +030037/* for KVM_IRQ_LINE */
Eddie Dong85f455f2007-07-06 12:20:49 +030038struct kvm_irq_level {
39 /*
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..
43 */
44 __u32 irq;
45 __u32 level;
46};
47
He, Qing6ceb9d72007-07-26 11:05:18 +030048
49struct kvm_irqchip {
50 __u32 chip_id;
51 __u32 pad;
52 union {
53 char dummy[512]; /* reserving space */
54 struct kvm_pic_state pic;
He, Qing6bf9e962007-08-05 10:49:16 +030055 struct kvm_ioapic_state ioapic;
He, Qing6ceb9d72007-07-26 11:05:18 +030056 } chip;
57};
58
Avi Kivity8a454502007-10-10 14:03:16 +020059#define KVM_EXIT_UNKNOWN 0
60#define KVM_EXIT_EXCEPTION 1
61#define KVM_EXIT_IO 2
62#define KVM_EXIT_HYPERCALL 3
63#define KVM_EXIT_DEBUG 4
64#define KVM_EXIT_HLT 5
65#define KVM_EXIT_MMIO 6
66#define KVM_EXIT_IRQ_WINDOW_OPEN 7
67#define KVM_EXIT_SHUTDOWN 8
68#define KVM_EXIT_FAIL_ENTRY 9
69#define KVM_EXIT_INTR 10
70#define KVM_EXIT_SET_TPR 11
Avi Kivity6aa8b732006-12-10 02:21:36 -080071
Avi Kivity9a2bb7f2007-02-22 12:58:31 +020072/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
Avi Kivity6aa8b732006-12-10 02:21:36 -080073struct kvm_run {
74 /* in */
Dor Laorc1150d82007-01-05 16:36:24 -080075 __u8 request_interrupt_window;
Avi Kivity02c83202007-04-29 15:02:17 +030076 __u8 padding1[7];
Avi Kivity6aa8b732006-12-10 02:21:36 -080077
78 /* out */
Avi Kivity6aa8b732006-12-10 02:21:36 -080079 __u32 exit_reason;
Dor Laorc1150d82007-01-05 16:36:24 -080080 __u8 ready_for_interrupt_injection;
81 __u8 if_flag;
Avi Kivity2ff81f72007-04-29 16:25:49 +030082 __u8 padding2[2];
Dor Laor54810342007-02-12 00:54:39 -080083
84 /* in (pre_kvm_run), out (post_kvm_run) */
Dor Laorc1150d82007-01-05 16:36:24 -080085 __u64 cr8;
86 __u64 apic_base;
87
Avi Kivity6aa8b732006-12-10 02:21:36 -080088 union {
89 /* KVM_EXIT_UNKNOWN */
90 struct {
Avi Kivity8eb7d332007-03-04 14:17:08 +020091 __u64 hardware_exit_reason;
Avi Kivity6aa8b732006-12-10 02:21:36 -080092 } hw;
Avi Kivity8eb7d332007-03-04 14:17:08 +020093 /* KVM_EXIT_FAIL_ENTRY */
94 struct {
95 __u64 hardware_entry_failure_reason;
96 } fail_entry;
Avi Kivity6aa8b732006-12-10 02:21:36 -080097 /* KVM_EXIT_EXCEPTION */
98 struct {
99 __u32 exception;
100 __u32 error_code;
101 } ex;
102 /* KVM_EXIT_IO */
Avi Kivity46fc1472007-02-22 19:39:30 +0200103 struct kvm_io {
Avi Kivity6aa8b732006-12-10 02:21:36 -0800104#define KVM_EXIT_IO_IN 0
105#define KVM_EXIT_IO_OUT 1
106 __u8 direction;
107 __u8 size; /* bytes */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800108 __u16 port;
Avi Kivity039576c2007-03-20 12:46:50 +0200109 __u32 count;
110 __u64 data_offset; /* relative to kvm_run start */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800111 } io;
112 struct {
113 } debug;
114 /* KVM_EXIT_MMIO */
115 struct {
116 __u64 phys_addr;
117 __u8 data[8];
118 __u32 len;
119 __u8 is_write;
120 } mmio;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200121 /* KVM_EXIT_HYPERCALL */
122 struct {
Jeff Dike519ef352007-07-16 15:24:47 -0400123 __u64 nr;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200124 __u64 args[6];
125 __u64 ret;
126 __u32 longmode;
127 __u32 pad;
128 } hypercall;
Avi Kivity24cbc7e2007-07-17 11:45:55 +0300129 /* Fix the size of the union. */
130 char padding[256];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800131 };
132};
133
Avi Kivity6aa8b732006-12-10 02:21:36 -0800134
Avi Kivityb8836732007-04-01 16:34:31 +0300135/* for KVM_GET_FPU and KVM_SET_FPU */
136struct kvm_fpu {
137 __u8 fpr[8][16];
138 __u16 fcw;
139 __u16 fsw;
140 __u8 ftwx; /* in fxsave format */
141 __u8 pad1;
142 __u16 last_opcode;
143 __u64 last_ip;
144 __u64 last_dp;
145 __u8 xmm[16][16];
146 __u32 mxcsr;
147 __u32 pad2;
148};
149
Eddie Dong96ad2cc2007-09-06 12:22:56 +0300150
Avi Kivity6aa8b732006-12-10 02:21:36 -0800151/* for KVM_TRANSLATE */
152struct kvm_translation {
153 /* in */
154 __u64 linear_address;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800155
156 /* out */
157 __u64 physical_address;
158 __u8 valid;
159 __u8 writeable;
160 __u8 usermode;
Avi Kivity8cd13302007-02-12 00:54:41 -0800161 __u8 pad[5];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800162};
163
164/* for KVM_INTERRUPT */
165struct kvm_interrupt {
166 /* in */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800167 __u32 irq;
168};
169
170struct kvm_breakpoint {
171 __u32 enabled;
172 __u32 padding;
173 __u64 address;
174};
175
176/* for KVM_DEBUG_GUEST */
177struct kvm_debug_guest {
178 /* int */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800179 __u32 enabled;
Avi Kivitybccf2152007-02-21 18:04:26 +0200180 __u32 pad;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800181 struct kvm_breakpoint breakpoints[4];
182 __u32 singlestep;
183};
184
185/* for KVM_GET_DIRTY_LOG */
186struct kvm_dirty_log {
187 __u32 slot;
188 __u32 padding;
189 union {
190 void __user *dirty_bitmap; /* one bit per page */
191 __u64 padding;
192 };
193};
194
Avi Kivity1961d272007-03-05 19:46:05 +0200195/* for KVM_SET_SIGNAL_MASK */
196struct kvm_signal_mask {
197 __u32 len;
198 __u8 sigset[0];
199};
200
Avi Kivity6aa8b732006-12-10 02:21:36 -0800201#define KVMIO 0xAE
202
Avi Kivityf17abe92007-02-21 19:28:04 +0200203/*
204 * ioctls for /dev/kvm fds:
205 */
Avi Kivity739872c2007-03-01 17:20:13 +0200206#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
207#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
208#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
Avi Kivity5d308f42007-03-01 17:56:20 +0200209/*
210 * Check if a kvm extension is available. Argument is extension number,
211 * return is 1 (yes) or 0 (no, sorry).
212 */
213#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
Avi Kivity07c45a32007-03-07 13:05:38 +0200214/*
215 * Get size for mmap(vcpu_fd)
216 */
217#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
Avi Kivityf17abe92007-02-21 19:28:04 +0200218
219/*
Eddie Dong85f455f2007-07-06 12:20:49 +0300220 * Extension capability list.
221 */
222#define KVM_CAP_IRQCHIP 0
Eddie Dongb6958ce2007-07-18 12:15:21 +0300223#define KVM_CAP_HLT 1
Izik Eidus82ce2c92007-10-02 18:52:55 +0200224#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
Izik Eidus6fc138d2007-10-09 19:20:39 +0200225#define KVM_CAP_USER_MEMORY 3
Izik Eiduscbc94022007-10-25 00:29:55 +0200226#define KVM_CAP_SET_TSS_ADDR 4
Dan Kenigsberg07716712007-11-21 17:10:04 +0200227#define KVM_CAP_EXT_CPUID 5
Eddie Dong85f455f2007-07-06 12:20:49 +0300228
229/*
Avi Kivityf17abe92007-02-21 19:28:04 +0200230 * ioctls for VM fds
231 */
Avi Kivity739872c2007-03-01 17:20:13 +0200232#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
Izik Eidus82ce2c92007-10-02 18:52:55 +0200233#define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
234#define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
Izik Eidus6fc138d2007-10-09 19:20:39 +0200235#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
236 struct kvm_userspace_memory_region)
Izik Eiduscbc94022007-10-25 00:29:55 +0200237#define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
Avi Kivitybccf2152007-02-21 18:04:26 +0200238/*
239 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
240 * a vcpu fd.
241 */
Avi Kivity739872c2007-03-01 17:20:13 +0200242#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
243#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
Avi Kivitye8207542007-03-30 16:54:30 +0300244#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
Dan Kenigsberg07716712007-11-21 17:10:04 +0200245#define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x48, struct kvm_cpuid2)
Eddie Dong85f455f2007-07-06 12:20:49 +0300246/* Device model IOC */
247#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
Eddie Dong97222cc2007-09-12 10:58:04 +0300248#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
He, Qing6ceb9d72007-07-26 11:05:18 +0300249#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
250#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
Avi Kivitybccf2152007-02-21 18:04:26 +0200251
252/*
253 * ioctls for vcpu fds
254 */
Avi Kivity739872c2007-03-01 17:20:13 +0200255#define KVM_RUN _IO(KVMIO, 0x80)
256#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
257#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
258#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
259#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
260#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
261#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
262#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
263#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
264#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
265#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
Avi Kivity1961d272007-03-05 19:46:05 +0200266#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
Avi Kivityb8836732007-04-01 16:34:31 +0300267#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
268#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
Eddie Dong96ad2cc2007-09-06 12:22:56 +0300269#define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
270#define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
Dan Kenigsberg07716712007-11-21 17:10:04 +0200271#define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
272#define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
Avi Kivity6aa8b732006-12-10 02:21:36 -0800273
274#endif