[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>

#define KVM_API_VERSION 12

/* Architectural interrupt line count. */
#define KVM_NR_INTERRUPTS 256

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

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

struct kvm_memory_alias {
	__u32 slot;  /* this has a different namespace than memory slots */
	__u32 flags;
	__u64 guest_phys_addr;
	__u64 memory_size;
	__u64 target_phys_addr;
};

enum kvm_exit_reason {
	KVM_EXIT_UNKNOWN          = 0,
	KVM_EXIT_EXCEPTION        = 1,
	KVM_EXIT_IO               = 2,
	KVM_EXIT_HYPERCALL        = 3,
	KVM_EXIT_DEBUG            = 4,
	KVM_EXIT_HLT              = 5,
	KVM_EXIT_MMIO             = 6,
	KVM_EXIT_IRQ_WINDOW_OPEN  = 7,
	KVM_EXIT_SHUTDOWN         = 8,
	KVM_EXIT_FAIL_ENTRY       = 9,
	KVM_EXIT_INTR             = 10,
};

/* 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 args[6];
			__u64 ret;
			__u32 longmode;
			__u32 pad;
		} hypercall;
		/* Fix the size of the union. */
		char padding[256];
	};
};

/* for KVM_GET_REGS and KVM_SET_REGS */
struct kvm_regs {
	/* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
	__u64 rax, rbx, rcx, rdx;
	__u64 rsi, rdi, rsp, rbp;
	__u64 r8,  r9,  r10, r11;
	__u64 r12, r13, r14, r15;
	__u64 rip, rflags;
};

/* 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;
};

struct kvm_segment {
	__u64 base;
	__u32 limit;
	__u16 selector;
	__u8  type;
	__u8  present, dpl, db, s, l, g, avl;
	__u8  unusable;
	__u8  padding;
};

struct kvm_dtable {
	__u64 base;
	__u16 limit;
	__u16 padding[3];
};

/* for KVM_GET_SREGS and KVM_SET_SREGS */
struct kvm_sregs {
	/* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
	struct kvm_segment cs, ds, es, fs, gs, ss;
	struct kvm_segment tr, ldt;
	struct kvm_dtable gdt, idt;
	__u64 cr0, cr2, cr3, cr4, cr8;
	__u64 efer;
	__u64 apic_base;
	__u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
};

struct kvm_msr_entry {
	__u32 index;
	__u32 reserved;
	__u64 data;
};

/* for KVM_GET_MSRS and KVM_SET_MSRS */
struct kvm_msrs {
	__u32 nmsrs; /* number of msrs in entries */
	__u32 pad;

	struct kvm_msr_entry entries[0];
};

/* for KVM_GET_MSR_INDEX_LIST */
struct kvm_msr_list {
	__u32 nmsrs; /* number of msrs in entries */
	__u32 indices[0];
};

/* 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;
	};
};

struct kvm_cpuid_entry {
	__u32 function;
	__u32 eax;
	__u32 ebx;
	__u32 ecx;
	__u32 edx;
	__u32 padding;
};

/* for KVM_SET_CPUID */
struct kvm_cpuid {
	__u32 nent;
	__u32 padding;
	struct kvm_cpuid_entry entries[0];
};

/* 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 */

/*
 * ioctls for VM fds
 */
#define KVM_SET_MEMORY_REGION     _IOW(KVMIO, 0x40, struct kvm_memory_region)
/*
 * 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)

/*
 * 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)

#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>
	12
2ff81f70	13	#define KVM_API_VERSION 12
0b76e20b	14
9eb829ce	15	/* Architectural interrupt line count. */
6aa8b732	16	#define KVM_NR_INTERRUPTS 256
6aa8b732 AK	17
	18	/* for KVM_CREATE_MEMORY_REGION */
	19	struct kvm_memory_region {
	20	__u32 slot;
	21	__u32 flags;
	22	__u64 guest_phys_addr;
	23	__u64 memory_size; /* bytes */
	24	};
	25
	26	/* for kvm_memory_region::flags */
	27	#define KVM_MEM_LOG_DIRTY_PAGES 1UL
	28
e8207547 AK	29	struct kvm_memory_alias {
	30	__u32 slot; /* this has a different namespace than memory slots */
	31	__u32 flags;
	32	__u64 guest_phys_addr;
	33	__u64 memory_size;
	34	__u64 target_phys_addr;
	35	};
6aa8b732	36
6aa8b732 AK	37	enum kvm_exit_reason {
	38	KVM_EXIT_UNKNOWN = 0,
	39	KVM_EXIT_EXCEPTION = 1,
	40	KVM_EXIT_IO = 2,
b4e63f56	41	KVM_EXIT_HYPERCALL = 3,
6aa8b732 AK	42	KVM_EXIT_DEBUG = 4,
	43	KVM_EXIT_HLT = 5,
	44	KVM_EXIT_MMIO = 6,
c1150d8c	45	KVM_EXIT_IRQ_WINDOW_OPEN = 7,
46fe4ddd	46	KVM_EXIT_SHUTDOWN = 8,
8eb7d334	47	KVM_EXIT_FAIL_ENTRY = 9,
1b19f3e6	48	KVM_EXIT_INTR = 10,
6aa8b732 AK	49	};
6aa8b732 AK	50
9a2bb7f4	51	/* for KVM_RUN, returned by mmap(vcpu_fd, offset=0) */
6aa8b732 AK	52	struct kvm_run {
6aa8b732 AK	53	/* in */
c1150d8c	54	__u8 request_interrupt_window;
02c83209	55	__u8 padding1[7];
6aa8b732 AK	56
6aa8b732 AK	57	/* out */
6aa8b732	58	__u32 exit_reason;
c1150d8c DL	59	__u8 ready_for_interrupt_injection;
c1150d8c DL	60	__u8 if_flag;
2ff81f70	61	__u8 padding2[2];
54810342 DL	62
54810342 DL	63	/* in (pre_kvm_run), out (post_kvm_run) */
c1150d8c DL	64	__u64 cr8;
	65	__u64 apic_base;
	66
6aa8b732 AK	67	union {
	68	/* KVM_EXIT_UNKNOWN */
	69	struct {
8eb7d334	70	__u64 hardware_exit_reason;
6aa8b732	71	} hw;
8eb7d334 AK	72	/* KVM_EXIT_FAIL_ENTRY */
	73	struct {
	74	__u64 hardware_entry_failure_reason;
	75	} fail_entry;
6aa8b732 AK	76	/* KVM_EXIT_EXCEPTION */
	77	struct {
	78	__u32 exception;
	79	__u32 error_code;
	80	} ex;
	81	/* KVM_EXIT_IO */
46fc1477	82	struct kvm_io {
6aa8b732 AK	83	#define KVM_EXIT_IO_IN 0
	84	#define KVM_EXIT_IO_OUT 1
	85	__u8 direction;
	86	__u8 size; /* bytes */
6aa8b732	87	__u16 port;
039576c0 AK	88	__u32 count;
039576c0 AK	89	__u64 data_offset; /* relative to kvm_run start */
6aa8b732 AK	90	} io;
	91	struct {
	92	} debug;
	93	/* KVM_EXIT_MMIO */
	94	struct {
	95	__u64 phys_addr;
	96	__u8 data[8];
	97	__u32 len;
	98	__u8 is_write;
	99	} mmio;
b4e63f56 AK	100	/* KVM_EXIT_HYPERCALL */
	101	struct {
	102	__u64 args[6];
	103	__u64 ret;
	104	__u32 longmode;
	105	__u32 pad;
	106	} hypercall;
24cbc7e9 AK	107	/* Fix the size of the union. */
24cbc7e9 AK	108	char padding[256];
6aa8b732 AK	109	};
	110	};
	111
	112	/* for KVM_GET_REGS and KVM_SET_REGS */
	113	struct kvm_regs {
6aa8b732 AK	114	/* out (KVM_GET_REGS) / in (KVM_SET_REGS) */
	115	__u64 rax, rbx, rcx, rdx;
	116	__u64 rsi, rdi, rsp, rbp;
	117	__u64 r8, r9, r10, r11;
	118	__u64 r12, r13, r14, r15;
	119	__u64 rip, rflags;
	120	};
	121
b8836737 AK	122	/* for KVM_GET_FPU and KVM_SET_FPU */
	123	struct kvm_fpu {
	124	__u8 fpr[8][16];
	125	__u16 fcw;
	126	__u16 fsw;
	127	__u8 ftwx; /* in fxsave format */
	128	__u8 pad1;
	129	__u16 last_opcode;
	130	__u64 last_ip;
	131	__u64 last_dp;
	132	__u8 xmm[16][16];
	133	__u32 mxcsr;
	134	__u32 pad2;
	135	};
	136
6aa8b732 AK	137	struct kvm_segment {
	138	__u64 base;
	139	__u32 limit;
	140	__u16 selector;
	141	__u8 type;
	142	__u8 present, dpl, db, s, l, g, avl;
	143	__u8 unusable;
	144	__u8 padding;
	145	};
	146
	147	struct kvm_dtable {
	148	__u64 base;
	149	__u16 limit;
	150	__u16 padding[3];
	151	};
	152
	153	/* for KVM_GET_SREGS and KVM_SET_SREGS */
	154	struct kvm_sregs {
6aa8b732 AK	155	/* out (KVM_GET_SREGS) / in (KVM_SET_SREGS) */
	156	struct kvm_segment cs, ds, es, fs, gs, ss;
	157	struct kvm_segment tr, ldt;
	158	struct kvm_dtable gdt, idt;
	159	__u64 cr0, cr2, cr3, cr4, cr8;
	160	__u64 efer;
	161	__u64 apic_base;
9eb829ce	162	__u64 interrupt_bitmap[(KVM_NR_INTERRUPTS + 63) / 64];
6aa8b732 AK	163	};
	164
	165	struct kvm_msr_entry {
	166	__u32 index;
	167	__u32 reserved;
	168	__u64 data;
	169	};
	170
	171	/* for KVM_GET_MSRS and KVM_SET_MSRS */
	172	struct kvm_msrs {
6aa8b732	173	__u32 nmsrs; /* number of msrs in entries */
bccf2150	174	__u32 pad;
6aa8b732 AK	175
	176	struct kvm_msr_entry entries[0];
	177	};
	178
	179	/* for KVM_GET_MSR_INDEX_LIST */
	180	struct kvm_msr_list {
	181	__u32 nmsrs; /* number of msrs in entries */
	182	__u32 indices[0];
	183	};
	184
	185	/* for KVM_TRANSLATE */
	186	struct kvm_translation {
	187	/* in */
	188	__u64 linear_address;
6aa8b732 AK	189
	190	/* out */
	191	__u64 physical_address;
	192	__u8 valid;
	193	__u8 writeable;
	194	__u8 usermode;
8cd13307	195	__u8 pad[5];
6aa8b732 AK	196	};
	197
	198	/* for KVM_INTERRUPT */
	199	struct kvm_interrupt {
	200	/* in */
6aa8b732 AK	201	__u32 irq;
	202	};
	203
	204	struct kvm_breakpoint {
	205	__u32 enabled;
	206	__u32 padding;
	207	__u64 address;
	208	};
	209
	210	/* for KVM_DEBUG_GUEST */
	211	struct kvm_debug_guest {
	212	/* int */
6aa8b732	213	__u32 enabled;
bccf2150	214	__u32 pad;
6aa8b732 AK	215	struct kvm_breakpoint breakpoints[4];
	216	__u32 singlestep;
	217	};
	218
	219	/* for KVM_GET_DIRTY_LOG */
	220	struct kvm_dirty_log {
	221	__u32 slot;
	222	__u32 padding;
	223	union {
	224	void __user dirty_bitmap; / one bit per page */
	225	__u64 padding;
	226	};
	227	};
	228
06465c5a AK	229	struct kvm_cpuid_entry {
	230	__u32 function;
	231	__u32 eax;
	232	__u32 ebx;
	233	__u32 ecx;
	234	__u32 edx;
	235	__u32 padding;
	236	};
	237
	238	/* for KVM_SET_CPUID */
	239	struct kvm_cpuid {
	240	__u32 nent;
	241	__u32 padding;
	242	struct kvm_cpuid_entry entries[0];
	243	};
	244
1961d276 AK	245	/* for KVM_SET_SIGNAL_MASK */
	246	struct kvm_signal_mask {
	247	__u32 len;
	248	__u8 sigset[0];
	249	};
	250
6aa8b732 AK	251	#define KVMIO 0xAE
6aa8b732 AK	252
f17abe9a AK	253	/*
	254	* ioctls for /dev/kvm fds:
	255	*/
739872c5 AK	256	#define KVM_GET_API_VERSION _IO(KVMIO, 0x00)
	257	#define KVM_CREATE_VM _IO(KVMIO, 0x01) /* returns a VM fd */
	258	#define KVM_GET_MSR_INDEX_LIST _IOWR(KVMIO, 0x02, struct kvm_msr_list)
5d308f45 AK	259	/*
	260	* Check if a kvm extension is available. Argument is extension number,
	261	* return is 1 (yes) or 0 (no, sorry).
	262	*/
	263	#define KVM_CHECK_EXTENSION _IO(KVMIO, 0x03)
07c45a36 AK	264	/*
	265	* Get size for mmap(vcpu_fd)
	266	*/
	267	#define KVM_GET_VCPU_MMAP_SIZE _IO(KVMIO, 0x04) /* in bytes */
f17abe9a AK	268
	269	/*
	270	* ioctls for VM fds
	271	*/
739872c5	272	#define KVM_SET_MEMORY_REGION _IOW(KVMIO, 0x40, struct kvm_memory_region)
bccf2150 AK	273	/*
	274	* KVM_CREATE_VCPU receives as a parameter the vcpu slot, and returns
	275	* a vcpu fd.
	276	*/
739872c5 AK	277	#define KVM_CREATE_VCPU _IO(KVMIO, 0x41)
739872c5 AK	278	#define KVM_GET_DIRTY_LOG _IOW(KVMIO, 0x42, struct kvm_dirty_log)
e8207547	279	#define KVM_SET_MEMORY_ALIAS _IOW(KVMIO, 0x43, struct kvm_memory_alias)
bccf2150 AK	280
	281	/*
	282	* ioctls for vcpu fds
	283	*/
739872c5 AK	284	#define KVM_RUN _IO(KVMIO, 0x80)
	285	#define KVM_GET_REGS _IOR(KVMIO, 0x81, struct kvm_regs)
	286	#define KVM_SET_REGS _IOW(KVMIO, 0x82, struct kvm_regs)
	287	#define KVM_GET_SREGS _IOR(KVMIO, 0x83, struct kvm_sregs)
	288	#define KVM_SET_SREGS _IOW(KVMIO, 0x84, struct kvm_sregs)
	289	#define KVM_TRANSLATE _IOWR(KVMIO, 0x85, struct kvm_translation)
	290	#define KVM_INTERRUPT _IOW(KVMIO, 0x86, struct kvm_interrupt)
	291	#define KVM_DEBUG_GUEST _IOW(KVMIO, 0x87, struct kvm_debug_guest)
	292	#define KVM_GET_MSRS _IOWR(KVMIO, 0x88, struct kvm_msrs)
	293	#define KVM_SET_MSRS _IOW(KVMIO, 0x89, struct kvm_msrs)
	294	#define KVM_SET_CPUID _IOW(KVMIO, 0x8a, struct kvm_cpuid)
1961d276	295	#define KVM_SET_SIGNAL_MASK _IOW(KVMIO, 0x8b, struct kvm_signal_mask)
b8836737 AK	296	#define KVM_GET_FPU _IOR(KVMIO, 0x8c, struct kvm_fpu)
b8836737 AK	297	#define KVM_SET_FPU _IOW(KVMIO, 0x8d, struct kvm_fpu)
6aa8b732 AK	298
6aa8b732 AK	299	#endif