]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/linux/kvm.h
KVM: in-kernel IOAPIC save and restore support
[mirror_ubuntu-zesty-kernel.git] / include / linux / kvm.h
CommitLineData
6aa8b732
AK
1#ifndef __LINUX_KVM_H
2#define __LINUX_KVM_H
3
4/*
5 * Userspace interface for /dev/kvm - kernel based virtual machine
6 *
dea8caee 7 * Note: you must update KVM_API_VERSION if you change this interface.
6aa8b732
AK
8 */
9
10#include <asm/types.h>
11#include <linux/ioctl.h>
12
2ff81f70 13#define KVM_API_VERSION 12
0b76e20b 14
9eb829ce 15/* Architectural interrupt line count. */
6aa8b732 16#define KVM_NR_INTERRUPTS 256
6aa8b732
AK
17
18/* for KVM_CREATE_MEMORY_REGION */
19struct kvm_memory_region {
20 __u32 slot;
21 __u32 flags;
22 __u64 guest_phys_addr;
23 __u64 memory_size; /* bytes */
24};
25
26/* for kvm_memory_region::flags */
27#define KVM_MEM_LOG_DIRTY_PAGES 1UL
28
e8207547
AK
29struct kvm_memory_alias {
30 __u32 slot; /* this has a different namespace than memory slots */
31 __u32 flags;
32 __u64 guest_phys_addr;
33 __u64 memory_size;
34 __u64 target_phys_addr;
35};
6aa8b732 36
97222cc8 37/* for KVM_IRQ_LINE */
85f455f7
ED
38struct 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
6bf9e962 48/* for KVM_GET_IRQCHIP and KVM_SET_IRQCHIP */
6ceb9d79
HQ
49struct kvm_pic_state {
50 __u8 last_irr; /* edge detection */
51 __u8 irr; /* interrupt request register */
52 __u8 imr; /* interrupt mask register */
53 __u8 isr; /* interrupt service register */
54 __u8 priority_add; /* highest irq priority */
55 __u8 irq_base;
56 __u8 read_reg_select;
57 __u8 poll;
58 __u8 special_mask;
59 __u8 init_state;
60 __u8 auto_eoi;
61 __u8 rotate_on_auto_eoi;
62 __u8 special_fully_nested_mode;
63 __u8 init4; /* true if 4 byte init */
64 __u8 elcr; /* PIIX edge/trigger selection */
65 __u8 elcr_mask;
66};
67
6bf9e962
HQ
68#define KVM_IOAPIC_NUM_PINS 24
69struct kvm_ioapic_state {
70 __u64 base_address;
71 __u32 ioregsel;
72 __u32 id;
73 __u32 irr;
74 __u32 pad;
75 union {
76 __u64 bits;
77 struct {
78 __u8 vector;
79 __u8 delivery_mode:3;
80 __u8 dest_mode:1;
81 __u8 delivery_status:1;
82 __u8 polarity:1;
83 __u8 remote_irr:1;
84 __u8 trig_mode:1;
85 __u8 mask:1;
86 __u8 reserve:7;
87 __u8 reserved[4];
88 __u8 dest_id;
89 } fields;
90 } redirtbl[KVM_IOAPIC_NUM_PINS];
91};
92
6ceb9d79
HQ
93enum kvm_irqchip_id {
94 KVM_IRQCHIP_PIC_MASTER = 0,
95 KVM_IRQCHIP_PIC_SLAVE = 1,
6bf9e962 96 KVM_IRQCHIP_IOAPIC = 2,
6ceb9d79
HQ
97};
98
99struct kvm_irqchip {
100 __u32 chip_id;
101 __u32 pad;
102 union {
103 char dummy[512]; /* reserving space */
104 struct kvm_pic_state pic;
6bf9e962 105 struct kvm_ioapic_state ioapic;
6ceb9d79
HQ
106 } chip;
107};
108
6aa8b732
AK
109enum kvm_exit_reason {
110 KVM_EXIT_UNKNOWN = 0,
111 KVM_EXIT_EXCEPTION = 1,
112 KVM_EXIT_IO = 2,
b4e63f56 113 KVM_EXIT_HYPERCALL = 3,
6aa8b732
AK
114 KVM_EXIT_DEBUG = 4,
115 KVM_EXIT_HLT = 5,
116 KVM_EXIT_MMIO = 6,
c1150d8c 117 KVM_EXIT_IRQ_WINDOW_OPEN = 7,
46fe4ddd 118 KVM_EXIT_SHUTDOWN = 8,
8eb7d334 119 KVM_EXIT_FAIL_ENTRY = 9,
1b19f3e6 120 KVM_EXIT_INTR = 10,
253abdee 121 KVM_EXIT_SET_TPR = 11
6aa8b732
AK
122};
123
9a2bb7f4 124/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
6aa8b732
AK
125struct kvm_run {
126 /* in */
c1150d8c 127 __u8 request_interrupt_window;
02c83209 128 __u8 padding1[7];
6aa8b732
AK
129
130 /* out */
6aa8b732 131 __u32 exit_reason;
c1150d8c
DL
132 __u8 ready_for_interrupt_injection;
133 __u8 if_flag;
2ff81f70 134 __u8 padding2[2];
54810342
DL
135
136 /* in (pre_kvm_run), out (post_kvm_run) */
c1150d8c
DL
137 __u64 cr8;
138 __u64 apic_base;
139
6aa8b732
AK
140 union {
141 /* KVM_EXIT_UNKNOWN */
142 struct {
8eb7d334 143 __u64 hardware_exit_reason;
6aa8b732 144 } hw;
8eb7d334
AK
145 /* KVM_EXIT_FAIL_ENTRY */
146 struct {
147 __u64 hardware_entry_failure_reason;
148 } fail_entry;
6aa8b732
AK
149 /* KVM_EXIT_EXCEPTION */
150 struct {
151 __u32 exception;
152 __u32 error_code;
153 } ex;
154 /* KVM_EXIT_IO */
46fc1477 155 struct kvm_io {
6aa8b732
AK
156#define KVM_EXIT_IO_IN 0
157#define KVM_EXIT_IO_OUT 1
158 __u8 direction;
159 __u8 size; /* bytes */
6aa8b732 160 __u16 port;
039576c0
AK
161 __u32 count;
162 __u64 data_offset; /* relative to kvm_run start */
6aa8b732
AK
163 } io;
164 struct {
165 } debug;
166 /* KVM_EXIT_MMIO */
167 struct {
168 __u64 phys_addr;
169 __u8 data[8];
170 __u32 len;
171 __u8 is_write;
172 } mmio;
b4e63f56
AK
173 /* KVM_EXIT_HYPERCALL */
174 struct {
519ef353 175 __u64 nr;
b4e63f56
AK
176 __u64 args[6];
177 __u64 ret;
178 __u32 longmode;
179 __u32 pad;
180 } hypercall;
24cbc7e9
AK
181 /* Fix the size of the union. */
182 char padding[256];
6aa8b732
AK
183 };
184};
185
186/* for KVM_GET_REGS and KVM_SET_REGS */
187struct kvm_regs {
6aa8b732
AK
188 /* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
189 __u64 rax, rbx, rcx, rdx;
190 __u64 rsi, rdi, rsp, rbp;
191 __u64 r8, r9, r10, r11;
192 __u64 r12, r13, r14, r15;
193 __u64 rip, rflags;
194};
195
b8836737
AK
196/* for KVM_GET_FPU and KVM_SET_FPU */
197struct kvm_fpu {
198 __u8 fpr[8][16];
199 __u16 fcw;
200 __u16 fsw;
201 __u8 ftwx; /* in fxsave format */
202 __u8 pad1;
203 __u16 last_opcode;
204 __u64 last_ip;
205 __u64 last_dp;
206 __u8 xmm[16][16];
207 __u32 mxcsr;
208 __u32 pad2;
209};
210
6aa8b732
AK
211struct kvm_segment {
212 __u64 base;
213 __u32 limit;
214 __u16 selector;
215 __u8 type;
216 __u8 present, dpl, db, s, l, g, avl;
217 __u8 unusable;
218 __u8 padding;
219};
220
221struct kvm_dtable {
222 __u64 base;
223 __u16 limit;
224 __u16 padding[3];
225};
226
227/* for KVM_GET_SREGS and KVM_SET_SREGS */
228struct kvm_sregs {
6aa8b732
AK
229 /* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
230 struct kvm_segment cs, ds, es, fs, gs, ss;
231 struct kvm_segment tr, ldt;
232 struct kvm_dtable gdt, idt;
233 __u64 cr0, cr2, cr3, cr4, cr8;
234 __u64 efer;
235 __u64 apic_base;
9eb829ce 236 __u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
6aa8b732
AK
237};
238
239struct kvm_msr_entry {
240 __u32 index;
241 __u32 reserved;
242 __u64 data;
243};
244
245/* for KVM_GET_MSRS and KVM_SET_MSRS */
246struct kvm_msrs {
6aa8b732 247 __u32 nmsrs; /* number of msrs in entries */
bccf2150 248 __u32 pad;
6aa8b732
AK
249
250 struct kvm_msr_entry entries[0];
251};
252
253/* for KVM_GET_MSR_INDEX_LIST */
254struct kvm_msr_list {
255 __u32 nmsrs; /* number of msrs in entries */
256 __u32 indices[0];
257};
258
259/* for KVM_TRANSLATE */
260struct kvm_translation {
261 /* in */
262 __u64 linear_address;
6aa8b732
AK
263
264 /* out */
265 __u64 physical_address;
266 __u8 valid;
267 __u8 writeable;
268 __u8 usermode;
8cd13307 269 __u8 pad[5];
6aa8b732
AK
270};
271
272/* for KVM_INTERRUPT */
273struct kvm_interrupt {
274 /* in */
6aa8b732
AK
275 __u32 irq;
276};
277
278struct kvm_breakpoint {
279 __u32 enabled;
280 __u32 padding;
281 __u64 address;
282};
283
284/* for KVM_DEBUG_GUEST */
285struct kvm_debug_guest {
286 /* int */
6aa8b732 287 __u32 enabled;
bccf2150 288 __u32 pad;
6aa8b732
AK
289 struct kvm_breakpoint breakpoints[4];
290 __u32 singlestep;
291};
292
293/* for KVM_GET_DIRTY_LOG */
294struct kvm_dirty_log {
295 __u32 slot;
296 __u32 padding;
297 union {
298 void __user *dirty_bitmap; /* one bit per page */
299 __u64 padding;
300 };
301};
302
06465c5a
AK
303struct kvm_cpuid_entry {
304 __u32 function;
305 __u32 eax;
306 __u32 ebx;
307 __u32 ecx;
308 __u32 edx;
309 __u32 padding;
310};
311
312/* for KVM_SET_CPUID */
313struct kvm_cpuid {
314 __u32 nent;
315 __u32 padding;
316 struct kvm_cpuid_entry entries[0];
317};
318
1961d276
AK
319/* for KVM_SET_SIGNAL_MASK */
320struct kvm_signal_mask {
321 __u32 len;
322 __u8 sigset[0];
323};
324
6aa8b732
AK
325#define KVMIO 0xAE
326
f17abe9a
AK
327/*
328 * ioctls for /dev/kvm fds:
329 */
739872c5
AK
330#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
331#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
332#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
5d308f45
AK
333/*
334 * Check if a kvm extension is available. Argument is extension number,
335 * return is 1 (yes) or 0 (no, sorry).
336 */
337#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
07c45a36
AK
338/*
339 * Get size for mmap(vcpu_fd)
340 */
341#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
f17abe9a 342
85f455f7
ED
343/*
344 * Extension capability list.
345 */
346#define KVM_CAP_IRQCHIP 0
b6958ce4 347#define KVM_CAP_HLT 1
85f455f7 348
f17abe9a
AK
349/*
350 * ioctls for VM fds
351 */
739872c5 352#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
bccf2150
AK
353/*
354 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
355 * a vcpu fd.
356 */
739872c5
AK
357#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
358#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
e8207547 359#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
85f455f7
ED
360/* Device model IOC */
361#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
97222cc8 362#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
6ceb9d79
HQ
363#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
364#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
bccf2150
AK
365
366/*
367 * ioctls for vcpu fds
368 */
739872c5
AK
369#define KVM_RUN _IO(KVMIO, 0x80)
370#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
371#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
372#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
373#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
374#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
375#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
376#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
377#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
378#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
379#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
1961d276 380#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
b8836737
AK
381#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
382#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
6aa8b732
AK
383
384#endif