blob: c1ec04fd000d42d27d310ce79c92944f09d63c5f [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 */
Jerone Young51e29622007-11-26 08:33:53 -060054#ifdef CONFIG_X86
He, Qing6ceb9d72007-07-26 11:05:18 +030055 struct kvm_pic_state pic;
Zhang Xiantaoec10f472007-12-17 20:27:27 +080056#endif
57#if defined(CONFIG_X86) || defined(CONFIG_IA64)
He, Qing6bf9e962007-08-05 10:49:16 +030058 struct kvm_ioapic_state ioapic;
Jerone Young51e29622007-11-26 08:33:53 -060059#endif
He, Qing6ceb9d72007-07-26 11:05:18 +030060 } chip;
61};
62
Avi Kivity8a454502007-10-10 14:03:16 +020063#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
Avi Kivityb209749f2007-10-22 16:50:39 +020075#define KVM_EXIT_TPR_ACCESS 12
Avi Kivity6aa8b732006-12-10 02:21:36 -080076
Avi Kivity9a2bb7f2007-02-22 12:58:31 +020077/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
Avi Kivity6aa8b732006-12-10 02:21:36 -080078struct kvm_run {
79 /* in */
Dor Laorc1150d82007-01-05 16:36:24 -080080 __u8 request_interrupt_window;
Avi Kivity02c83202007-04-29 15:02:17 +030081 __u8 padding1[7];
Avi Kivity6aa8b732006-12-10 02:21:36 -080082
83 /* out */
Avi Kivity6aa8b732006-12-10 02:21:36 -080084 __u32 exit_reason;
Dor Laorc1150d82007-01-05 16:36:24 -080085 __u8 ready_for_interrupt_injection;
86 __u8 if_flag;
Avi Kivity2ff81f72007-04-29 16:25:49 +030087 __u8 padding2[2];
Dor Laor54810342007-02-12 00:54:39 -080088
89 /* in (pre_kvm_run), out (post_kvm_run) */
Dor Laorc1150d82007-01-05 16:36:24 -080090 __u64 cr8;
91 __u64 apic_base;
92
Avi Kivity6aa8b732006-12-10 02:21:36 -080093 union {
94 /* KVM_EXIT_UNKNOWN */
95 struct {
Avi Kivity8eb7d332007-03-04 14:17:08 +020096 __u64 hardware_exit_reason;
Avi Kivity6aa8b732006-12-10 02:21:36 -080097 } hw;
Avi Kivity8eb7d332007-03-04 14:17:08 +020098 /* KVM_EXIT_FAIL_ENTRY */
99 struct {
100 __u64 hardware_entry_failure_reason;
101 } fail_entry;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800102 /* KVM_EXIT_EXCEPTION */
103 struct {
104 __u32 exception;
105 __u32 error_code;
106 } ex;
107 /* KVM_EXIT_IO */
Avi Kivity46fc1472007-02-22 19:39:30 +0200108 struct kvm_io {
Avi Kivity6aa8b732006-12-10 02:21:36 -0800109#define KVM_EXIT_IO_IN 0
110#define KVM_EXIT_IO_OUT 1
111 __u8 direction;
112 __u8 size; /* bytes */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800113 __u16 port;
Avi Kivity039576c2007-03-20 12:46:50 +0200114 __u32 count;
115 __u64 data_offset; /* relative to kvm_run start */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800116 } 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;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200126 /* KVM_EXIT_HYPERCALL */
127 struct {
Jeff Dike519ef352007-07-16 15:24:47 -0400128 __u64 nr;
Avi Kivityb4e63f52007-03-04 13:59:30 +0200129 __u64 args[6];
130 __u64 ret;
131 __u32 longmode;
132 __u32 pad;
133 } hypercall;
Avi Kivityb209749f2007-10-22 16:50:39 +0200134 /* KVM_EXIT_TPR_ACCESS */
135 struct {
136 __u64 rip;
137 __u32 is_write;
138 __u32 pad;
139 } tpr_access;
Avi Kivity24cbc7e2007-07-17 11:45:55 +0300140 /* Fix the size of the union. */
141 char padding[256];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800142 };
143};
144
Avi Kivity6aa8b732006-12-10 02:21:36 -0800145/* for KVM_TRANSLATE */
146struct kvm_translation {
147 /* in */
148 __u64 linear_address;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800149
150 /* out */
151 __u64 physical_address;
152 __u8 valid;
153 __u8 writeable;
154 __u8 usermode;
Avi Kivity8cd13302007-02-12 00:54:41 -0800155 __u8 pad[5];
Avi Kivity6aa8b732006-12-10 02:21:36 -0800156};
157
158/* for KVM_INTERRUPT */
159struct kvm_interrupt {
160 /* in */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800161 __u32 irq;
162};
163
164struct kvm_breakpoint {
165 __u32 enabled;
166 __u32 padding;
167 __u64 address;
168};
169
170/* for KVM_DEBUG_GUEST */
171struct kvm_debug_guest {
172 /* int */
Avi Kivity6aa8b732006-12-10 02:21:36 -0800173 __u32 enabled;
Avi Kivitybccf2152007-02-21 18:04:26 +0200174 __u32 pad;
Avi Kivity6aa8b732006-12-10 02:21:36 -0800175 struct kvm_breakpoint breakpoints[4];
176 __u32 singlestep;
177};
178
179/* for KVM_GET_DIRTY_LOG */
180struct kvm_dirty_log {
181 __u32 slot;
182 __u32 padding;
183 union {
184 void __user *dirty_bitmap; /* one bit per page */
185 __u64 padding;
186 };
187};
188
Avi Kivity1961d272007-03-05 19:46:05 +0200189/* for KVM_SET_SIGNAL_MASK */
190struct kvm_signal_mask {
191 __u32 len;
192 __u8 sigset[0];
193};
194
Avi Kivityb209749f2007-10-22 16:50:39 +0200195/* for KVM_TPR_ACCESS_REPORTING */
196struct kvm_tpr_access_ctl {
197 __u32 enabled;
198 __u32 flags;
199 __u32 reserved[8];
200};
201
Avi Kivityb93463a2007-10-25 16:52:32 +0200202/* for KVM_SET_VAPIC_ADDR */
203struct kvm_vapic_addr {
204 __u64 vapic_addr;
205};
206
Avi Kivity6aa8b732006-12-10 02:21:36 -0800207#define KVMIO 0xAE
208
Avi Kivityf17abe92007-02-21 19:28:04 +0200209/*
210 * ioctls for /dev/kvm fds:
211 */
Avi Kivity739872c2007-03-01 17:20:13 +0200212#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
213#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
214#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
Avi Kivity5d308f42007-03-01 17:56:20 +0200215/*
216 * Check if a kvm extension is available. Argument is extension number,
217 * return is 1 (yes) or 0 (no, sorry).
218 */
219#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
Avi Kivity07c45a32007-03-07 13:05:38 +0200220/*
221 * Get size for mmap(vcpu_fd)
222 */
223#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
Avi Kivity674eea02008-02-11 18:37:23 +0200224#define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
Avi Kivityf17abe92007-02-21 19:28:04 +0200225
226/*
Eddie Dong85f455f2007-07-06 12:20:49 +0300227 * Extension capability list.
228 */
229#define KVM_CAP_IRQCHIP 0
Eddie Dongb6958ce2007-07-18 12:15:21 +0300230#define KVM_CAP_HLT 1
Izik Eidus82ce2c92007-10-02 18:52:55 +0200231#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
Izik Eidus6fc138d2007-10-09 19:20:39 +0200232#define KVM_CAP_USER_MEMORY 3
Izik Eiduscbc94022007-10-25 00:29:55 +0200233#define KVM_CAP_SET_TSS_ADDR 4
Avi Kivityb209749f2007-10-22 16:50:39 +0200234#define KVM_CAP_VAPIC 6
Avi Kivity674eea02008-02-11 18:37:23 +0200235#define KVM_CAP_EXT_CPUID 7
Eddie Dong85f455f2007-07-06 12:20:49 +0300236
237/*
Avi Kivityf17abe92007-02-21 19:28:04 +0200238 * ioctls for VM fds
239 */
Avi Kivity739872c2007-03-01 17:20:13 +0200240#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
Izik Eidus82ce2c92007-10-02 18:52:55 +0200241#define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
242#define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
Izik Eidus6fc138d2007-10-09 19:20:39 +0200243#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
244 struct kvm_userspace_memory_region)
Izik Eiduscbc94022007-10-25 00:29:55 +0200245#define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
Avi Kivitybccf2152007-02-21 18:04:26 +0200246/*
247 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
248 * a vcpu fd.
249 */
Avi Kivity739872c2007-03-01 17:20:13 +0200250#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
251#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
Avi Kivitye8207542007-03-30 16:54:30 +0300252#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
Eddie Dong85f455f2007-07-06 12:20:49 +0300253/* Device model IOC */
254#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
Eddie Dong97222cc2007-09-12 10:58:04 +0300255#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
He, Qing6ceb9d72007-07-26 11:05:18 +0300256#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
257#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
Avi Kivitybccf2152007-02-21 18:04:26 +0200258
259/*
260 * ioctls for vcpu fds
261 */
Avi Kivity739872c2007-03-01 17:20:13 +0200262#define KVM_RUN _IO(KVMIO, 0x80)
263#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
264#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
265#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
266#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
267#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
268#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
269#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
270#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
271#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
272#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
Avi Kivity1961d272007-03-05 19:46:05 +0200273#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
Avi Kivityb8836732007-04-01 16:34:31 +0300274#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
275#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
Eddie Dong96ad2cc2007-09-06 12:22:56 +0300276#define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
277#define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
Dan Kenigsberg07716712007-11-21 17:10:04 +0200278#define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
279#define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
Avi Kivityb209749f2007-10-22 16:50:39 +0200280/* Available with KVM_CAP_VAPIC */
281#define KVM_TPR_ACCESS_REPORTING _IOWR(KVMIO, 0x92, struct kvm_tpr_access_ctl)
Avi Kivityb93463a2007-10-25 16:52:32 +0200282/* Available with KVM_CAP_VAPIC */
283#define KVM_SET_VAPIC_ADDR _IOW(KVMIO, 0x93, struct kvm_vapic_addr)
Avi Kivity6aa8b732006-12-10 02:21:36 -0800284
285#endif