[mirror_ubuntu-zesty-kernel.git] / include / linux / kvm.h

#ifndef __LINUX_KVM_H
#define __LINUX_KVM_H

/*
 * Userspace interface for /dev/kvm - kernel based virtual machine
 *
 * Note: you must update KVM_API_VERSION if you change this interface.
 */

#include <asm/types.h>
#include <linux/ioctl.h>
#include <asm/kvm.h>

#define KVM_API_VERSION 12

/* for KVM_CREATE_MEMORY_REGION */
struct kvm_memory_region {
	__u32 slot;
	__u32 flags;
	__u64 guest_phys_addr;
	__u64 memory_size; /* bytes */
};

/* for KVM_SET_USER_MEMORY_REGION */
struct kvm_userspace_memory_region {
	__u32 slot;
	__u32 flags;
	__u64 guest_phys_addr;
	__u64 memory_size; /* bytes */
	__u64 userspace_addr; /* start of the userspace allocated memory */
};

/* for kvm_memory_region::flags */
#define KVM_MEM_LOG_DIRTY_PAGES  1UL


/* for KVM_IRQ_LINE */
struct kvm_irq_level {
	/*
	 * ACPI gsi notion of irq.
	 * For IA-64 (APIC model) IOAPIC0: irq 0-23; IOAPIC1: irq 24-47..
	 * For X86 (standard AT mode) PIC0/1: irq 0-15. IOAPIC0: 0-23..
	 */
	__u32 irq;
	__u32 level;
};


struct kvm_irqchip {
	__u32 chip_id;
	__u32 pad;
        union {
		char dummy[512];  /* reserving space */
#ifdef CONFIG_X86
		struct kvm_pic_state pic;
#endif
#if defined(CONFIG_X86) || defined(CONFIG_IA64)
		struct kvm_ioapic_state ioapic;
#endif
	} chip;
};

#define KVM_EXIT_UNKNOWN          0
#define KVM_EXIT_EXCEPTION        1
#define KVM_EXIT_IO               2
#define KVM_EXIT_HYPERCALL        3
#define KVM_EXIT_DEBUG            4
#define KVM_EXIT_HLT              5
#define KVM_EXIT_MMIO             6
#define KVM_EXIT_IRQ_WINDOW_OPEN  7
#define KVM_EXIT_SHUTDOWN         8
#define KVM_EXIT_FAIL_ENTRY       9
#define KVM_EXIT_INTR             10
#define KVM_EXIT_SET_TPR          11

/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
struct kvm_run {
	/* in */
	__u8 request_interrupt_window;
	__u8 padding1[7];

	/* out */
	__u32 exit_reason;
	__u8 ready_for_interrupt_injection;
	__u8 if_flag;
	__u8 padding2[2];

	/* in (pre_kvm_run), out (post_kvm_run) */
	__u64 cr8;
	__u64 apic_base;

	union {
		/* KVM_EXIT_UNKNOWN */
		struct {
			__u64 hardware_exit_reason;
		} hw;
		/* KVM_EXIT_FAIL_ENTRY */
		struct {
			__u64 hardware_entry_failure_reason;
		} fail_entry;
		/* KVM_EXIT_EXCEPTION */
		struct {
			__u32 exception;
			__u32 error_code;
		} ex;
		/* KVM_EXIT_IO */
		struct kvm_io {
#define KVM_EXIT_IO_IN  0
#define KVM_EXIT_IO_OUT 1
			__u8 direction;
			__u8 size; /* bytes */
			__u16 port;
			__u32 count;
			__u64 data_offset; /* relative to kvm_run start */
		} io;
		struct {
		} debug;
		/* KVM_EXIT_MMIO */
		struct {
			__u64 phys_addr;
			__u8  data[8];
			__u32 len;
			__u8  is_write;
		} mmio;
		/* KVM_EXIT_HYPERCALL */
		struct {
			__u64 nr;
			__u64 args[6];
			__u64 ret;
			__u32 longmode;
			__u32 pad;
		} hypercall;
		/* Fix the size of the union. */
		char padding[256];
	};
};


/* for KVM_GET_FPU and KVM_SET_FPU */
struct kvm_fpu {
	__u8  fpr[8][16];
	__u16 fcw;
	__u16 fsw;
	__u8  ftwx;  /* in fxsave format */
	__u8  pad1;
	__u16 last_opcode;
	__u64 last_ip;
	__u64 last_dp;
	__u8  xmm[16][16];
	__u32 mxcsr;
	__u32 pad2;
};


/* for KVM_TRANSLATE */
struct kvm_translation {
	/* in */
	__u64 linear_address;

	/* out */
	__u64 physical_address;
	__u8  valid;
	__u8  writeable;
	__u8  usermode;
	__u8  pad[5];
};

/* for KVM_INTERRUPT */
struct kvm_interrupt {
	/* in */
	__u32 irq;
};

struct kvm_breakpoint {
	__u32 enabled;
	__u32 padding;
	__u64 address;
};

/* for KVM_DEBUG_GUEST */
struct kvm_debug_guest {
	/* int */
	__u32 enabled;
	__u32 pad;
	struct kvm_breakpoint breakpoints[4];
	__u32 singlestep;
};

/* for KVM_GET_DIRTY_LOG */
struct kvm_dirty_log {
	__u32 slot;
	__u32 padding;
	union {
		void __user *dirty_bitmap; /* one bit per page */
		__u64 padding;
	};
};

/* for KVM_SET_SIGNAL_MASK */
struct kvm_signal_mask {
	__u32 len;
	__u8  sigset[0];
};

#define KVMIO 0xAE

/*
 * ioctls for /dev/kvm fds:
 */
#define KVM_GET_API_VERSION       _IO(KVMIO,   0x00)
#define KVM_CREATE_VM             _IO(KVMIO,   0x01) /* returns a VM fd */
#define KVM_GET_MSR_INDEX_LIST    _IOWR(KVMIO, 0x02, struct kvm_msr_list)
/*
 * Check if a kvm extension is available.  Argument is extension number,
 * return is 1 (yes) or 0 (no, sorry).
 */
#define KVM_CHECK_EXTENSION       _IO(KVMIO,   0x03)
/*
 * Get size for mmap(vcpu_fd)
 */
#define KVM_GET_VCPU_MMAP_SIZE    _IO(KVMIO,   0x04) /* in bytes */

/*
 * Extension capability list.
 */
#define KVM_CAP_IRQCHIP	  0
#define KVM_CAP_HLT	  1
#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
#define KVM_CAP_USER_MEMORY 3
#define KVM_CAP_SET_TSS_ADDR 4
#define KVM_CAP_EXT_CPUID 5

/*
 * ioctls for VM fds
 */
#define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
#define KVM_SET_NR_MMU_PAGES      _IO(KVMIO, 0x44)
#define KVM_GET_NR_MMU_PAGES      _IO(KVMIO, 0x45)
#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
					struct kvm_userspace_memory_region)
#define KVM_SET_TSS_ADDR          _IO(KVMIO, 0x47)
/*
 * KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
 * a vcpu fd.
 */
#define KVM_CREATE_VCPU           _IO(KVMIO,  0x41)
#define KVM_GET_DIRTY_LOG         _IOW(KVMIO, 0x42, struct kvm_dirty_log)
#define KVM_SET_MEMORY_ALIAS      _IOW(KVMIO, 0x43, struct kvm_memory_alias)
#define KVM_GET_SUPPORTED_CPUID   _IOWR(KVMIO, 0x48, struct kvm_cpuid2)
/* Device model IOC */
#define KVM_CREATE_IRQCHIP	  _IO(KVMIO,  0x60)
#define KVM_IRQ_LINE		  _IOW(KVMIO, 0x61, struct kvm_irq_level)
#define KVM_GET_IRQCHIP		  _IOWR(KVMIO, 0x62, struct kvm_irqchip)
#define KVM_SET_IRQCHIP		  _IOR(KVMIO,  0x63, struct kvm_irqchip)

/*
 * ioctls for vcpu fds
 */
#define KVM_RUN                   _IO(KVMIO,   0x80)
#define KVM_GET_REGS              _IOR(KVMIO,  0x81, struct kvm_regs)
#define KVM_SET_REGS              _IOW(KVMIO,  0x82, struct kvm_regs)
#define KVM_GET_SREGS             _IOR(KVMIO,  0x83, struct kvm_sregs)
#define KVM_SET_SREGS             _IOW(KVMIO,  0x84, struct kvm_sregs)
#define KVM_TRANSLATE             _IOWR(KVMIO, 0x85, struct kvm_translation)
#define KVM_INTERRUPT             _IOW(KVMIO,  0x86, struct kvm_interrupt)
#define KVM_DEBUG_GUEST           _IOW(KVMIO,  0x87, struct kvm_debug_guest)
#define KVM_GET_MSRS              _IOWR(KVMIO, 0x88, struct kvm_msrs)
#define KVM_SET_MSRS              _IOW(KVMIO,  0x89, struct kvm_msrs)
#define KVM_SET_CPUID             _IOW(KVMIO,  0x8a, struct kvm_cpuid)
#define KVM_SET_SIGNAL_MASK       _IOW(KVMIO,  0x8b, struct kvm_signal_mask)
#define KVM_GET_FPU               _IOR(KVMIO,  0x8c, struct kvm_fpu)
#define KVM_SET_FPU               _IOW(KVMIO,  0x8d, struct kvm_fpu)
#define KVM_GET_LAPIC             _IOR(KVMIO,  0x8e, struct kvm_lapic_state)
#define KVM_SET_LAPIC             _IOW(KVMIO,  0x8f, struct kvm_lapic_state)
#define KVM_SET_CPUID2            _IOW(KVMIO,  0x90, struct kvm_cpuid2)
#define KVM_GET_CPUID2            _IOWR(KVMIO, 0x91, struct kvm_cpuid2)

#endif
Commit	Line	Data
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>
f6a40e3b	12	#include <asm/kvm.h>
6aa8b732	13
2ff81f70	14	#define KVM_API_VERSION 12
0b76e20b	15
6aa8b732 AK	16	/* for KVM_CREATE_MEMORY_REGION */
	17	struct kvm_memory_region {
	18	__u32 slot;
	19	__u32 flags;
	20	__u64 guest_phys_addr;
	21	__u64 memory_size; /* bytes */
	22	};
	23
6fc138d2 IE	24	/* for KVM_SET_USER_MEMORY_REGION */
	25	struct 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
6aa8b732 AK	33	/* for kvm_memory_region::flags */
	34	#define KVM_MEM_LOG_DIRTY_PAGES 1UL
	35
	36
97222cc8	37	/* for KVM_IRQ_LINE */
85f455f7 ED	38	struct 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
6ceb9d79 HQ	48
	49	struct kvm_irqchip {
	50	__u32 chip_id;
	51	__u32 pad;
	52	union {
	53	char dummy[512]; /* reserving space */
51e29625	54	#ifdef CONFIG_X86
6ceb9d79	55	struct kvm_pic_state pic;
ec10f475 ZX	56	#endif
ec10f475 ZX	57	#if defined(CONFIG_X86) \|\| defined(CONFIG_IA64)
6bf9e962	58	struct kvm_ioapic_state ioapic;
51e29625	59	#endif
6ceb9d79 HQ	60	} chip;
	61	};
	62
8a45450d AK	63	#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
6aa8b732	75
9a2bb7f4	76	/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
6aa8b732 AK	77	struct kvm_run {
6aa8b732 AK	78	/* in */
c1150d8c	79	__u8 request_interrupt_window;
02c83209	80	__u8 padding1[7];
6aa8b732 AK	81
6aa8b732 AK	82	/* out */
6aa8b732	83	__u32 exit_reason;
c1150d8c DL	84	__u8 ready_for_interrupt_injection;
c1150d8c DL	85	__u8 if_flag;
2ff81f70	86	__u8 padding2[2];
54810342 DL	87
54810342 DL	88	/* in (pre_kvm_run), out (post_kvm_run) */
c1150d8c DL	89	__u64 cr8;
	90	__u64 apic_base;
	91
6aa8b732 AK	92	union {
	93	/* KVM_EXIT_UNKNOWN */
	94	struct {
8eb7d334	95	__u64 hardware_exit_reason;
6aa8b732	96	} hw;
8eb7d334 AK	97	/* KVM_EXIT_FAIL_ENTRY */
	98	struct {
	99	__u64 hardware_entry_failure_reason;
	100	} fail_entry;
6aa8b732 AK	101	/* KVM_EXIT_EXCEPTION */
	102	struct {
	103	__u32 exception;
	104	__u32 error_code;
	105	} ex;
	106	/* KVM_EXIT_IO */
46fc1477	107	struct kvm_io {
6aa8b732 AK	108	#define KVM_EXIT_IO_IN 0
	109	#define KVM_EXIT_IO_OUT 1
	110	__u8 direction;
	111	__u8 size; /* bytes */
6aa8b732	112	__u16 port;
039576c0 AK	113	__u32 count;
039576c0 AK	114	__u64 data_offset; /* relative to kvm_run start */
6aa8b732 AK	115	} io;
	116	struct {
	117	} debug;
	118	/* KVM_EXIT_MMIO */
	119	struct {
	120	__u64 phys_addr;
	121	__u8 data[8];
	122	__u32 len;
	123	__u8 is_write;
	124	} mmio;
b4e63f56 AK	125	/* KVM_EXIT_HYPERCALL */
b4e63f56 AK	126	struct {
519ef353	127	__u64 nr;
b4e63f56 AK	128	__u64 args[6];
	129	__u64 ret;
	130	__u32 longmode;
	131	__u32 pad;
	132	} hypercall;
24cbc7e9 AK	133	/* Fix the size of the union. */
24cbc7e9 AK	134	char padding[256];
6aa8b732 AK	135	};
	136	};
	137
6aa8b732	138
b8836737 AK	139	/* for KVM_GET_FPU and KVM_SET_FPU */
	140	struct kvm_fpu {
	141	__u8 fpr[8][16];
	142	__u16 fcw;
	143	__u16 fsw;
	144	__u8 ftwx; /* in fxsave format */
	145	__u8 pad1;
	146	__u16 last_opcode;
	147	__u64 last_ip;
	148	__u64 last_dp;
	149	__u8 xmm[16][16];
	150	__u32 mxcsr;
	151	__u32 pad2;
	152	};
	153
96ad2cc6	154
6aa8b732 AK	155	/* for KVM_TRANSLATE */
	156	struct kvm_translation {
	157	/* in */
	158	__u64 linear_address;
6aa8b732 AK	159
	160	/* out */
	161	__u64 physical_address;
	162	__u8 valid;
	163	__u8 writeable;
	164	__u8 usermode;
8cd13307	165	__u8 pad[5];
6aa8b732 AK	166	};
	167
	168	/* for KVM_INTERRUPT */
	169	struct kvm_interrupt {
	170	/* in */
6aa8b732 AK	171	__u32 irq;
	172	};
	173
	174	struct kvm_breakpoint {
	175	__u32 enabled;
	176	__u32 padding;
	177	__u64 address;
	178	};
	179
	180	/* for KVM_DEBUG_GUEST */
	181	struct kvm_debug_guest {
	182	/* int */
6aa8b732	183	__u32 enabled;
bccf2150	184	__u32 pad;
6aa8b732 AK	185	struct kvm_breakpoint breakpoints[4];
	186	__u32 singlestep;
	187	};
	188
	189	/* for KVM_GET_DIRTY_LOG */
	190	struct 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
1961d276 AK	199	/* for KVM_SET_SIGNAL_MASK */
	200	struct kvm_signal_mask {
	201	__u32 len;
	202	__u8 sigset[0];
	203	};
	204
6aa8b732 AK	205	#define KVMIO 0xAE
6aa8b732 AK	206
f17abe9a AK	207	/*
	208	* ioctls for /dev/kvm fds:
	209	*/
739872c5 AK	210	#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
	211	#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
	212	#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
5d308f45 AK	213	/*
	214	* Check if a kvm extension is available. Argument is extension number,
	215	* return is 1 (yes) or 0 (no, sorry).
	216	*/
	217	#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
07c45a36 AK	218	/*
	219	* Get size for mmap(vcpu_fd)
	220	*/
	221	#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
f17abe9a	222
85f455f7 ED	223	/*
	224	* Extension capability list.
	225	*/
	226	#define KVM_CAP_IRQCHIP 0
b6958ce4	227	#define KVM_CAP_HLT 1
82ce2c96	228	#define KVM_CAP_MMU_SHADOW_CACHE_CONTROL 2
6fc138d2	229	#define KVM_CAP_USER_MEMORY 3
cbc94022	230	#define KVM_CAP_SET_TSS_ADDR 4
07716717	231	#define KVM_CAP_EXT_CPUID 5
85f455f7	232
f17abe9a AK	233	/*
	234	* ioctls for VM fds
	235	*/
739872c5	236	#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
82ce2c96 IE	237	#define KVM_SET_NR_MMU_PAGES _IO(KVMIO, 0x44)
82ce2c96 IE	238	#define KVM_GET_NR_MMU_PAGES _IO(KVMIO, 0x45)
6fc138d2 IE	239	#define KVM_SET_USER_MEMORY_REGION _IOW(KVMIO, 0x46,\
6fc138d2 IE	240	struct kvm_userspace_memory_region)
cbc94022	241	#define KVM_SET_TSS_ADDR _IO(KVMIO, 0x47)
bccf2150 AK	242	/*
	243	* KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
	244	* a vcpu fd.
	245	*/
739872c5 AK	246	#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
739872c5 AK	247	#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
e8207547	248	#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
07716717	249	#define KVM_GET_SUPPORTED_CPUID _IOWR(KVMIO, 0x48, struct kvm_cpuid2)
85f455f7 ED	250	/* Device model IOC */
85f455f7 ED	251	#define KVM_CREATE_IRQCHIP _IO(KVMIO, 0x60)
97222cc8	252	#define KVM_IRQ_LINE _IOW(KVMIO, 0x61, struct kvm_irq_level)
6ceb9d79 HQ	253	#define KVM_GET_IRQCHIP _IOWR(KVMIO, 0x62, struct kvm_irqchip)
6ceb9d79 HQ	254	#define KVM_SET_IRQCHIP _IOR(KVMIO, 0x63, struct kvm_irqchip)
bccf2150 AK	255
	256	/*
	257	* ioctls for vcpu fds
	258	*/
739872c5 AK	259	#define KVM_RUN _IO(KVMIO, 0x80)
	260	#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
	261	#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
	262	#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
	263	#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
	264	#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
	265	#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
	266	#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
	267	#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
	268	#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
	269	#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
1961d276	270	#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
b8836737 AK	271	#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
b8836737 AK	272	#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
96ad2cc6 ED	273	#define KVM_GET_LAPIC _IOR(KVMIO, 0x8e, struct kvm_lapic_state)
96ad2cc6 ED	274	#define KVM_SET_LAPIC _IOW(KVMIO, 0x8f, struct kvm_lapic_state)
07716717 DK	275	#define KVM_SET_CPUID2 _IOW(KVMIO, 0x90, struct kvm_cpuid2)
07716717 DK	276	#define KVM_GET_CPUID2 _IOWR(KVMIO, 0x91, struct kvm_cpuid2)
6aa8b732 AK	277
6aa8b732 AK	278	#endif