blob: 029f0284a2fd5d2e12e1e03bd6fdf8b80daec966 [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>
Christian Borntraeger97646202008-03-12 18:10:45 +010011#include <linux/compiler.h>
Avi Kivity6aa8b732006-12-10 02:21:36 -080012#include <linux/ioctl.h>
Jerone Youngf6a40e32007-11-19 17:06:31 -060013#include <asm/kvm.h>
Avi Kivity6aa8b732006-12-10 02:21:36 -080014
Avi Kivity2ff81f72007-04-29 16:25:49 +030015#define KVM_API_VERSION 12
Avi Kivity0b76e202006-12-22 01:06:02 -080016
Avi Kivity6aa8b732006-12-10 02:21:36 -080017/* for KVM_CREATE_MEMORY_REGION */
18struct kvm_memory_region {
19 __u32 slot;
20 __u32 flags;
21 __u64 guest_phys_addr;
22 __u64 memory_size; /* bytes */
23};
24
Izik Eidus6fc138d2007-10-09 19:20:39 +020025/* for KVM_SET_USER_MEMORY_REGION */
26struct kvm_userspace_memory_region {
27 __u32 slot;
28 __u32 flags;
29 __u64 guest_phys_addr;
30 __u64 memory_size; /* bytes */
31 __u64 userspace_addr; /* start of the userspace allocated memory */
32};
33
Avi Kivity6aa8b732006-12-10 02:21:36 -080034/* for kvm_memory_region::flags */
35#define KVM_MEM_LOG_DIRTY_PAGES 1UL
36
37
Eddie Dong97222cc2007-09-12 10:58:04 +030038/* for KVM_IRQ_LINE */
Eddie Dong85f455f2007-07-06 12:20:49 +030039struct kvm_irq_level {
40 /*
41 * ACPI gsi notion of irq.
42 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
43 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
44 */
45 __u32 irq;
46 __u32 level;
47};
48
He, Qing6ceb9d72007-07-26 11:05:18 +030049
50struct kvm_irqchip {
51 __u32 chip_id;
52 __u32 pad;
53 union {
54 char dummy[512]; /* reserving space */
Jerone Young51e29622007-11-26 08:33:53 -060055#ifdef CONFIG_X86
He, Qing6ceb9d72007-07-26 11:05:18 +030056 struct kvm_pic_state pic;
Zhang Xiantaoec10f472007-12-17 20:27:27 +080057#endif
58#if defined(CONFIG_X86) || defined(CONFIG_IA64)
He, Qing6bf9e962007-08-05 10:49:16 +030059 struct kvm_ioapic_state ioapic;
Jerone Young51e29622007-11-26 08:33:53 -060060#endif
He, Qing6ceb9d72007-07-26 11:05:18 +030061 } chip;
62};
63
Avi Kivity8a454502007-10-10 14:03:16 +020064#define KVM_EXIT_UNKNOWN 0
65#define KVM_EXIT_EXCEPTION 1
66#define KVM_EXIT_IO 2
67#define KVM_EXIT_HYPERCALL 3
68#define KVM_EXIT_DEBUG 4
69#define KVM_EXIT_HLT 5
70#define KVM_EXIT_MMIO 6
71#define KVM_EXIT_IRQ_WINDOW_OPEN 7
72#define KVM_EXIT_SHUTDOWN 8
73#define KVM_EXIT_FAIL_ENTRY 9
74#define KVM_EXIT_INTR 10
75#define KVM_EXIT_SET_TPR 11
Avi Kivityb209749f2007-10-22 16:50:39 +020076#define KVM_EXIT_TPR_ACCESS 12
Christian Borntraeger8f2abe62008-03-25 18:47:23 +010077#define KVM_EXIT_S390_SIEIC 13
Avi Kivity6aa8b732006-12-10 02:21:36 -080078
Avi Kivity9a2bb7f2007-02-22 12:58:31 +020079/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
Avi Kivity6aa8b732006-12-10 02:21:36 -080080struct kvm_run {
81 /* in */
Dor Laorc1150d82007-01-05 16:36:24 -080082 __u8 request_interrupt_window;
Avi Kivity02c83202007-04-29 15:02:17 +030083 __u8 padding1[7];
Avi Kivity6aa8b732006-12-10 02:21:36 -080084
85 /* out */
Avi Kivity6aa8b732006-12-10 02:21:36 -080086 __u32 exit_reason;
Dor Laorc1150d82007-01-05 16:36:24 -080087 __u8 ready_for_interrupt_injection;
88 __u8 if_flag;
Avi Kivity2ff81f72007-04-29 16:25:49 +030089 __u8 padding2[2];
Dor Laor54810342007-02-12 00:54:39 -080090
91 /* in (pre_kvm_run), out (post_kvm_run) */
Dor Laorc1150d82007-01-05 16:36:24 -080092 __u64 cr8;
93 __u64 apic_base;
94
Avi Kivity6aa8b732006-12-10 02:21:36 -080095 union {
96 /* KVM_EXIT_UNKNOWN */
97 struct {
Avi Kivity8eb7d332007-03-04 14:17:08 +020098 __u64 hardware_exit_reason;
Avi Kivity6aa8b732006-12-10 02:21:36 -080099 } hw;
Avi Kivity8eb7d332007-03-04 14:17:08 +0200100 /* KVM_EXIT_FAIL_ENTRY */
101 struct {
102 __u64 hardware_entry_failure_reason;
103 } fail_entry;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800104 /* KVM_EXIT_EXCEPTION */
105 struct {
106 __u32 exception;
107 __u32 error_code;
108 } ex;
109 /* KVM_EXIT_IO */
Avi Kivity46fc1472007-02-22 19:39:30 +0200110 struct kvm_io {
Avi Kivity6aa8b732006-12-10 02:21:36 -0800111#define KVM_EXIT_IO_IN 0
112#define KVM_EXIT_IO_OUT 1
113 __u8 direction;
114 __u8 size; /* bytes */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800115 __u16 port;
Avi Kivity039576c2007-03-20 12:46:50 +0200116 __u32 count;
117 __u64 data_offset; /* relative to kvm_run start */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800118 } io;
119 struct {
120 } debug;
121 /* KVM_EXIT_MMIO */
122 struct {
123 __u64 phys_addr;
124 __u8 data[8];
125 __u32 len;
126 __u8 is_write;
127 } mmio;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200128 /* KVM_EXIT_HYPERCALL */
129 struct {
Jeff Dike519ef352007-07-16 15:24:47 -0400130 __u64 nr;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200131 __u64 args[6];
132 __u64 ret;
133 __u32 longmode;
134 __u32 pad;
135 } hypercall;
Avi Kivityb209749f2007-10-22 16:50:39 +0200136 /* KVM_EXIT_TPR_ACCESS */
137 struct {
138 __u64 rip;
139 __u32 is_write;
140 __u32 pad;
141 } tpr_access;
Christian Borntraeger8f2abe62008-03-25 18:47:23 +0100142 /* KVM_EXIT_S390_SIEIC */
143 struct {
144 __u8 icptcode;
145 __u64 mask; /* psw upper half */
146 __u64 addr; /* psw lower half */
147 __u16 ipa;
148 __u32 ipb;
149 } s390_sieic;
Avi Kivity24cbc7e2007-07-17 11:45:55 +0300150 /* Fix the size of the union. */
151 char padding[256];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800152 };
153};
154
Avi Kivity6aa8b732006-12-10 02:21:36 -0800155/* for KVM_TRANSLATE */
156struct kvm_translation {
157 /* in */
158 __u64 linear_address;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800159
160 /* out */
161 __u64 physical_address;
162 __u8 valid;
163 __u8 writeable;
164 __u8 usermode;
Avi Kivity8cd13302007-02-12 00:54:41 -0800165 __u8 pad[5];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800166};
167
168/* for KVM_INTERRUPT */
169struct kvm_interrupt {
170 /* in */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800171 __u32 irq;
172};
173
174struct kvm_breakpoint {
175 __u32 enabled;
176 __u32 padding;
177 __u64 address;
178};
179
180/* for KVM_DEBUG_GUEST */
181struct kvm_debug_guest {
182 /* int */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800183 __u32 enabled;
Avi Kivitybccf2152007-02-21 18:04:26 +0200184 __u32 pad;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800185 struct kvm_breakpoint breakpoints[4];
186 __u32 singlestep;
187};
188
189/* for KVM_GET_DIRTY_LOG */
190struct kvm_dirty_log {
191 __u32 slot;
192 __u32 padding;
193 union {
194 void __user *dirty_bitmap; /* one bit per page */
195 __u64 padding;
196 };
197};
198
Avi Kivity1961d272007-03-05 19:46:05 +0200199/* for KVM_SET_SIGNAL_MASK */
200struct kvm_signal_mask {
201 __u32 len;
202 __u8 sigset[0];
203};
204
Avi Kivityb209749f2007-10-22 16:50:39 +0200205/* for KVM_TPR_ACCESS_REPORTING */
206struct kvm_tpr_access_ctl {
207 __u32 enabled;
208 __u32 flags;
209 __u32 reserved[8];
210};
211
Avi Kivityb93463a2007-10-25 16:52:32 +0200212/* for KVM_SET_VAPIC_ADDR */
213struct kvm_vapic_addr {
214 __u64 vapic_addr;
215};
216
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100217struct kvm_s390_psw {
218 __u64 mask;
219 __u64 addr;
220};
221
Carsten Otteba5c1e92008-03-25 18:47:26 +0100222/* valid values for type in kvm_s390_interrupt */
223#define KVM_S390_SIGP_STOP 0xfffe0000u
224#define KVM_S390_PROGRAM_INT 0xfffe0001u
225#define KVM_S390_SIGP_SET_PREFIX 0xfffe0002u
226#define KVM_S390_RESTART 0xfffe0003u
227#define KVM_S390_INT_VIRTIO 0xffff2603u
228#define KVM_S390_INT_SERVICE 0xffff2401u
229#define KVM_S390_INT_EMERGENCY 0xffff1201u
230
231struct kvm_s390_interrupt {
232 __u32 type;
233 __u32 parm;
234 __u64 parm64;
235};
236
Avi Kivity6aa8b732006-12-10 02:21:36 -0800237#define KVMIO 0xAE
238
Avi Kivityf17abe92007-02-21 19:28:04 +0200239/*
240 * ioctls for /dev/kvm fds:
241 */
Avi Kivity739872c2007-03-01 17:20:13 +0200242#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
243#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
244#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100245
246#define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
Avi Kivity5d308f42007-03-01 17:56:20 +0200247/*
248 * Check if a kvm extension is available. Argument is extension number,
249 * return is 1 (yes) or 0 (no, sorry).
250 */
251#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
Avi Kivity07c45a32007-03-07 13:05:38 +0200252/*
253 * Get size for mmap(vcpu_fd)
254 */
255#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
Avi Kivity674eea02008-02-11 18:37:23 +0200256#define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
Avi Kivityf17abe92007-02-21 19:28:04 +0200257
258/*
Eddie Dong85f455f2007-07-06 12:20:49 +0300259 * Extension capability list.
260 */
261#define KVM_CAP_IRQCHIP 0
Eddie Dongb6958ce2007-07-18 12:15:21 +0300262#define KVM_CAP_HLT 1
Izik Eidus82ce2c92007-10-02 18:52:55 +0200263#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
Izik Eidus6fc138d2007-10-09 19:20:39 +0200264#define KVM_CAP_USER_MEMORY 3
Izik Eiduscbc94022007-10-25 00:29:55 +0200265#define KVM_CAP_SET_TSS_ADDR 4
Avi Kivityb209749f2007-10-22 16:50:39 +0200266#define KVM_CAP_VAPIC 6
Avi Kivity674eea02008-02-11 18:37:23 +0200267#define KVM_CAP_EXT_CPUID 7
Glauber de Oliveira Costa18068522008-02-15 17:52:47 -0200268#define KVM_CAP_CLOCKSOURCE 8
Avi Kivityf7252302008-02-20 11:53:16 +0200269#define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
Avi Kivitya988b912008-02-20 11:59:20 +0200270#define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
Sheng Yang78376992008-01-28 05:10:22 +0800271#define KVM_CAP_PIT 11
Marcelo Tosattia28e4f52008-02-22 12:21:36 -0500272#define KVM_CAP_NOP_IO_DELAY 12
Marcelo Tosatti2f333bc2008-02-22 12:21:37 -0500273#define KVM_CAP_PV_MMU 13
Eddie Dong85f455f2007-07-06 12:20:49 +0300274
275/*
Avi Kivityf17abe92007-02-21 19:28:04 +0200276 * ioctls for VM fds
277 */
Avi Kivity739872c2007-03-01 17:20:13 +0200278#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
Izik Eidus82ce2c92007-10-02 18:52:55 +0200279#define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
280#define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
Izik Eidus6fc138d2007-10-09 19:20:39 +0200281#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
282 struct kvm_userspace_memory_region)
Izik Eiduscbc94022007-10-25 00:29:55 +0200283#define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
Avi Kivitybccf2152007-02-21 18:04:26 +0200284/*
285 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
286 * a vcpu fd.
287 */
Avi Kivity739872c2007-03-01 17:20:13 +0200288#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
289#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
Avi Kivitye8207542007-03-30 16:54:30 +0300290#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
Eddie Dong85f455f2007-07-06 12:20:49 +0300291/* Device model IOC */
292#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
Eddie Dong97222cc2007-09-12 10:58:04 +0300293#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
He, Qing6ceb9d72007-07-26 11:05:18 +0300294#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
295#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
Sheng Yang78376992008-01-28 05:10:22 +0800296#define KVM_CREATE_PIT _IO(KVMIO, 0x64)
Sheng Yange0f63cb2008-03-04 00:50:59 +0800297#define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
298#define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
Avi Kivitybccf2152007-02-21 18:04:26 +0200299
300/*
301 * ioctls for vcpu fds
302 */
Avi Kivity739872c2007-03-01 17:20:13 +0200303#define KVM_RUN _IO(KVMIO, 0x80)
304#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
305#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
306#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
307#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
308#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
309#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
310#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
311#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
312#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
313#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
Avi Kivity1961d272007-03-05 19:46:05 +0200314#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
Avi Kivityb8836732007-04-01 16:34:31 +0300315#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
316#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
Eddie Dong96ad2cc2007-09-06 12:22:56 +0300317#define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
318#define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
Dan Kenigsberg07716712007-11-21 17:10:04 +0200319#define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
320#define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
Avi Kivityb209749f2007-10-22 16:50:39 +0200321/* Available with KVM_CAP_VAPIC */
322#define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
Avi Kivityb93463a2007-10-25 16:52:32 +0200323/* Available with KVM_CAP_VAPIC */
324#define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
Carsten Otteba5c1e92008-03-25 18:47:26 +0100325/* valid for virtual machine (for floating interrupt)_and_ vcpu */
326#define KVM_S390_INTERRUPT _IOW(KVMIO, 0x94, struct kvm_s390_interrupt)
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100327/* store status for s390 */
328#define KVM_S390_STORE_STATUS_NOADDR (-1ul)
329#define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
330#define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
331/* initial ipl psw for s390 */
332#define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
333/* initial reset for s390 */
334#define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
Avi Kivity6aa8b732006-12-10 02:21:36 -0800335
336#endif