KVM: Advertise the bug in memory region destruction as fixed
[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/compiler.h>
12 #include <linux/ioctl.h>
13 #include <asm/kvm.h>
14
15 #define KVM_API_VERSION 12
16
17 /* for KVM_TRACE_ENABLE */
18 struct kvm_user_trace_setup {
19         __u32 buf_size; /* sub_buffer size of each per-cpu */
20         __u32 buf_nr; /* the number of sub_buffers of each per-cpu */
21 };
22
23 /* for KVM_CREATE_MEMORY_REGION */
24 struct kvm_memory_region {
25         __u32 slot;
26         __u32 flags;
27         __u64 guest_phys_addr;
28         __u64 memory_size; /* bytes */
29 };
30
31 /* for KVM_SET_USER_MEMORY_REGION */
32 struct kvm_userspace_memory_region {
33         __u32 slot;
34         __u32 flags;
35         __u64 guest_phys_addr;
36         __u64 memory_size; /* bytes */
37         __u64 userspace_addr; /* start of the userspace allocated memory */
38 };
39
40 /* for kvm_memory_region::flags */
41 #define KVM_MEM_LOG_DIRTY_PAGES  1UL
42
43
44 /* for KVM_IRQ_LINE */
45 struct kvm_irq_level {
46         /*
47          * ACPI gsi notion of irq.
48          * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
49          * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
50          */
51         __u32 irq;
52         __u32 level;
53 };
54
55
56 struct kvm_irqchip {
57         __u32 chip_id;
58         __u32 pad;
59         union {
60                 char dummy[512];  /* reserving space */
61 #ifdef CONFIG_X86
62                 struct kvm_pic_state pic;
63 #endif
64 #if defined(CONFIG_X86) || defined(CONFIG_IA64)
65                 struct kvm_ioapic_state ioapic;
66 #endif
67         } chip;
68 };
69
70 #define KVM_EXIT_UNKNOWN          0
71 #define KVM_EXIT_EXCEPTION        1
72 #define KVM_EXIT_IO               2
73 #define KVM_EXIT_HYPERCALL        3
74 #define KVM_EXIT_DEBUG            4
75 #define KVM_EXIT_HLT              5
76 #define KVM_EXIT_MMIO             6
77 #define KVM_EXIT_IRQ_WINDOW_OPEN  7
78 #define KVM_EXIT_SHUTDOWN         8
79 #define KVM_EXIT_FAIL_ENTRY       9
80 #define KVM_EXIT_INTR             10
81 #define KVM_EXIT_SET_TPR          11
82 #define KVM_EXIT_TPR_ACCESS       12
83 #define KVM_EXIT_S390_SIEIC       13
84 #define KVM_EXIT_S390_RESET       14
85 #define KVM_EXIT_DCR              15
86 #define KVM_EXIT_NMI              16
87 #define KVM_EXIT_NMI_WINDOW_OPEN  17
88
89 /* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
90 struct kvm_run {
91         /* in */
92         __u8 request_interrupt_window;
93         __u8 request_nmi_window;
94         __u8 padding1[6];
95
96         /* out */
97         __u32 exit_reason;
98         __u8 ready_for_interrupt_injection;
99         __u8 if_flag;
100         __u8 ready_for_nmi_injection;
101         __u8 padding2;
102
103         /* in (pre_kvm_run), out (post_kvm_run) */
104         __u64 cr8;
105         __u64 apic_base;
106
107         union {
108                 /* KVM_EXIT_UNKNOWN */
109                 struct {
110                         __u64 hardware_exit_reason;
111                 } hw;
112                 /* KVM_EXIT_FAIL_ENTRY */
113                 struct {
114                         __u64 hardware_entry_failure_reason;
115                 } fail_entry;
116                 /* KVM_EXIT_EXCEPTION */
117                 struct {
118                         __u32 exception;
119                         __u32 error_code;
120                 } ex;
121                 /* KVM_EXIT_IO */
122                 struct kvm_io {
123 #define KVM_EXIT_IO_IN  0
124 #define KVM_EXIT_IO_OUT 1
125                         __u8 direction;
126                         __u8 size; /* bytes */
127                         __u16 port;
128                         __u32 count;
129                         __u64 data_offset; /* relative to kvm_run start */
130                 } io;
131                 struct {
132                 } debug;
133                 /* KVM_EXIT_MMIO */
134                 struct {
135                         __u64 phys_addr;
136                         __u8  data[8];
137                         __u32 len;
138                         __u8  is_write;
139                 } mmio;
140                 /* KVM_EXIT_HYPERCALL */
141                 struct {
142                         __u64 nr;
143                         __u64 args[6];
144                         __u64 ret;
145                         __u32 longmode;
146                         __u32 pad;
147                 } hypercall;
148                 /* KVM_EXIT_TPR_ACCESS */
149                 struct {
150                         __u64 rip;
151                         __u32 is_write;
152                         __u32 pad;
153                 } tpr_access;
154                 /* KVM_EXIT_S390_SIEIC */
155                 struct {
156                         __u8 icptcode;
157                         __u64 mask; /* psw upper half */
158                         __u64 addr; /* psw lower half */
159                         __u16 ipa;
160                         __u32 ipb;
161                 } s390_sieic;
162                 /* KVM_EXIT_S390_RESET */
163 #define KVM_S390_RESET_POR       1
164 #define KVM_S390_RESET_CLEAR     2
165 #define KVM_S390_RESET_SUBSYSTEM 4
166 #define KVM_S390_RESET_CPU_INIT  8
167 #define KVM_S390_RESET_IPL       16
168                 __u64 s390_reset_flags;
169                 /* KVM_EXIT_DCR */
170                 struct {
171                         __u32 dcrn;
172                         __u32 data;
173                         __u8  is_write;
174                 } dcr;
175                 /* Fix the size of the union. */
176                 char padding[256];
177         };
178 };
179
180 /* for KVM_REGISTER_COALESCED_MMIO / KVM_UNREGISTER_COALESCED_MMIO */
181
182 struct kvm_coalesced_mmio_zone {
183         __u64 addr;
184         __u32 size;
185         __u32 pad;
186 };
187
188 struct kvm_coalesced_mmio {
189         __u64 phys_addr;
190         __u32 len;
191         __u32 pad;
192         __u8  data[8];
193 };
194
195 struct kvm_coalesced_mmio_ring {
196         __u32 first, last;
197         struct kvm_coalesced_mmio coalesced_mmio[0];
198 };
199
200 #define KVM_COALESCED_MMIO_MAX \
201         ((PAGE_SIZE - sizeof(struct kvm_coalesced_mmio_ring)) / \
202          sizeof(struct kvm_coalesced_mmio))
203
204 /* for KVM_TRANSLATE */
205 struct kvm_translation {
206         /* in */
207         __u64 linear_address;
208
209         /* out */
210         __u64 physical_address;
211         __u8  valid;
212         __u8  writeable;
213         __u8  usermode;
214         __u8  pad[5];
215 };
216
217 /* for KVM_INTERRUPT */
218 struct kvm_interrupt {
219         /* in */
220         __u32 irq;
221 };
222
223 struct kvm_breakpoint {
224         __u32 enabled;
225         __u32 padding;
226         __u64 address;
227 };
228
229 /* for KVM_DEBUG_GUEST */
230 struct kvm_debug_guest {
231         /* int */
232         __u32 enabled;
233         __u32 pad;
234         struct kvm_breakpoint breakpoints[4];
235         __u32 singlestep;
236 };
237
238 /* for KVM_GET_DIRTY_LOG */
239 struct kvm_dirty_log {
240         __u32 slot;
241         __u32 padding;
242         union {
243                 void __user *dirty_bitmap; /* one bit per page */
244                 __u64 padding;
245         };
246 };
247
248 /* for KVM_SET_SIGNAL_MASK */
249 struct kvm_signal_mask {
250         __u32 len;
251         __u8  sigset[0];
252 };
253
254 /* for KVM_TPR_ACCESS_REPORTING */
255 struct kvm_tpr_access_ctl {
256         __u32 enabled;
257         __u32 flags;
258         __u32 reserved[8];
259 };
260
261 /* for KVM_SET_VAPIC_ADDR */
262 struct kvm_vapic_addr {
263         __u64 vapic_addr;
264 };
265
266 /* for KVM_SET_MPSTATE */
267
268 #define KVM_MP_STATE_RUNNABLE          0
269 #define KVM_MP_STATE_UNINITIALIZED     1
270 #define KVM_MP_STATE_INIT_RECEIVED     2
271 #define KVM_MP_STATE_HALTED            3
272 #define KVM_MP_STATE_SIPI_RECEIVED     4
273
274 struct kvm_mp_state {
275         __u32 mp_state;
276 };
277
278 struct kvm_s390_psw {
279         __u64 mask;
280         __u64 addr;
281 };
282
283 /* valid values for type in kvm_s390_interrupt */
284 #define KVM_S390_SIGP_STOP              0xfffe0000u
285 #define KVM_S390_PROGRAM_INT            0xfffe0001u
286 #define KVM_S390_SIGP_SET_PREFIX        0xfffe0002u
287 #define KVM_S390_RESTART                0xfffe0003u
288 #define KVM_S390_INT_VIRTIO             0xffff2603u
289 #define KVM_S390_INT_SERVICE            0xffff2401u
290 #define KVM_S390_INT_EMERGENCY          0xffff1201u
291
292 struct kvm_s390_interrupt {
293         __u32 type;
294         __u32 parm;
295         __u64 parm64;
296 };
297
298 #define KVM_TRC_SHIFT           16
299 /*
300  * kvm trace categories
301  */
302 #define KVM_TRC_ENTRYEXIT       (1 << KVM_TRC_SHIFT)
303 #define KVM_TRC_HANDLER         (1 << (KVM_TRC_SHIFT + 1)) /* only 12 bits */
304
305 /*
306  * kvm trace action
307  */
308 #define KVM_TRC_VMENTRY         (KVM_TRC_ENTRYEXIT + 0x01)
309 #define KVM_TRC_VMEXIT          (KVM_TRC_ENTRYEXIT + 0x02)
310 #define KVM_TRC_PAGE_FAULT      (KVM_TRC_HANDLER + 0x01)
311
312 #define KVM_TRC_HEAD_SIZE       12
313 #define KVM_TRC_CYCLE_SIZE      8
314 #define KVM_TRC_EXTRA_MAX       7
315
316 /* This structure represents a single trace buffer record. */
317 struct kvm_trace_rec {
318         /* variable rec_val
319          * is split into:
320          * bits 0 - 27  -> event id
321          * bits 28 -30  -> number of extra data args of size u32
322          * bits 31      -> binary indicator for if tsc is in record
323          */
324         __u32 rec_val;
325         __u32 pid;
326         __u32 vcpu_id;
327         union {
328                 struct {
329                         __u64 timestamp;
330                         __u32 extra_u32[KVM_TRC_EXTRA_MAX];
331                 } __attribute__((packed)) timestamp;
332                 struct {
333                         __u32 extra_u32[KVM_TRC_EXTRA_MAX];
334                 } notimestamp;
335         } u;
336 };
337
338 #define TRACE_REC_EVENT_ID(val) \
339                 (0x0fffffff & (val))
340 #define TRACE_REC_NUM_DATA_ARGS(val) \
341                 (0x70000000 & ((val) << 28))
342 #define TRACE_REC_TCS(val) \
343                 (0x80000000 & ((val) << 31))
344
345 #define KVMIO 0xAE
346
347 /*
348  * ioctls for /dev/kvm fds:
349  */
350 #define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
351 #define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
352 #define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
353
354 #define KVM_S390_ENABLE_SIE       _IO(KVMIO,   0x06)
355 /*
356  * Check if a kvm extension is available.  Argument is extension number,
357  * return is 1 (yes) or 0 (no, sorry).
358  */
359 #define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
360 /*
361  * Get size for mmap(vcpu_fd)
362  */
363 #define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */
364 #define KVM_GET_SUPPORTED_CPUID   _IOWR(KVMIO, 0x05, struct kvm_cpuid2)
365 /*
366  * ioctls for kvm trace
367  */
368 #define KVM_TRACE_ENABLE          _IOW(KVMIO, 0x06, struct kvm_user_trace_setup)
369 #define KVM_TRACE_PAUSE           _IO(KVMIO,  0x07)
370 #define KVM_TRACE_DISABLE         _IO(KVMIO,  0x08)
371 /*
372  * Extension capability list.
373  */
374 #define KVM_CAP_IRQCHIP   0
375 #define KVM_CAP_HLT       1
376 #define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
377 #define KVM_CAP_USER_MEMORY 3
378 #define KVM_CAP_SET_TSS_ADDR 4
379 #define KVM_CAP_VAPIC 6
380 #define KVM_CAP_EXT_CPUID 7
381 #define KVM_CAP_CLOCKSOURCE 8
382 #define KVM_CAP_NR_VCPUS 9       /* returns max vcpus per vm */
383 #define KVM_CAP_NR_MEMSLOTS 10   /* returns max memory slots per vm */
384 #define KVM_CAP_PIT 11
385 #define KVM_CAP_NOP_IO_DELAY 12
386 #define KVM_CAP_PV_MMU 13
387 #define KVM_CAP_MP_STATE 14
388 #define KVM_CAP_COALESCED_MMIO 15
389 #define KVM_CAP_SYNC_MMU 16  /* Changes to host mmap are reflected in guest */
390 #if defined(CONFIG_X86)||defined(CONFIG_IA64)
391 #define KVM_CAP_DEVICE_ASSIGNMENT 17
392 #endif
393 #define KVM_CAP_IOMMU 18
394 #define KVM_CAP_NMI 19
395 #if defined(CONFIG_X86)
396 #define KVM_CAP_DEVICE_MSI 20
397 #endif
398 /* Bug in KVM_SET_USER_MEMORY_REGION fixed: */
399 #define KVM_CAP_DESTROY_MEMORY_REGION_WORKS 21
400
401 /*
402  * ioctls for VM fds
403  */
404 #define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
405 #define KVM_SET_NR_MMU_PAGES      _IO(KVMIO, 0x44)
406 #define KVM_GET_NR_MMU_PAGES      _IO(KVMIO, 0x45)
407 #define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
408                                         struct kvm_userspace_memory_region)
409 #define KVM_SET_TSS_ADDR          _IO(KVMIO, 0x47)
410 /*
411  * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
412  * a vcpu fd.
413  */
414 #define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
415 #define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
416 #define KVM_SET_MEMORY_ALIAS      _IOW(KVMIO, 0x43, struct kvm_memory_alias)
417 /* Device model IOC */
418 #define KVM_CREATE_IRQCHIP        _IO(KVMIO,  0x60)
419 #define KVM_IRQ_LINE              _IOW(KVMIO, 0x61, struct kvm_irq_level)
420 #define KVM_GET_IRQCHIP           _IOWR(KVMIO, 0x62, struct kvm_irqchip)
421 #define KVM_SET_IRQCHIP           _IOR(KVMIO,  0x63, struct kvm_irqchip)
422 #define KVM_CREATE_PIT            _IO(KVMIO,  0x64)
423 #define KVM_GET_PIT               _IOWR(KVMIO, 0x65, struct kvm_pit_state)
424 #define KVM_SET_PIT               _IOR(KVMIO,  0x66, struct kvm_pit_state)
425 #define KVM_REGISTER_COALESCED_MMIO \
426                         _IOW(KVMIO,  0x67, struct kvm_coalesced_mmio_zone)
427 #define KVM_UNREGISTER_COALESCED_MMIO \
428                         _IOW(KVMIO,  0x68, struct kvm_coalesced_mmio_zone)
429 #define KVM_ASSIGN_PCI_DEVICE _IOR(KVMIO, 0x69, \
430                                    struct kvm_assigned_pci_dev)
431 #define KVM_ASSIGN_IRQ _IOR(KVMIO, 0x70, \
432                             struct kvm_assigned_irq)
433
434 /*
435  * ioctls for vcpu fds
436  */
437 #define KVM_RUN                   _IO(KVMIO,   0x80)
438 #define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
439 #define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
440 #define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
441 #define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
442 #define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
443 #define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
444 #define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
445 #define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
446 #define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
447 #define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
448 #define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
449 #define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
450 #define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
451 #define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
452 #define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
453 #define KVM_SET_CPUID2            _IOW(KVMIO,  0x90, struct kvm_cpuid2)
454 #define KVM_GET_CPUID2            _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
455 /* Available with KVM_CAP_VAPIC */
456 #define KVM_TPR_ACCESS_REPORTING  _IOWR(KVMIO,  0x92, struct kvm_tpr_access_ctl)
457 /* Available with KVM_CAP_VAPIC */
458 #define KVM_SET_VAPIC_ADDR        _IOW(KVMIO,  0x93, struct kvm_vapic_addr)
459 /* valid for virtual machine (for floating interrupt)_and_ vcpu */
460 #define KVM_S390_INTERRUPT        _IOW(KVMIO,  0x94, struct kvm_s390_interrupt)
461 /* store status for s390 */
462 #define KVM_S390_STORE_STATUS_NOADDR    (-1ul)
463 #define KVM_S390_STORE_STATUS_PREFIXED  (-2ul)
464 #define KVM_S390_STORE_STATUS     _IOW(KVMIO,  0x95, unsigned long)
465 /* initial ipl psw for s390 */
466 #define KVM_S390_SET_INITIAL_PSW  _IOW(KVMIO,  0x96, struct kvm_s390_psw)
467 /* initial reset for s390 */
468 #define KVM_S390_INITIAL_RESET    _IO(KVMIO,  0x97)
469 #define KVM_GET_MP_STATE          _IOR(KVMIO,  0x98, struct kvm_mp_state)
470 #define KVM_SET_MP_STATE          _IOW(KVMIO,  0x99, struct kvm_mp_state)
471 /* Available with KVM_CAP_NMI */
472 #define KVM_NMI                   _IO(KVMIO,  0x9a)
473
474 #define KVM_TRC_INJ_VIRQ         (KVM_TRC_HANDLER + 0x02)
475 #define KVM_TRC_REDELIVER_EVT    (KVM_TRC_HANDLER + 0x03)
476 #define KVM_TRC_PEND_INTR        (KVM_TRC_HANDLER + 0x04)
477 #define KVM_TRC_IO_READ          (KVM_TRC_HANDLER + 0x05)
478 #define KVM_TRC_IO_WRITE         (KVM_TRC_HANDLER + 0x06)
479 #define KVM_TRC_CR_READ          (KVM_TRC_HANDLER + 0x07)
480 #define KVM_TRC_CR_WRITE         (KVM_TRC_HANDLER + 0x08)
481 #define KVM_TRC_DR_READ          (KVM_TRC_HANDLER + 0x09)
482 #define KVM_TRC_DR_WRITE         (KVM_TRC_HANDLER + 0x0A)
483 #define KVM_TRC_MSR_READ         (KVM_TRC_HANDLER + 0x0B)
484 #define KVM_TRC_MSR_WRITE        (KVM_TRC_HANDLER + 0x0C)
485 #define KVM_TRC_CPUID            (KVM_TRC_HANDLER + 0x0D)
486 #define KVM_TRC_INTR             (KVM_TRC_HANDLER + 0x0E)
487 #define KVM_TRC_NMI              (KVM_TRC_HANDLER + 0x0F)
488 #define KVM_TRC_VMMCALL          (KVM_TRC_HANDLER + 0x10)
489 #define KVM_TRC_HLT              (KVM_TRC_HANDLER + 0x11)
490 #define KVM_TRC_CLTS             (KVM_TRC_HANDLER + 0x12)
491 #define KVM_TRC_LMSW             (KVM_TRC_HANDLER + 0x13)
492 #define KVM_TRC_APIC_ACCESS      (KVM_TRC_HANDLER + 0x14)
493 #define KVM_TRC_TDP_FAULT        (KVM_TRC_HANDLER + 0x15)
494 #define KVM_TRC_GTLB_WRITE       (KVM_TRC_HANDLER + 0x16)
495 #define KVM_TRC_STLB_WRITE       (KVM_TRC_HANDLER + 0x17)
496 #define KVM_TRC_STLB_INVAL       (KVM_TRC_HANDLER + 0x18)
497 #define KVM_TRC_PPC_INSTR        (KVM_TRC_HANDLER + 0x19)
498
499 struct kvm_assigned_pci_dev {
500         __u32 assigned_dev_id;
501         __u32 busnr;
502         __u32 devfn;
503         __u32 flags;
504         union {
505                 __u32 reserved[12];
506         };
507 };
508
509 struct kvm_assigned_irq {
510         __u32 assigned_dev_id;
511         __u32 host_irq;
512         __u32 guest_irq;
513         __u32 flags;
514         union {
515                 struct {
516                         __u32 addr_lo;
517                         __u32 addr_hi;
518                         __u32 data;
519                 } guest_msi;
520                 __u32 reserved[12];
521         };
522 };
523
524 #define KVM_DEV_ASSIGN_ENABLE_IOMMU     (1 << 0)
525
526 #define KVM_DEV_IRQ_ASSIGN_ENABLE_MSI   (1 << 0)
527
528 #endif