blob: 2367ff0c5dd085188c16292d1e3f5a222cbdd1da [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
Avi Kivity6aa8b732006-12-10 02:21:36 -080077
Avi Kivity9a2bb7f2007-02-22 12:58:31 +020078/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
Avi Kivity6aa8b732006-12-10 02:21:36 -080079struct kvm_run {
80 /* in */
Dor Laorc1150d82007-01-05 16:36:24 -080081 __u8 request_interrupt_window;
Avi Kivity02c83202007-04-29 15:02:17 +030082 __u8 padding1[7];
Avi Kivity6aa8b732006-12-10 02:21:36 -080083
84 /* out */
Avi Kivity6aa8b732006-12-10 02:21:36 -080085 __u32 exit_reason;
Dor Laorc1150d82007-01-05 16:36:24 -080086 __u8 ready_for_interrupt_injection;
87 __u8 if_flag;
Avi Kivity2ff81f72007-04-29 16:25:49 +030088 __u8 padding2[2];
Dor Laor54810342007-02-12 00:54:39 -080089
90 /* in (pre_kvm_run), out (post_kvm_run) */
Dor Laorc1150d82007-01-05 16:36:24 -080091 __u64 cr8;
92 __u64 apic_base;
93
Avi Kivity6aa8b732006-12-10 02:21:36 -080094 union {
95 /* KVM_EXIT_UNKNOWN */
96 struct {
Avi Kivity8eb7d332007-03-04 14:17:08 +020097 __u64 hardware_exit_reason;
Avi Kivity6aa8b732006-12-10 02:21:36 -080098 } hw;
Avi Kivity8eb7d332007-03-04 14:17:08 +020099 /* KVM_EXIT_FAIL_ENTRY */
100 struct {
101 __u64 hardware_entry_failure_reason;
102 } fail_entry;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800103 /* KVM_EXIT_EXCEPTION */
104 struct {
105 __u32 exception;
106 __u32 error_code;
107 } ex;
108 /* KVM_EXIT_IO */
Avi Kivity46fc1472007-02-22 19:39:30 +0200109 struct kvm_io {
Avi Kivity6aa8b732006-12-10 02:21:36 -0800110#define KVM_EXIT_IO_IN 0
111#define KVM_EXIT_IO_OUT 1
112 __u8 direction;
113 __u8 size; /* bytes */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800114 __u16 port;
Avi Kivity039576c2007-03-20 12:46:50 +0200115 __u32 count;
116 __u64 data_offset; /* relative to kvm_run start */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800117 } io;
118 struct {
119 } debug;
120 /* KVM_EXIT_MMIO */
121 struct {
122 __u64 phys_addr;
123 __u8 data[8];
124 __u32 len;
125 __u8 is_write;
126 } mmio;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200127 /* KVM_EXIT_HYPERCALL */
128 struct {
Jeff Dike519ef352007-07-16 15:24:47 -0400129 __u64 nr;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200130 __u64 args[6];
131 __u64 ret;
132 __u32 longmode;
133 __u32 pad;
134 } hypercall;
Avi Kivityb209749f2007-10-22 16:50:39 +0200135 /* KVM_EXIT_TPR_ACCESS */
136 struct {
137 __u64 rip;
138 __u32 is_write;
139 __u32 pad;
140 } tpr_access;
Avi Kivity24cbc7e2007-07-17 11:45:55 +0300141 /* Fix the size of the union. */
142 char padding[256];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800143 };
144};
145
Avi Kivity6aa8b732006-12-10 02:21:36 -0800146/* for KVM_TRANSLATE */
147struct kvm_translation {
148 /* in */
149 __u64 linear_address;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800150
151 /* out */
152 __u64 physical_address;
153 __u8 valid;
154 __u8 writeable;
155 __u8 usermode;
Avi Kivity8cd13302007-02-12 00:54:41 -0800156 __u8 pad[5];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800157};
158
159/* for KVM_INTERRUPT */
160struct kvm_interrupt {
161 /* in */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800162 __u32 irq;
163};
164
165struct kvm_breakpoint {
166 __u32 enabled;
167 __u32 padding;
168 __u64 address;
169};
170
171/* for KVM_DEBUG_GUEST */
172struct kvm_debug_guest {
173 /* int */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800174 __u32 enabled;
Avi Kivitybccf2152007-02-21 18:04:26 +0200175 __u32 pad;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800176 struct kvm_breakpoint breakpoints[4];
177 __u32 singlestep;
178};
179
180/* for KVM_GET_DIRTY_LOG */
181struct kvm_dirty_log {
182 __u32 slot;
183 __u32 padding;
184 union {
185 void __user *dirty_bitmap; /* one bit per page */
186 __u64 padding;
187 };
188};
189
Avi Kivity1961d272007-03-05 19:46:05 +0200190/* for KVM_SET_SIGNAL_MASK */
191struct kvm_signal_mask {
192 __u32 len;
193 __u8 sigset[0];
194};
195
Avi Kivityb209749f2007-10-22 16:50:39 +0200196/* for KVM_TPR_ACCESS_REPORTING */
197struct kvm_tpr_access_ctl {
198 __u32 enabled;
199 __u32 flags;
200 __u32 reserved[8];
201};
202
Avi Kivityb93463a2007-10-25 16:52:32 +0200203/* for KVM_SET_VAPIC_ADDR */
204struct kvm_vapic_addr {
205 __u64 vapic_addr;
206};
207
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100208struct kvm_s390_psw {
209 __u64 mask;
210 __u64 addr;
211};
212
Avi Kivity6aa8b732006-12-10 02:21:36 -0800213#define KVMIO 0xAE
214
Avi Kivityf17abe92007-02-21 19:28:04 +0200215/*
216 * ioctls for /dev/kvm fds:
217 */
Avi Kivity739872c2007-03-01 17:20:13 +0200218#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
219#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
220#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100221
222#define KVM_S390_ENABLE_SIE _IO(KVMIO, 0x06)
Avi Kivity5d308f42007-03-01 17:56:20 +0200223/*
224 * Check if a kvm extension is available. Argument is extension number,
225 * return is 1 (yes) or 0 (no, sorry).
226 */
227#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
Avi Kivity07c45a32007-03-07 13:05:38 +0200228/*
229 * Get size for mmap(vcpu_fd)
230 */
231#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
Avi Kivity674eea02008-02-11 18:37:23 +0200232#define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
Avi Kivityf17abe92007-02-21 19:28:04 +0200233
234/*
Eddie Dong85f455f2007-07-06 12:20:49 +0300235 * Extension capability list.
236 */
237#define KVM_CAP_IRQCHIP 0
Eddie Dongb6958ce2007-07-18 12:15:21 +0300238#define KVM_CAP_HLT 1
Izik Eidus82ce2c92007-10-02 18:52:55 +0200239#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
Izik Eidus6fc138d2007-10-09 19:20:39 +0200240#define KVM_CAP_USER_MEMORY 3
Izik Eiduscbc94022007-10-25 00:29:55 +0200241#define KVM_CAP_SET_TSS_ADDR 4
Avi Kivityb209749f2007-10-22 16:50:39 +0200242#define KVM_CAP_VAPIC 6
Avi Kivity674eea02008-02-11 18:37:23 +0200243#define KVM_CAP_EXT_CPUID 7
Glauber de Oliveira Costa18068522008-02-15 17:52:47 -0200244#define KVM_CAP_CLOCKSOURCE 8
Avi Kivityf7252302008-02-20 11:53:16 +0200245#define KVM_CAP_NR_VCPUS 9 /* returns max vcpus per vm */
Avi Kivitya988b912008-02-20 11:59:20 +0200246#define KVM_CAP_NR_MEMSLOTS 10 /* returns max memory slots per vm */
Sheng Yang78376992008-01-28 05:10:22 +0800247#define KVM_CAP_PIT 11
Marcelo Tosattia28e4f52008-02-22 12:21:36 -0500248#define KVM_CAP_NOP_IO_DELAY 12
Marcelo Tosatti2f333bc2008-02-22 12:21:37 -0500249#define KVM_CAP_PV_MMU 13
Eddie Dong85f455f2007-07-06 12:20:49 +0300250
251/*
Avi Kivityf17abe92007-02-21 19:28:04 +0200252 * ioctls for VM fds
253 */
Avi Kivity739872c2007-03-01 17:20:13 +0200254#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
Izik Eidus82ce2c92007-10-02 18:52:55 +0200255#define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
256#define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
Izik Eidus6fc138d2007-10-09 19:20:39 +0200257#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
258 struct kvm_userspace_memory_region)
Izik Eiduscbc94022007-10-25 00:29:55 +0200259#define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
Avi Kivitybccf2152007-02-21 18:04:26 +0200260/*
261 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
262 * a vcpu fd.
263 */
Avi Kivity739872c2007-03-01 17:20:13 +0200264#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
265#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
Avi Kivitye8207542007-03-30 16:54:30 +0300266#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
Eddie Dong85f455f2007-07-06 12:20:49 +0300267/* Device model IOC */
268#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
Eddie Dong97222cc2007-09-12 10:58:04 +0300269#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
He, Qing6ceb9d72007-07-26 11:05:18 +0300270#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
271#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
Sheng Yang78376992008-01-28 05:10:22 +0800272#define KVM_CREATE_PIT _IO(KVMIO, 0x64)
Sheng Yange0f63cb2008-03-04 00:50:59 +0800273#define KVM_GET_PIT _IOWR(KVMIO, 0x65, struct kvm_pit_state)
274#define KVM_SET_PIT _IOR(KVMIO, 0x66, struct kvm_pit_state)
Avi Kivitybccf2152007-02-21 18:04:26 +0200275
276/*
277 * ioctls for vcpu fds
278 */
Avi Kivity739872c2007-03-01 17:20:13 +0200279#define KVM_RUN _IO(KVMIO, 0x80)
280#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
281#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
282#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
283#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
284#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
285#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
286#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
287#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
288#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
289#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
Avi Kivity1961d272007-03-05 19:46:05 +0200290#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
Avi Kivityb8836732007-04-01 16:34:31 +0300291#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
292#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
Eddie Dong96ad2cc2007-09-06 12:22:56 +0300293#define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
294#define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
Dan Kenigsberg07716712007-11-21 17:10:04 +0200295#define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
296#define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
Avi Kivityb209749f2007-10-22 16:50:39 +0200297/* Available with KVM_CAP_VAPIC */
298#define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
Avi Kivityb93463a2007-10-25 16:52:32 +0200299/* Available with KVM_CAP_VAPIC */
300#define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
Heiko Carstensb0c632d2008-03-25 18:47:20 +0100301/* store status for s390 */
302#define KVM_S390_STORE_STATUS_NOADDR (-1ul)
303#define KVM_S390_STORE_STATUS_PREFIXED (-2ul)
304#define KVM_S390_STORE_STATUS _IOW(KVMIO, 0x95, unsigned long)
305/* initial ipl psw for s390 */
306#define KVM_S390_SET_INITIAL_PSW _IOW(KVMIO, 0x96, struct kvm_s390_psw)
307/* initial reset for s390 */
308#define KVM_S390_INITIAL_RESET _IO(KVMIO, 0x97)
Avi Kivity6aa8b732006-12-10 02:21:36 -0800309
310#endif