KVM: local APIC TPR access reporting facility
[linux-2.6.git] / include / linux / kvm.h
1 #ifndef __LINUX_KVM_H
2 #define __LINUX_KVM_H
3
4 /*
5  * Userspace interface for /dev/kvm - kernel based virtual machine
6  *
7  * Note: you must update KVM_API_VERSION if you change this interface.
8  */
9
10 #include <asm/types.h>
11 #include <linux/ioctl.h>
12 #include <asm/kvm.h>
13
14 #define KVM_API_VERSION 12
15
16 /* for KVM_CREATE_MEMORY_REGION */
17 struct kvm_memory_region {
18         __u32 slot;
19         __u32 flags;
20         __u64 guest_phys_addr;
21         __u64 memory_size; /* bytes */
22 };
23
24 /* for KVM_SET_USER_MEMORY_REGION */
25 struct 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
33 /* for kvm_memory_region::flags */
34 #define KVM_MEM_LOG_DIRTY_PAGES  1UL
35
36
37 /* for KVM_IRQ_LINE */
38 struct 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
48
49 struct kvm_irqchip {
50         __u32 chip_id;
51         __u32 pad;
52         union {
53                 char dummy[512];  /* reserving space */
54 #ifdef CONFIG_X86
55                 struct kvm_pic_state pic;
56 #endif
57 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
58                 struct kvm_ioapic_state ioapic;
59 #endif
60         } chip;
61 };
62
63 #define KVM_EXIT_UNKNOWN          0
64 #define KVM_EXIT_EXCEPTION        1
65 #define KVM_EXIT_IO               2
66 #define KVM_EXIT_HYPERCALL        3
67 #define KVM_EXIT_DEBUG            4
68 #define KVM_EXIT_HLT              5
69 #define KVM_EXIT_MMIO             6
70 #define KVM_EXIT_IRQ_WINDOW_OPEN  7
71 #define KVM_EXIT_SHUTDOWN         8
72 #define KVM_EXIT_FAIL_ENTRY       9
73 #define KVM_EXIT_INTR             10
74 #define KVM_EXIT_SET_TPR          11
75 #define KVM_EXIT_TPR_ACCESS       12
76
77 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
78 struct kvm_run {
79         /* in */
80         __u8 request_interrupt_window;
81         __u8 padding1[7];
82
83         /* out */
84         __u32 exit_reason;
85         __u8 ready_for_interrupt_injection;
86         __u8 if_flag;
87         __u8 padding2[2];
88
89         /* in (pre_kvm_run), out (post_kvm_run) */
90         __u64 cr8;
91         __u64 apic_base;
92
93         union {
94                 /* KVM_EXIT_UNKNOWN */
95                 struct {
96                         __u64 hardware_exit_reason;
97                 } hw;
98                 /* KVM_EXIT_FAIL_ENTRY */
99                 struct {
100                         __u64 hardware_entry_failure_reason;
101                 } fail_entry;
102                 /* KVM_EXIT_EXCEPTION */
103                 struct {
104                         __u32 exception;
105                         __u32 error_code;
106                 } ex;
107                 /* KVM_EXIT_IO */
108                 struct kvm_io {
109 #define KVM_EXIT_IO_IN  0
110 #define KVM_EXIT_IO_OUT 1
111                         __u8 direction;
112                         __u8 size; /* bytes */
113                         __u16 port;
114                         __u32 count;
115                         __u64 data_offset; /* relative to kvm_run start */
116                 } io;
117                 struct {
118                 } debug;
119                 /* KVM_EXIT_MMIO */
120                 struct {
121                         __u64 phys_addr;
122                         __u8  data[8];
123                         __u32 len;
124                         __u8  is_write;
125                 } mmio;
126                 /* KVM_EXIT_HYPERCALL */
127                 struct {
128                         __u64 nr;
129                         __u64 args[6];
130                         __u64 ret;
131                         __u32 longmode;
132                         __u32 pad;
133                 } hypercall;
134                 /* KVM_EXIT_TPR_ACCESS */
135                 struct {
136                         __u64 rip;
137                         __u32 is_write;
138                         __u32 pad;
139                 } tpr_access;
140                 /* Fix the size of the union. */
141                 char padding[256];
142         };
143 };
144
145
146 /* for KVM_GET_FPU and KVM_SET_FPU */
147 struct kvm_fpu {
148         __u8  fpr[8][16];
149         __u16 fcw;
150         __u16 fsw;
151         __u8  ftwx;  /* in fxsave format */
152         __u8  pad1;
153         __u16 last_opcode;
154         __u64 last_ip;
155         __u64 last_dp;
156         __u8  xmm[16][16];
157         __u32 mxcsr;
158         __u32 pad2;
159 };
160
161
162 /* for KVM_TRANSLATE */
163 struct kvm_translation {
164         /* in */
165         __u64 linear_address;
166
167         /* out */
168         __u64 physical_address;
169         __u8  valid;
170         __u8  writeable;
171         __u8  usermode;
172         __u8  pad[5];
173 };
174
175 /* for KVM_INTERRUPT */
176 struct kvm_interrupt {
177         /* in */
178         __u32 irq;
179 };
180
181 struct kvm_breakpoint {
182         __u32 enabled;
183         __u32 padding;
184         __u64 address;
185 };
186
187 /* for KVM_DEBUG_GUEST */
188 struct kvm_debug_guest {
189         /* int */
190         __u32 enabled;
191         __u32 pad;
192         struct kvm_breakpoint breakpoints[4];
193         __u32 singlestep;
194 };
195
196 /* for KVM_GET_DIRTY_LOG */
197 struct kvm_dirty_log {
198         __u32 slot;
199         __u32 padding;
200         union {
201                 void __user *dirty_bitmap; /* one bit per page */
202                 __u64 padding;
203         };
204 };
205
206 /* for KVM_SET_SIGNAL_MASK */
207 struct kvm_signal_mask {
208         __u32 len;
209         __u8  sigset[0];
210 };
211
212 /* for KVM_TPR_ACCESS_REPORTING */
213 struct kvm_tpr_access_ctl {
214         __u32 enabled;
215         __u32 flags;
216         __u32 reserved[8];
217 };
218
219 #define KVMIO 0xAE
220
221 /*
222  * ioctls for /dev/kvm fds:
223  */
224 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
225 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
226 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
227 /*
228  * Check if a kvm extension is available.  Argument is extension number,
229  * return is 1 (yes) or 0 (no, sorry).
230  */
231 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
232 /*
233  * Get size for mmap(vcpu_fd)
234  */
235 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
236
237 /*
238  * Extension capability list.
239  */
240 #define KVM_CAP_IRQCHIP   0
241 #define KVM_CAP_HLT       1
242 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
243 #define KVM_CAP_USER_MEMORY 3
244 #define KVM_CAP_SET_TSS_ADDR 4
245 #define KVM_CAP_EXT_CPUID 5
246 #define KVM_CAP_VAPIC 6
247
248 /*
249  * ioctls for VM fds
250  */
251 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
252 #define KVM_SET_NR_MMU_PAGES      _IO(KVMIO, 0x44)
253 #define KVM_GET_NR_MMU_PAGES      _IO(KVMIO, 0x45)
254 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
255                                         struct kvm_userspace_memory_region)
256 #define KVM_SET_TSS_ADDR          _IO(KVMIO, 0x47)
257 /*
258  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
259  * a vcpu fd.
260  */
261 #define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
262 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
263 #define KVM_SET_MEMORY_ALIAS      _IOW(KVMIO, 0x43, struct kvm_memory_alias)
264 #define KVM_GET_SUPPORTED_CPUID   _IOWR(KVMIO, 0x48, struct kvm_cpuid2)
265 /* Device model IOC */
266 #define KVM_CREATE_IRQCHIP        _IO(KVMIO,  0x60)
267 #define KVM_IRQ_LINE              _IOW(KVMIO, 0x61, struct kvm_irq_level)
268 #define KVM_GET_IRQCHIP           _IOWR(KVMIO, 0x62, struct kvm_irqchip)
269 #define KVM_SET_IRQCHIP           _IOR(KVMIO,  0x63, struct kvm_irqchip)
270
271 /*
272  * ioctls for vcpu fds
273  */
274 #define KVM_RUN                   _IO(KVMIO,   0x80)
275 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
276 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
277 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
278 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
279 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
280 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
281 #define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
282 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
283 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
284 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
285 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
286 #define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
287 #define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
288 #define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
289 #define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
290 #define KVM_SET_CPUID2            _IOW(KVMIO,  0x90, struct kvm_cpuid2)
291 #define KVM_GET_CPUID2            _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
292 /* Available with KVM_CAP_VAPIC */
293 #define KVM_TPR_ACCESS_REPORTING  _IOWR(KVMIO,  0x92, struct kvm_tpr_access_ctl)
294
295 #endif