[deliverable/linux.git] / arch / x86 / include / asm / kvm_emulate.h

/******************************************************************************
 * x86_emulate.h
 *
 * Generic x86 (32-bit and 64-bit) instruction decoder and emulator.
 *
 * Copyright (c) 2005 Keir Fraser
 *
 * From: xen-unstable 10676:af9809f51f81a3c43f276f00c81a52ef558afda4
 */

#ifndef _ASM_X86_KVM_X86_EMULATE_H
#define _ASM_X86_KVM_X86_EMULATE_H

#include <asm/desc_defs.h>

struct x86_emulate_ctxt;

/*
 * x86_emulate_ops:
 *
 * These operations represent the instruction emulator's interface to memory.
 * There are two categories of operation: those that act on ordinary memory
 * regions (*_std), and those that act on memory regions known to require
 * special treatment or emulation (*_emulated).
 *
 * The emulator assumes that an instruction accesses only one 'emulated memory'
 * location, that this location is the given linear faulting address (cr2), and
 * that this is one of the instruction's data operands. Instruction fetches and
 * stack operations are assumed never to access emulated memory. The emulator
 * automatically deduces which operand of a string-move operation is accessing
 * emulated memory, and assumes that the other operand accesses normal memory.
 *
 * NOTES:
 *  1. The emulator isn't very smart about emulated vs. standard memory.
 *     'Emulated memory' access addresses should be checked for sanity.
 *     'Normal memory' accesses may fault, and the caller must arrange to
 *     detect and handle reentrancy into the emulator via recursive faults.
 *     Accesses may be unaligned and may cross page boundaries.
 *  2. If the access fails (cannot emulate, or a standard access faults) then
 *     it is up to the memop to propagate the fault to the guest VM via
 *     some out-of-band mechanism, unknown to the emulator. The memop signals
 *     failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will
 *     then immediately bail.
 *  3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only
 *     cmpxchg8b_emulated need support 8-byte accesses.
 *  4. The emulator cannot handle 64-bit mode emulation on an x86/32 system.
 */
/* Access completed successfully: continue emulation as normal. */
#define X86EMUL_CONTINUE        0
/* Access is unhandleable: bail from emulation and return error to caller. */
#define X86EMUL_UNHANDLEABLE    1
/* Terminate emulation but return success to the caller. */
#define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */
#define X86EMUL_RETRY_INSTR     2 /* retry the instruction for some reason */
#define X86EMUL_CMPXCHG_FAILED  2 /* cmpxchg did not see expected value */
struct x86_emulate_ops {
	/*
	 * read_std: Read bytes of standard (non-emulated/special) memory.
	 *           Used for descriptor reading.
	 *  @addr:  [IN ] Linear address from which to read.
	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
	 *  @bytes: [IN ] Number of bytes to read from memory.
	 */
	int (*read_std)(unsigned long addr, void *val,
			unsigned int bytes, struct kvm_vcpu *vcpu, u32 *error);

	/*
	 * write_std: Write bytes of standard (non-emulated/special) memory.
	 *            Used for descriptor writing.
	 *  @addr:  [IN ] Linear address to which to write.
	 *  @val:   [OUT] Value write to memory, zero-extended to 'u_long'.
	 *  @bytes: [IN ] Number of bytes to write to memory.
	 */
	int (*write_std)(unsigned long addr, void *val,
			 unsigned int bytes, struct kvm_vcpu *vcpu, u32 *error);
	/*
	 * fetch: Read bytes of standard (non-emulated/special) memory.
	 *        Used for instruction fetch.
	 *  @addr:  [IN ] Linear address from which to read.
	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
	 *  @bytes: [IN ] Number of bytes to read from memory.
	 */
	int (*fetch)(unsigned long addr, void *val,
			unsigned int bytes, struct kvm_vcpu *vcpu, u32 *error);

	/*
	 * read_emulated: Read bytes from emulated/special memory area.
	 *  @addr:  [IN ] Linear address from which to read.
	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
	 *  @bytes: [IN ] Number of bytes to read from memory.
	 */
	int (*read_emulated)(unsigned long addr,
			     void *val,
			     unsigned int bytes,
			     struct kvm_vcpu *vcpu);

	/*
	 * write_emulated: Write bytes to emulated/special memory area.
	 *  @addr:  [IN ] Linear address to which to write.
	 *  @val:   [IN ] Value to write to memory (low-order bytes used as
	 *                required).
	 *  @bytes: [IN ] Number of bytes to write to memory.
	 */
	int (*write_emulated)(unsigned long addr,
			      const void *val,
			      unsigned int bytes,
			      struct kvm_vcpu *vcpu);

	/*
	 * cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an
	 *                   emulated/special memory area.
	 *  @addr:  [IN ] Linear address to access.
	 *  @old:   [IN ] Value expected to be current at @addr.
	 *  @new:   [IN ] Value to write to @addr.
	 *  @bytes: [IN ] Number of bytes to access using CMPXCHG.
	 */
	int (*cmpxchg_emulated)(unsigned long addr,
				const void *old,
				const void *new,
				unsigned int bytes,
				struct kvm_vcpu *vcpu);

	int (*pio_in_emulated)(int size, unsigned short port, void *val,
			       unsigned int count, struct kvm_vcpu *vcpu);

	int (*pio_out_emulated)(int size, unsigned short port, const void *val,
				unsigned int count, struct kvm_vcpu *vcpu);

	bool (*get_cached_descriptor)(struct desc_struct *desc,
				      int seg, struct kvm_vcpu *vcpu);
	void (*set_cached_descriptor)(struct desc_struct *desc,
				      int seg, struct kvm_vcpu *vcpu);
	u16 (*get_segment_selector)(int seg, struct kvm_vcpu *vcpu);
	void (*set_segment_selector)(u16 sel, int seg, struct kvm_vcpu *vcpu);
	void (*get_gdt)(struct desc_ptr *dt, struct kvm_vcpu *vcpu);
	ulong (*get_cr)(int cr, struct kvm_vcpu *vcpu);
	void (*set_cr)(int cr, ulong val, struct kvm_vcpu *vcpu);
	int (*cpl)(struct kvm_vcpu *vcpu);
	void (*set_rflags)(struct kvm_vcpu *vcpu, unsigned long rflags);
};

/* Type, address-of, and value of an instruction's operand. */
struct operand {
	enum { OP_REG, OP_MEM, OP_IMM, OP_NONE } type;
	unsigned int bytes;
	unsigned long orig_val, *ptr;
	union {
		unsigned long val;
		char valptr[sizeof(unsigned long) + 2];
	};
};

struct fetch_cache {
	u8 data[15];
	unsigned long start;
	unsigned long end;
};

struct read_cache {
	u8 data[1024];
	unsigned long pos;
	unsigned long end;
};

struct decode_cache {
	u8 twobyte;
	u8 b;
	u8 lock_prefix;
	u8 rep_prefix;
	u8 op_bytes;
	u8 ad_bytes;
	u8 rex_prefix;
	struct operand src;
	struct operand src2;
	struct operand dst;
	bool has_seg_override;
	u8 seg_override;
	unsigned int d;
	unsigned long regs[NR_VCPU_REGS];
	unsigned long eip;
	/* modrm */
	u8 modrm;
	u8 modrm_mod;
	u8 modrm_reg;
	u8 modrm_rm;
	u8 use_modrm_ea;
	bool rip_relative;
	unsigned long modrm_ea;
	void *modrm_ptr;
	unsigned long modrm_val;
	struct fetch_cache fetch;
	struct read_cache io_read;
	struct read_cache mem_read;
};

struct x86_emulate_ctxt {
	/* Register state before/after emulation. */
	struct kvm_vcpu *vcpu;

	unsigned long eflags;
	unsigned long eip; /* eip before instruction emulation */
	/* Emulated execution mode, represented by an X86EMUL_MODE value. */
	int mode;
	u32 cs_base;

	/* interruptibility state, as a result of execution of STI or MOV SS */
	int interruptibility;

	bool restart; /* restart string instruction after writeback */
	/* decode cache */
	struct decode_cache decode;
};

/* Repeat String Operation Prefix */
#define REPE_PREFIX	1
#define REPNE_PREFIX	2

/* Execution mode, passed to the emulator. */
#define X86EMUL_MODE_REAL     0	/* Real mode.             */
#define X86EMUL_MODE_VM86     1	/* Virtual 8086 mode.     */
#define X86EMUL_MODE_PROT16   2	/* 16-bit protected mode. */
#define X86EMUL_MODE_PROT32   4	/* 32-bit protected mode. */
#define X86EMUL_MODE_PROT64   8	/* 64-bit (long) mode.    */

/* Host execution mode. */
#if defined(CONFIG_X86_32)
#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32
#elif defined(CONFIG_X86_64)
#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64
#endif

int x86_decode_insn(struct x86_emulate_ctxt *ctxt,
		    struct x86_emulate_ops *ops);
int x86_emulate_insn(struct x86_emulate_ctxt *ctxt,
		     struct x86_emulate_ops *ops);
int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
			 struct x86_emulate_ops *ops,
			 u16 tss_selector, int reason,
			 bool has_error_code, u32 error_code);

#endif /* _ASM_X86_KVM_X86_EMULATE_H */
Commit	Line	Data
6aa8b732 AK	1	/******************************************************************************
	2	* x86_emulate.h
	3	*
	4	* Generic x86 (32-bit and 64-bit) instruction decoder and emulator.
	5	*
	6	* Copyright (c) 2005 Keir Fraser
	7	*
	8	* From: xen-unstable 10676:af9809f51f81a3c43f276f00c81a52ef558afda4
	9	*/
	10
1965aae3 PA	11	#ifndef _ASM_X86_KVM_X86_EMULATE_H
1965aae3 PA	12	#define _ASM_X86_KVM_X86_EMULATE_H
6aa8b732	13
38ba30ba GN	14	#include <asm/desc_defs.h>
38ba30ba GN	15
6aa8b732 AK	16	struct x86_emulate_ctxt;
	17
	18	/*
	19	* x86_emulate_ops:
	20	*
	21	* These operations represent the instruction emulator's interface to memory.
	22	* There are two categories of operation: those that act on ordinary memory
	23	* regions (*_std), and those that act on memory regions known to require
	24	* special treatment or emulation (*_emulated).
	25	*
	26	* The emulator assumes that an instruction accesses only one 'emulated memory'
	27	* location, that this location is the given linear faulting address (cr2), and
	28	* that this is one of the instruction's data operands. Instruction fetches and
	29	* stack operations are assumed never to access emulated memory. The emulator
	30	* automatically deduces which operand of a string-move operation is accessing
	31	* emulated memory, and assumes that the other operand accesses normal memory.
	32	*
	33	* NOTES:
	34	* 1. The emulator isn't very smart about emulated vs. standard memory.
	35	* 'Emulated memory' access addresses should be checked for sanity.
	36	* 'Normal memory' accesses may fault, and the caller must arrange to
	37	* detect and handle reentrancy into the emulator via recursive faults.
	38	* Accesses may be unaligned and may cross page boundaries.
	39	* 2. If the access fails (cannot emulate, or a standard access faults) then
	40	* it is up to the memop to propagate the fault to the guest VM via
	41	* some out-of-band mechanism, unknown to the emulator. The memop signals
	42	* failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will
	43	* then immediately bail.
	44	* 3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only
	45	* cmpxchg8b_emulated need support 8-byte accesses.
	46	* 4. The emulator cannot handle 64-bit mode emulation on an x86/32 system.
	47	*/
	48	/* Access completed successfully: continue emulation as normal. */
	49	#define X86EMUL_CONTINUE 0
	50	/* Access is unhandleable: bail from emulation and return error to caller. */
	51	#define X86EMUL_UNHANDLEABLE 1
	52	/* Terminate emulation but return success to the caller. */
	53	#define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */
	54	#define X86EMUL_RETRY_INSTR 2 /* retry the instruction for some reason */
	55	#define X86EMUL_CMPXCHG_FAILED 2 /* cmpxchg did not see expected value */
	56	struct x86_emulate_ops {
	57	/*
	58	* read_std: Read bytes of standard (non-emulated/special) memory.
1871c602	59	* Used for descriptor reading.
6aa8b732 AK	60	* @addr: [IN ] Linear address from which to read.
	61	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	62	* @bytes: [IN ] Number of bytes to read from memory.
	63	*/
4c690a1e	64	int (read_std)(unsigned long addr, void val,
1871c602 GN	65	unsigned int bytes, struct kvm_vcpu vcpu, u32 error);
1871c602 GN	66
2dafc6c2 GN	67	/*
	68	* write_std: Write bytes of standard (non-emulated/special) memory.
	69	* Used for descriptor writing.
	70	* @addr: [IN ] Linear address to which to write.
	71	* @val: [OUT] Value write to memory, zero-extended to 'u_long'.
	72	* @bytes: [IN ] Number of bytes to write to memory.
	73	*/
	74	int (write_std)(unsigned long addr, void val,
	75	unsigned int bytes, struct kvm_vcpu vcpu, u32 error);
1871c602 GN	76	/*
	77	* fetch: Read bytes of standard (non-emulated/special) memory.
	78	* Used for instruction fetch.
	79	* @addr: [IN ] Linear address from which to read.
	80	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	81	* @bytes: [IN ] Number of bytes to read from memory.
	82	*/
	83	int (fetch)(unsigned long addr, void val,
	84	unsigned int bytes, struct kvm_vcpu vcpu, u32 error);
6aa8b732 AK	85
	86	/*
	87	* read_emulated: Read bytes from emulated/special memory area.
	88	* @addr: [IN ] Linear address from which to read.
	89	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	90	* @bytes: [IN ] Number of bytes to read from memory.
	91	*/
0c7825e6 JP	92	int (*read_emulated)(unsigned long addr,
	93	void *val,
	94	unsigned int bytes,
	95	struct kvm_vcpu *vcpu);
6aa8b732 AK	96
6aa8b732 AK	97	/*
0d178975	98	* write_emulated: Write bytes to emulated/special memory area.
6aa8b732 AK	99	* @addr: [IN ] Linear address to which to write.
	100	* @val: [IN ] Value to write to memory (low-order bytes used as
	101	* required).
	102	* @bytes: [IN ] Number of bytes to write to memory.
	103	*/
0c7825e6 JP	104	int (*write_emulated)(unsigned long addr,
	105	const void *val,
	106	unsigned int bytes,
	107	struct kvm_vcpu *vcpu);
6aa8b732 AK	108
	109	/*
	110	* cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an
	111	* emulated/special memory area.
	112	* @addr: [IN ] Linear address to access.
	113	* @old: [IN ] Value expected to be current at @addr.
	114	* @new: [IN ] Value to write to @addr.
	115	* @bytes: [IN ] Number of bytes to access using CMPXCHG.
	116	*/
0c7825e6 JP	117	int (*cmpxchg_emulated)(unsigned long addr,
	118	const void *old,
	119	const void *new,
	120	unsigned int bytes,
	121	struct kvm_vcpu *vcpu);
cf8f70bf GN	122
	123	int (pio_in_emulated)(int size, unsigned short port, void val,
	124	unsigned int count, struct kvm_vcpu *vcpu);
	125
	126	int (pio_out_emulated)(int size, unsigned short port, const void val,
	127	unsigned int count, struct kvm_vcpu *vcpu);
	128
2dafc6c2 GN	129	bool (get_cached_descriptor)(struct desc_struct desc,
	130	int seg, struct kvm_vcpu *vcpu);
	131	void (set_cached_descriptor)(struct desc_struct desc,
	132	int seg, struct kvm_vcpu *vcpu);
	133	u16 (get_segment_selector)(int seg, struct kvm_vcpu vcpu);
	134	void (set_segment_selector)(u16 sel, int seg, struct kvm_vcpu vcpu);
	135	void (get_gdt)(struct desc_ptr dt, struct kvm_vcpu *vcpu);
52a46617 GN	136	ulong (get_cr)(int cr, struct kvm_vcpu vcpu);
52a46617 GN	137	void (set_cr)(int cr, ulong val, struct kvm_vcpu vcpu);
9c537244	138	int (cpl)(struct kvm_vcpu vcpu);
482ac18a	139	void (set_rflags)(struct kvm_vcpu vcpu, unsigned long rflags);
6aa8b732 AK	140	};
6aa8b732 AK	141
e4e03ded LV	142	/* Type, address-of, and value of an instruction's operand. */
e4e03ded LV	143	struct operand {
a01af5ec	144	enum { OP_REG, OP_MEM, OP_IMM, OP_NONE } type;
e4e03ded	145	unsigned int bytes;
414e6277 GN	146	unsigned long orig_val, *ptr;
	147	union {
	148	unsigned long val;
	149	char valptr[sizeof(unsigned long) + 2];
	150	};
e4e03ded LV	151	};
e4e03ded LV	152
62266869 AK	153	struct fetch_cache {
	154	u8 data[15];
	155	unsigned long start;
	156	unsigned long end;
	157	};
	158
7b262e90 GN	159	struct read_cache {
	160	u8 data[1024];
	161	unsigned long pos;
	162	unsigned long end;
	163	};
	164
e4e03ded LV	165	struct decode_cache {
	166	u8 twobyte;
	167	u8 b;
	168	u8 lock_prefix;
	169	u8 rep_prefix;
	170	u8 op_bytes;
	171	u8 ad_bytes;
33615aa9	172	u8 rex_prefix;
e4e03ded	173	struct operand src;
0dc8d10f	174	struct operand src2;
e4e03ded	175	struct operand dst;
7a5b56df AK	176	bool has_seg_override;
7a5b56df AK	177	u8 seg_override;
e4e03ded LV	178	unsigned int d;
e4e03ded LV	179	unsigned long regs[NR_VCPU_REGS];
063db061	180	unsigned long eip;
e4e03ded LV	181	/* modrm */
	182	u8 modrm;
	183	u8 modrm_mod;
	184	u8 modrm_reg;
	185	u8 modrm_rm;
	186	u8 use_modrm_ea;
f5b4edcd	187	bool rip_relative;
e4e03ded	188	unsigned long modrm_ea;
107d6d2e	189	void *modrm_ptr;
e4e03ded	190	unsigned long modrm_val;
62266869	191	struct fetch_cache fetch;
7b262e90	192	struct read_cache io_read;
9de41573	193	struct read_cache mem_read;
e4e03ded LV	194	};
e4e03ded LV	195
6aa8b732 AK	196	struct x86_emulate_ctxt {
	197	/* Register state before/after emulation. */
	198	struct kvm_vcpu *vcpu;
	199
6aa8b732	200	unsigned long eflags;
063db061	201	unsigned long eip; /* eip before instruction emulation */
6aa8b732 AK	202	/* Emulated execution mode, represented by an X86EMUL_MODE value. */
6aa8b732 AK	203	int mode;
7a5b56df	204	u32 cs_base;
e4e03ded	205
310b5d30 GC	206	/* interruptibility state, as a result of execution of STI or MOV SS */
	207	int interruptibility;
	208
5cd21917	209	bool restart; /* restart string instruction after writeback */
e4e03ded	210	/* decode cache */
e4e03ded	211	struct decode_cache decode;
6aa8b732 AK	212	};
6aa8b732 AK	213
90e0a28f	214	/* Repeat String Operation Prefix */
d73fa29a SY	215	#define REPE_PREFIX 1
d73fa29a SY	216	#define REPNE_PREFIX 2
90e0a28f	217
6aa8b732 AK	218	/* Execution mode, passed to the emulator. */
6aa8b732 AK	219	#define X86EMUL_MODE_REAL 0 /* Real mode. */
a0044755	220	#define X86EMUL_MODE_VM86 1 /* Virtual 8086 mode. */
6aa8b732 AK	221	#define X86EMUL_MODE_PROT16 2 /* 16-bit protected mode. */
	222	#define X86EMUL_MODE_PROT32 4 /* 32-bit protected mode. */
	223	#define X86EMUL_MODE_PROT64 8 /* 64-bit (long) mode. */
	224
	225	/* Host execution mode. */
d73fa29a	226	#if defined(CONFIG_X86_32)
6aa8b732	227	#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32
05b3e0c2	228	#elif defined(CONFIG_X86_64)
6aa8b732 AK	229	#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64
	230	#endif
	231
1be3aa47 LV	232	int x86_decode_insn(struct x86_emulate_ctxt *ctxt,
	233	struct x86_emulate_ops *ops);
	234	int x86_emulate_insn(struct x86_emulate_ctxt *ctxt,
	235	struct x86_emulate_ops *ops);
38ba30ba GN	236	int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
38ba30ba GN	237	struct x86_emulate_ops *ops,
e269fb21 JK	238	u16 tss_selector, int reason,
e269fb21 JK	239	bool has_error_code, u32 error_code);
6aa8b732	240
1965aae3	241	#endif /* _ASM_X86_KVM_X86_EMULATE_H */