[mirror_ubuntu-hirsute-kernel.git] / arch / x86 / include / asm / kvm_emulate.h

/* SPDX-License-Identifier: GPL-2.0 */
/******************************************************************************
 * 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;
enum x86_intercept;
enum x86_intercept_stage;

struct x86_exception {
	u8 vector;
	bool error_code_valid;
	u16 error_code;
	bool nested_page_fault;
	u64 address; /* cr2 or nested page fault gpa */
	u8 async_page_fault;
};

/*
 * This struct is used to carry enough information from the instruction
 * decoder to main KVM so that a decision can be made whether the
 * instruction needs to be intercepted or not.
 */
struct x86_instruction_info {
	u8  intercept;          /* which intercept                      */
	u8  rep_prefix;         /* rep prefix?                          */
	u8  modrm_mod;		/* mod part of modrm			*/
	u8  modrm_reg;          /* index of register used               */
	u8  modrm_rm;		/* rm part of modrm			*/
	u64 src_val;            /* value of source operand              */
	u64 dst_val;            /* value of destination operand         */
	u8  src_bytes;          /* size of source operand               */
	u8  dst_bytes;          /* size of destination operand          */
	u8  ad_bytes;           /* size of src/dst address              */
	u64 next_rip;           /* rip following the instruction        */
};

/*
 * 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     3 /* retry the instruction for some reason */
#define X86EMUL_CMPXCHG_FAILED  4 /* cmpxchg did not see expected value */
#define X86EMUL_IO_NEEDED       5 /* IO is needed to complete emulation */
#define X86EMUL_INTERCEPTED     6 /* Intercepted by nested VMCB/VMCS */

struct x86_emulate_ops {
	/*
	 * read_gpr: read a general purpose register (rax - r15)
	 *
	 * @reg: gpr number.
	 */
	ulong (*read_gpr)(struct x86_emulate_ctxt *ctxt, unsigned reg);
	/*
	 * write_gpr: write a general purpose register (rax - r15)
	 *
	 * @reg: gpr number.
	 * @val: value to write.
	 */
	void (*write_gpr)(struct x86_emulate_ctxt *ctxt, unsigned reg, ulong val);
	/*
	 * 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.
	 *  @system:[IN ] Whether the access is forced to be at CPL0.
	 */
	int (*read_std)(struct x86_emulate_ctxt *ctxt,
			unsigned long addr, void *val,
			unsigned int bytes,
			struct x86_exception *fault, bool system);

	/*
	 * read_phys: Read bytes of standard (non-emulated/special) memory.
	 *            Used for descriptor reading.
	 *  @addr:  [IN ] Physical address from which to read.
	 *  @val:   [OUT] Value read from memory.
	 *  @bytes: [IN ] Number of bytes to read from memory.
	 */
	int (*read_phys)(struct x86_emulate_ctxt *ctxt, unsigned long addr,
			void *val, unsigned int bytes);

	/*
	 * 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.
	 *  @system:[IN ] Whether the access is forced to be at CPL0.
	 */
	int (*write_std)(struct x86_emulate_ctxt *ctxt,
			 unsigned long addr, void *val, unsigned int bytes,
			 struct x86_exception *fault, bool system);
	/*
	 * 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)(struct x86_emulate_ctxt *ctxt,
		     unsigned long addr, void *val, unsigned int bytes,
		     struct x86_exception *fault);

	/*
	 * 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)(struct x86_emulate_ctxt *ctxt,
			     unsigned long addr, void *val, unsigned int bytes,
			     struct x86_exception *fault);

	/*
	 * 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)(struct x86_emulate_ctxt *ctxt,
			      unsigned long addr, const void *val,
			      unsigned int bytes,
			      struct x86_exception *fault);

	/*
	 * 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)(struct x86_emulate_ctxt *ctxt,
				unsigned long addr,
				const void *old,
				const void *new,
				unsigned int bytes,
				struct x86_exception *fault);
	void (*invlpg)(struct x86_emulate_ctxt *ctxt, ulong addr);

	int (*pio_in_emulated)(struct x86_emulate_ctxt *ctxt,
			       int size, unsigned short port, void *val,
			       unsigned int count);

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

	bool (*get_segment)(struct x86_emulate_ctxt *ctxt, u16 *selector,
			    struct desc_struct *desc, u32 *base3, int seg);
	void (*set_segment)(struct x86_emulate_ctxt *ctxt, u16 selector,
			    struct desc_struct *desc, u32 base3, int seg);
	unsigned long (*get_cached_segment_base)(struct x86_emulate_ctxt *ctxt,
						 int seg);
	void (*get_gdt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
	void (*get_idt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
	void (*set_gdt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
	void (*set_idt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
	ulong (*get_cr)(struct x86_emulate_ctxt *ctxt, int cr);
	int (*set_cr)(struct x86_emulate_ctxt *ctxt, int cr, ulong val);
	int (*cpl)(struct x86_emulate_ctxt *ctxt);
	int (*get_dr)(struct x86_emulate_ctxt *ctxt, int dr, ulong *dest);
	int (*set_dr)(struct x86_emulate_ctxt *ctxt, int dr, ulong value);
	u64 (*get_smbase)(struct x86_emulate_ctxt *ctxt);
	void (*set_smbase)(struct x86_emulate_ctxt *ctxt, u64 smbase);
	int (*set_msr)(struct x86_emulate_ctxt *ctxt, u32 msr_index, u64 data);
	int (*get_msr)(struct x86_emulate_ctxt *ctxt, u32 msr_index, u64 *pdata);
	int (*check_pmc)(struct x86_emulate_ctxt *ctxt, u32 pmc);
	int (*read_pmc)(struct x86_emulate_ctxt *ctxt, u32 pmc, u64 *pdata);
	void (*halt)(struct x86_emulate_ctxt *ctxt);
	void (*wbinvd)(struct x86_emulate_ctxt *ctxt);
	int (*fix_hypercall)(struct x86_emulate_ctxt *ctxt);
	int (*intercept)(struct x86_emulate_ctxt *ctxt,
			 struct x86_instruction_info *info,
			 enum x86_intercept_stage stage);

	bool (*get_cpuid)(struct x86_emulate_ctxt *ctxt, u32 *eax, u32 *ebx,
			  u32 *ecx, u32 *edx, bool check_limit);
	void (*set_nmi_mask)(struct x86_emulate_ctxt *ctxt, bool masked);

	unsigned (*get_hflags)(struct x86_emulate_ctxt *ctxt);
	void (*set_hflags)(struct x86_emulate_ctxt *ctxt, unsigned hflags);
	int (*pre_leave_smm)(struct x86_emulate_ctxt *ctxt, u64 smbase);

};

typedef u32 __attribute__((vector_size(16))) sse128_t;

/* Type, address-of, and value of an instruction's operand. */
struct operand {
	enum { OP_REG, OP_MEM, OP_MEM_STR, OP_IMM, OP_XMM, OP_MM, OP_NONE } type;
	unsigned int bytes;
	unsigned int count;
	union {
		unsigned long orig_val;
		u64 orig_val64;
	};
	union {
		unsigned long *reg;
		struct segmented_address {
			ulong ea;
			unsigned seg;
		} mem;
		unsigned xmm;
		unsigned mm;
	} addr;
	union {
		unsigned long val;
		u64 val64;
		char valptr[sizeof(sse128_t)];
		sse128_t vec_val;
		u64 mm_val;
		void *data;
	};
};

struct fetch_cache {
	u8 data[15];
	u8 *ptr;
	u8 *end;
};

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

/* Execution mode, passed to the emulator. */
enum x86emul_mode {
	X86EMUL_MODE_REAL,	/* Real mode.             */
	X86EMUL_MODE_VM86,	/* Virtual 8086 mode.     */
	X86EMUL_MODE_PROT16,	/* 16-bit protected mode. */
	X86EMUL_MODE_PROT32,	/* 32-bit protected mode. */
	X86EMUL_MODE_PROT64,	/* 64-bit (long) mode.    */
};

/* These match some of the HF_* flags defined in kvm_host.h  */
#define X86EMUL_GUEST_MASK           (1 << 5) /* VCPU is in guest-mode */
#define X86EMUL_SMM_MASK             (1 << 6)
#define X86EMUL_SMM_INSIDE_NMI_MASK  (1 << 7)

struct x86_emulate_ctxt {
	const struct x86_emulate_ops *ops;

	/* Register state before/after emulation. */
	unsigned long eflags;
	unsigned long eip; /* eip before instruction emulation */
	/* Emulated execution mode, represented by an X86EMUL_MODE value. */
	enum x86emul_mode mode;

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

	bool perm_ok; /* do not check permissions if true */
	bool ud;	/* inject an #UD if host doesn't support insn */
	bool tf;	/* TF value before instruction (after for syscall/sysret) */

	bool have_exception;
	struct x86_exception exception;

	/*
	 * decode cache
	 */

	/* current opcode length in bytes */
	u8 opcode_len;
	u8 b;
	u8 intercept;
	u8 op_bytes;
	u8 ad_bytes;
	struct operand src;
	struct operand src2;
	struct operand dst;
	int (*execute)(struct x86_emulate_ctxt *ctxt);
	int (*check_perm)(struct x86_emulate_ctxt *ctxt);
	/*
	 * The following six fields are cleared together,
	 * the rest are initialized unconditionally in x86_decode_insn
	 * or elsewhere
	 */
	bool rip_relative;
	u8 rex_prefix;
	u8 lock_prefix;
	u8 rep_prefix;
	/* bitmaps of registers in _regs[] that can be read */
	u32 regs_valid;
	/* bitmaps of registers in _regs[] that have been written */
	u32 regs_dirty;
	/* modrm */
	u8 modrm;
	u8 modrm_mod;
	u8 modrm_reg;
	u8 modrm_rm;
	u8 modrm_seg;
	u8 seg_override;
	u64 d;
	unsigned long _eip;
	struct operand memop;
	/* Fields above regs are cleared together. */
	unsigned long _regs[NR_VCPU_REGS];
	struct operand *memopp;
	struct fetch_cache fetch;
	struct read_cache io_read;
	struct read_cache mem_read;
};

/* Repeat String Operation Prefix */
#define REPE_PREFIX	0xf3
#define REPNE_PREFIX	0xf2

/* CPUID vendors */
#define X86EMUL_CPUID_VENDOR_AuthenticAMD_ebx 0x68747541
#define X86EMUL_CPUID_VENDOR_AuthenticAMD_ecx 0x444d4163
#define X86EMUL_CPUID_VENDOR_AuthenticAMD_edx 0x69746e65

#define X86EMUL_CPUID_VENDOR_AMDisbetterI_ebx 0x69444d41
#define X86EMUL_CPUID_VENDOR_AMDisbetterI_ecx 0x21726574
#define X86EMUL_CPUID_VENDOR_AMDisbetterI_edx 0x74656273

#define X86EMUL_CPUID_VENDOR_HygonGenuine_ebx 0x6f677948
#define X86EMUL_CPUID_VENDOR_HygonGenuine_ecx 0x656e6975
#define X86EMUL_CPUID_VENDOR_HygonGenuine_edx 0x6e65476e

#define X86EMUL_CPUID_VENDOR_GenuineIntel_ebx 0x756e6547
#define X86EMUL_CPUID_VENDOR_GenuineIntel_ecx 0x6c65746e
#define X86EMUL_CPUID_VENDOR_GenuineIntel_edx 0x49656e69

enum x86_intercept_stage {
	X86_ICTP_NONE = 0,   /* Allow zero-init to not match anything */
	X86_ICPT_PRE_EXCEPT,
	X86_ICPT_POST_EXCEPT,
	X86_ICPT_POST_MEMACCESS,
};

enum x86_intercept {
	x86_intercept_none,
	x86_intercept_cr_read,
	x86_intercept_cr_write,
	x86_intercept_clts,
	x86_intercept_lmsw,
	x86_intercept_smsw,
	x86_intercept_dr_read,
	x86_intercept_dr_write,
	x86_intercept_lidt,
	x86_intercept_sidt,
	x86_intercept_lgdt,
	x86_intercept_sgdt,
	x86_intercept_lldt,
	x86_intercept_sldt,
	x86_intercept_ltr,
	x86_intercept_str,
	x86_intercept_rdtsc,
	x86_intercept_rdpmc,
	x86_intercept_pushf,
	x86_intercept_popf,
	x86_intercept_cpuid,
	x86_intercept_rsm,
	x86_intercept_iret,
	x86_intercept_intn,
	x86_intercept_invd,
	x86_intercept_pause,
	x86_intercept_hlt,
	x86_intercept_invlpg,
	x86_intercept_invlpga,
	x86_intercept_vmrun,
	x86_intercept_vmload,
	x86_intercept_vmsave,
	x86_intercept_vmmcall,
	x86_intercept_stgi,
	x86_intercept_clgi,
	x86_intercept_skinit,
	x86_intercept_rdtscp,
	x86_intercept_icebp,
	x86_intercept_wbinvd,
	x86_intercept_monitor,
	x86_intercept_mwait,
	x86_intercept_rdmsr,
	x86_intercept_wrmsr,
	x86_intercept_in,
	x86_intercept_ins,
	x86_intercept_out,
	x86_intercept_outs,

	nr_x86_intercepts
};

/* 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, void *insn, int insn_len);
bool x86_page_table_writing_insn(struct x86_emulate_ctxt *ctxt);
#define EMULATION_FAILED -1
#define EMULATION_OK 0
#define EMULATION_RESTART 1
#define EMULATION_INTERCEPTED 2
void init_decode_cache(struct x86_emulate_ctxt *ctxt);
int x86_emulate_insn(struct x86_emulate_ctxt *ctxt);
int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
			 u16 tss_selector, int idt_index, int reason,
			 bool has_error_code, u32 error_code);
int emulate_int_real(struct x86_emulate_ctxt *ctxt, int irq);
void emulator_invalidate_register_cache(struct x86_emulate_ctxt *ctxt);
void emulator_writeback_register_cache(struct x86_emulate_ctxt *ctxt);
bool emulator_can_use_gpa(struct x86_emulate_ctxt *ctxt);

#endif /* _ASM_X86_KVM_X86_EMULATE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
6aa8b732 AK	2	/******************************************************************************
	3	* x86_emulate.h
	4	*
	5	* Generic x86 (32-bit and 64-bit) instruction decoder and emulator.
	6	*
	7	* Copyright (c) 2005 Keir Fraser
	8	*
	9	* From: xen-unstable 10676:af9809f51f81a3c43f276f00c81a52ef558afda4
	10	*/
	11
1965aae3 PA	12	#ifndef _ASM_X86_KVM_X86_EMULATE_H
1965aae3 PA	13	#define _ASM_X86_KVM_X86_EMULATE_H
6aa8b732	14
38ba30ba GN	15	#include <asm/desc_defs.h>
38ba30ba GN	16
6aa8b732	17	struct x86_emulate_ctxt;
c4f035c6 AK	18	enum x86_intercept;
c4f035c6 AK	19	enum x86_intercept_stage;
6aa8b732	20
da9cb575 AK	21	struct x86_exception {
	22	u8 vector;
	23	bool error_code_valid;
	24	u16 error_code;
6389ee94 AK	25	bool nested_page_fault;
6389ee94 AK	26	u64 address; /* cr2 or nested page fault gpa */
adfe20fb	27	u8 async_page_fault;
da9cb575 AK	28	};
da9cb575 AK	29
8a76d7f2 JR	30	/*
	31	* This struct is used to carry enough information from the instruction
	32	* decoder to main KVM so that a decision can be made whether the
	33	* instruction needs to be intercepted or not.
	34	*/
	35	struct x86_instruction_info {
	36	u8 intercept; /* which intercept */
	37	u8 rep_prefix; /* rep prefix? */
	38	u8 modrm_mod; /* mod part of modrm */
	39	u8 modrm_reg; /* index of register used */
	40	u8 modrm_rm; /* rm part of modrm */
	41	u64 src_val; /* value of source operand */
6cbc5f5a	42	u64 dst_val; /* value of destination operand */
8a76d7f2 JR	43	u8 src_bytes; /* size of source operand */
	44	u8 dst_bytes; /* size of destination operand */
	45	u8 ad_bytes; /* size of src/dst address */
	46	u64 next_rip; /* rip following the instruction */
	47	};
	48
6aa8b732 AK	49	/*
	50	* x86_emulate_ops:
	51	*
	52	* These operations represent the instruction emulator's interface to memory.
	53	* There are two categories of operation: those that act on ordinary memory
	54	* regions (*_std), and those that act on memory regions known to require
	55	* special treatment or emulation (*_emulated).
	56	*
	57	* The emulator assumes that an instruction accesses only one 'emulated memory'
	58	* location, that this location is the given linear faulting address (cr2), and
	59	* that this is one of the instruction's data operands. Instruction fetches and
	60	* stack operations are assumed never to access emulated memory. The emulator
	61	* automatically deduces which operand of a string-move operation is accessing
	62	* emulated memory, and assumes that the other operand accesses normal memory.
	63	*
	64	* NOTES:
	65	* 1. The emulator isn't very smart about emulated vs. standard memory.
	66	* 'Emulated memory' access addresses should be checked for sanity.
	67	* 'Normal memory' accesses may fault, and the caller must arrange to
	68	* detect and handle reentrancy into the emulator via recursive faults.
	69	* Accesses may be unaligned and may cross page boundaries.
	70	* 2. If the access fails (cannot emulate, or a standard access faults) then
	71	* it is up to the memop to propagate the fault to the guest VM via
	72	* some out-of-band mechanism, unknown to the emulator. The memop signals
	73	* failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will
	74	* then immediately bail.
	75	* 3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only
	76	* cmpxchg8b_emulated need support 8-byte accesses.
	77	* 4. The emulator cannot handle 64-bit mode emulation on an x86/32 system.
	78	*/
	79	/* Access completed successfully: continue emulation as normal. */
	80	#define X86EMUL_CONTINUE 0
	81	/* Access is unhandleable: bail from emulation and return error to caller. */
	82	#define X86EMUL_UNHANDLEABLE 1
	83	/* Terminate emulation but return success to the caller. */
	84	#define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */
e680080e GN	85	#define X86EMUL_RETRY_INSTR 3 /* retry the instruction for some reason */
e680080e GN	86	#define X86EMUL_CMPXCHG_FAILED 4 /* cmpxchg did not see expected value */
c3cd7ffa	87	#define X86EMUL_IO_NEEDED 5 /* IO is needed to complete emulation */
c4f035c6	88	#define X86EMUL_INTERCEPTED 6 /* Intercepted by nested VMCB/VMCS */
e680080e	89
6aa8b732	90	struct x86_emulate_ops {
dd856efa AK	91	/*
	92	* read_gpr: read a general purpose register (rax - r15)
	93	*
	94	* @reg: gpr number.
	95	*/
	96	ulong (read_gpr)(struct x86_emulate_ctxt ctxt, unsigned reg);
	97	/*
	98	* write_gpr: write a general purpose register (rax - r15)
	99	*
	100	* @reg: gpr number.
	101	* @val: value to write.
	102	*/
	103	void (write_gpr)(struct x86_emulate_ctxt ctxt, unsigned reg, ulong val);
6aa8b732 AK	104	/*
6aa8b732 AK	105	* read_std: Read bytes of standard (non-emulated/special) memory.
1871c602	106	* Used for descriptor reading.
6aa8b732 AK	107	* @addr: [IN ] Linear address from which to read.
	108	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	109	* @bytes: [IN ] Number of bytes to read from memory.
3c9fa24c	110	* @system:[IN ] Whether the access is forced to be at CPL0.
6aa8b732	111	*/
0f65dd70 AK	112	int (read_std)(struct x86_emulate_ctxt ctxt,
	113	unsigned long addr, void *val,
	114	unsigned int bytes,
3c9fa24c	115	struct x86_exception *fault, bool system);
1871c602	116
7a036a6f RK	117	/*
	118	* read_phys: Read bytes of standard (non-emulated/special) memory.
	119	* Used for descriptor reading.
	120	* @addr: [IN ] Physical address from which to read.
	121	* @val: [OUT] Value read from memory.
	122	* @bytes: [IN ] Number of bytes to read from memory.
	123	*/
	124	int (read_phys)(struct x86_emulate_ctxt ctxt, unsigned long addr,
	125	void *val, unsigned int bytes);
	126
2dafc6c2 GN	127	/*
	128	* write_std: Write bytes of standard (non-emulated/special) memory.
	129	* Used for descriptor writing.
	130	* @addr: [IN ] Linear address to which to write.
	131	* @val: [OUT] Value write to memory, zero-extended to 'u_long'.
	132	* @bytes: [IN ] Number of bytes to write to memory.
3c9fa24c	133	* @system:[IN ] Whether the access is forced to be at CPL0.
2dafc6c2	134	*/
0f65dd70 AK	135	int (write_std)(struct x86_emulate_ctxt ctxt,
0f65dd70 AK	136	unsigned long addr, void *val, unsigned int bytes,
3c9fa24c	137	struct x86_exception *fault, bool system);
1871c602 GN	138	/*
	139	* fetch: Read bytes of standard (non-emulated/special) memory.
	140	* Used for instruction fetch.
	141	* @addr: [IN ] Linear address from which to read.
	142	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	143	* @bytes: [IN ] Number of bytes to read from memory.
	144	*/
0f65dd70 AK	145	int (fetch)(struct x86_emulate_ctxt ctxt,
0f65dd70 AK	146	unsigned long addr, void *val, unsigned int bytes,
bcc55cba	147	struct x86_exception *fault);
6aa8b732 AK	148
	149	/*
	150	* read_emulated: Read bytes from emulated/special memory area.
	151	* @addr: [IN ] Linear address from which to read.
	152	* @val: [OUT] Value read from memory, zero-extended to 'u_long'.
	153	* @bytes: [IN ] Number of bytes to read from memory.
	154	*/
0f65dd70 AK	155	int (read_emulated)(struct x86_emulate_ctxt ctxt,
	156	unsigned long addr, void *val, unsigned int bytes,
	157	struct x86_exception *fault);
6aa8b732 AK	158
6aa8b732 AK	159	/*
0d178975	160	* write_emulated: Write bytes to emulated/special memory area.
6aa8b732 AK	161	* @addr: [IN ] Linear address to which to write.
	162	* @val: [IN ] Value to write to memory (low-order bytes used as
	163	* required).
	164	* @bytes: [IN ] Number of bytes to write to memory.
	165	*/
0f65dd70 AK	166	int (write_emulated)(struct x86_emulate_ctxt ctxt,
0f65dd70 AK	167	unsigned long addr, const void *val,
0c7825e6	168	unsigned int bytes,
0f65dd70	169	struct x86_exception *fault);
6aa8b732 AK	170
	171	/*
	172	* cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an
	173	* emulated/special memory area.
	174	* @addr: [IN ] Linear address to access.
	175	* @old: [IN ] Value expected to be current at @addr.
	176	* @new: [IN ] Value to write to @addr.
	177	* @bytes: [IN ] Number of bytes to access using CMPXCHG.
	178	*/
0f65dd70 AK	179	int (cmpxchg_emulated)(struct x86_emulate_ctxt ctxt,
0f65dd70 AK	180	unsigned long addr,
0c7825e6 JP	181	const void *old,
	182	const void *new,
	183	unsigned int bytes,
0f65dd70	184	struct x86_exception *fault);
3cb16fe7	185	void (invlpg)(struct x86_emulate_ctxt ctxt, ulong addr);
cf8f70bf	186
ca1d4a9e AK	187	int (pio_in_emulated)(struct x86_emulate_ctxt ctxt,
	188	int size, unsigned short port, void *val,
	189	unsigned int count);
cf8f70bf	190
ca1d4a9e AK	191	int (pio_out_emulated)(struct x86_emulate_ctxt ctxt,
	192	int size, unsigned short port, const void *val,
	193	unsigned int count);
cf8f70bf	194
1aa36616 AK	195	bool (get_segment)(struct x86_emulate_ctxt ctxt, u16 *selector,
	196	struct desc_struct desc, u32 base3, int seg);
	197	void (set_segment)(struct x86_emulate_ctxt ctxt, u16 selector,
	198	struct desc_struct *desc, u32 base3, int seg);
4bff1e86 AK	199	unsigned long (get_cached_segment_base)(struct x86_emulate_ctxt ctxt,
	200	int seg);
	201	void (get_gdt)(struct x86_emulate_ctxt ctxt, struct desc_ptr *dt);
	202	void (get_idt)(struct x86_emulate_ctxt ctxt, struct desc_ptr *dt);
1ac9d0cf AK	203	void (set_gdt)(struct x86_emulate_ctxt ctxt, struct desc_ptr *dt);
1ac9d0cf AK	204	void (set_idt)(struct x86_emulate_ctxt ctxt, struct desc_ptr *dt);
717746e3 AK	205	ulong (get_cr)(struct x86_emulate_ctxt ctxt, int cr);
	206	int (set_cr)(struct x86_emulate_ctxt ctxt, int cr, ulong val);
	207	int (cpl)(struct x86_emulate_ctxt ctxt);
	208	int (get_dr)(struct x86_emulate_ctxt ctxt, int dr, ulong *dest);
	209	int (set_dr)(struct x86_emulate_ctxt ctxt, int dr, ulong value);
64d60670 PB	210	u64 (get_smbase)(struct x86_emulate_ctxt ctxt);
64d60670 PB	211	void (set_smbase)(struct x86_emulate_ctxt ctxt, u64 smbase);
717746e3 AK	212	int (set_msr)(struct x86_emulate_ctxt ctxt, u32 msr_index, u64 data);
717746e3 AK	213	int (get_msr)(struct x86_emulate_ctxt ctxt, u32 msr_index, u64 *pdata);
67f4d428	214	int (check_pmc)(struct x86_emulate_ctxt ctxt, u32 pmc);
222d21aa	215	int (read_pmc)(struct x86_emulate_ctxt ctxt, u32 pmc, u64 *pdata);
6c3287f7	216	void (halt)(struct x86_emulate_ctxt ctxt);
bcaf5cc5	217	void (wbinvd)(struct x86_emulate_ctxt ctxt);
d6aa1000	218	int (fix_hypercall)(struct x86_emulate_ctxt ctxt);
2953538e	219	int (intercept)(struct x86_emulate_ctxt ctxt,
8a76d7f2	220	struct x86_instruction_info *info,
c4f035c6	221	enum x86_intercept_stage stage);
bdb42f5a	222
e911eb3b YZ	223	bool (get_cpuid)(struct x86_emulate_ctxt ctxt, u32 eax, u32 ebx,
e911eb3b YZ	224	u32 ecx, u32 edx, bool check_limit);
801806d9	225	void (set_nmi_mask)(struct x86_emulate_ctxt ctxt, bool masked);
6ed071f0 LP	226
	227	unsigned (get_hflags)(struct x86_emulate_ctxt ctxt);
	228	void (set_hflags)(struct x86_emulate_ctxt ctxt, unsigned hflags);
0234bf88 LP	229	int (pre_leave_smm)(struct x86_emulate_ctxt ctxt, u64 smbase);
0234bf88 LP	230
6aa8b732 AK	231	};
6aa8b732 AK	232
1253791d AK	233	typedef u32 __attribute__((vector_size(16))) sse128_t;
1253791d AK	234
e4e03ded LV	235	/* Type, address-of, and value of an instruction's operand. */
e4e03ded LV	236	struct operand {
b3356bf0	237	enum { OP_REG, OP_MEM, OP_MEM_STR, OP_IMM, OP_XMM, OP_MM, OP_NONE } type;
e4e03ded	238	unsigned int bytes;
b3356bf0	239	unsigned int count;
16518d5a AK	240	union {
	241	unsigned long orig_val;
	242	u64 orig_val64;
	243	};
1a6440ae AK	244	union {
1a6440ae AK	245	unsigned long *reg;
90de84f5 AK	246	struct segmented_address {
	247	ulong ea;
	248	unsigned seg;
	249	} mem;
1253791d	250	unsigned xmm;
cbe2c9d3	251	unsigned mm;
1a6440ae	252	} addr;
414e6277 GN	253	union {
414e6277 GN	254	unsigned long val;
16518d5a	255	u64 val64;
54cfdb3e	256	char valptr[sizeof(sse128_t)];
1253791d	257	sse128_t vec_val;
cbe2c9d3	258	u64 mm_val;
b3356bf0	259	void *data;
414e6277	260	};
e4e03ded LV	261	};
e4e03ded LV	262
62266869 AK	263	struct fetch_cache {
62266869 AK	264	u8 data[15];
17052f16 PB	265	u8 *ptr;
17052f16 PB	266	u8 *end;
62266869 AK	267	};
62266869 AK	268
7b262e90 GN	269	struct read_cache {
	270	u8 data[1024];
	271	unsigned long pos;
	272	unsigned long end;
	273	};
	274
9d1b39a9 GN	275	/* Execution mode, passed to the emulator. */
	276	enum x86emul_mode {
	277	X86EMUL_MODE_REAL, /* Real mode. */
	278	X86EMUL_MODE_VM86, /* Virtual 8086 mode. */
	279	X86EMUL_MODE_PROT16, /* 16-bit protected mode. */
	280	X86EMUL_MODE_PROT32, /* 32-bit protected mode. */
	281	X86EMUL_MODE_PROT64, /* 64-bit (long) mode. */
	282	};
	283
a584539b PB	284	/* These match some of the HF_* flags defined in kvm_host.h */
a584539b PB	285	#define X86EMUL_GUEST_MASK (1 << 5) /* VCPU is in guest-mode */
64d60670 PB	286	#define X86EMUL_SMM_MASK (1 << 6)
64d60670 PB	287	#define X86EMUL_SMM_INSIDE_NMI_MASK (1 << 7)
a584539b	288
9dac77fa	289	struct x86_emulate_ctxt {
0225fb50	290	const struct x86_emulate_ops *ops;
9dac77fa AK	291
	292	/* Register state before/after emulation. */
	293	unsigned long eflags;
	294	unsigned long eip; /* eip before instruction emulation */
	295	/* Emulated execution mode, represented by an X86EMUL_MODE value. */
9d1b39a9	296	enum x86emul_mode mode;
9dac77fa AK	297
	298	/* interruptibility state, as a result of execution of STI or MOV SS */
	299	int interruptibility;
	300
9dac77fa	301	bool perm_ok; /* do not check permissions if true */
b51e974f	302	bool ud; /* inject an #UD if host doesn't support insn */
c8401dda	303	bool tf; /* TF value before instruction (after for syscall/sysret) */
9dac77fa AK	304
	305	bool have_exception;
	306	struct x86_exception exception;
	307
1ce19dc1 BP	308	/*
	309	* decode cache
	310	*/
	311
	312	/* current opcode length in bytes */
	313	u8 opcode_len;
e4e03ded	314	u8 b;
c4f035c6	315	u8 intercept;
e4e03ded LV	316	u8 op_bytes;
	317	u8 ad_bytes;
	318	struct operand src;
0dc8d10f	319	struct operand src2;
e4e03ded	320	struct operand dst;
ef65c889	321	int (execute)(struct x86_emulate_ctxt ctxt);
d09beabd	322	int (check_perm)(struct x86_emulate_ctxt ctxt);
41061cdb BD	323	/*
	324	* The following six fields are cleared together,
	325	* the rest are initialized unconditionally in x86_decode_insn
	326	* or elsewhere
	327	*/
c44b4c6a BD	328	bool rip_relative;
	329	u8 rex_prefix;
	330	u8 lock_prefix;
	331	u8 rep_prefix;
c44b4c6a BD	332	/* bitmaps of registers in _regs[] that can be read */
	333	u32 regs_valid;
	334	/* bitmaps of registers in _regs[] that have been written */
	335	u32 regs_dirty;
e4e03ded LV	336	/* modrm */
	337	u8 modrm;
	338	u8 modrm_mod;
	339	u8 modrm_reg;
	340	u8 modrm_rm;
09ee57cd	341	u8 modrm_seg;
573e80fe	342	u8 seg_override;
c44b4c6a	343	u64 d;
36dd9bb5	344	unsigned long _eip;
cbd27ee7	345	struct operand memop;
b5c9ff73	346	/* Fields above regs are cleared together. */
dd856efa	347	unsigned long _regs[NR_VCPU_REGS];
f09ed83e	348	struct operand *memopp;
62266869	349	struct fetch_cache fetch;
7b262e90	350	struct read_cache io_read;
9de41573	351	struct read_cache mem_read;
e4e03ded LV	352	};
e4e03ded LV	353
90e0a28f	354	/* Repeat String Operation Prefix */
1d6b114f AK	355	#define REPE_PREFIX 0xf3
1d6b114f AK	356	#define REPNE_PREFIX 0xf2
90e0a28f	357
c2226fc9 SB	358	/* CPUID vendors */
	359	#define X86EMUL_CPUID_VENDOR_AuthenticAMD_ebx 0x68747541
	360	#define X86EMUL_CPUID_VENDOR_AuthenticAMD_ecx 0x444d4163
	361	#define X86EMUL_CPUID_VENDOR_AuthenticAMD_edx 0x69746e65
	362
	363	#define X86EMUL_CPUID_VENDOR_AMDisbetterI_ebx 0x69444d41
	364	#define X86EMUL_CPUID_VENDOR_AMDisbetterI_ecx 0x21726574
	365	#define X86EMUL_CPUID_VENDOR_AMDisbetterI_edx 0x74656273
	366
b8f4abb6 PW	367	#define X86EMUL_CPUID_VENDOR_HygonGenuine_ebx 0x6f677948
	368	#define X86EMUL_CPUID_VENDOR_HygonGenuine_ecx 0x656e6975
	369	#define X86EMUL_CPUID_VENDOR_HygonGenuine_edx 0x6e65476e
	370
c2226fc9 SB	371	#define X86EMUL_CPUID_VENDOR_GenuineIntel_ebx 0x756e6547
	372	#define X86EMUL_CPUID_VENDOR_GenuineIntel_ecx 0x6c65746e
	373	#define X86EMUL_CPUID_VENDOR_GenuineIntel_edx 0x49656e69
	374
c4f035c6	375	enum x86_intercept_stage {
40e19b51	376	X86_ICTP_NONE = 0, /* Allow zero-init to not match anything */
c4f035c6 AK	377	X86_ICPT_PRE_EXCEPT,
	378	X86_ICPT_POST_EXCEPT,
	379	X86_ICPT_POST_MEMACCESS,
	380	};
	381
	382	enum x86_intercept {
	383	x86_intercept_none,
cfec82cb JR	384	x86_intercept_cr_read,
	385	x86_intercept_cr_write,
	386	x86_intercept_clts,
3c6e276f AK	387	x86_intercept_lmsw,
3c6e276f AK	388	x86_intercept_smsw,
3b88e41a JR	389	x86_intercept_dr_read,
3b88e41a JR	390	x86_intercept_dr_write,
3c6e276f AK	391	x86_intercept_lidt,
	392	x86_intercept_sidt,
	393	x86_intercept_lgdt,
	394	x86_intercept_sgdt,
	395	x86_intercept_lldt,
	396	x86_intercept_sldt,
	397	x86_intercept_ltr,
	398	x86_intercept_str,
	399	x86_intercept_rdtsc,
	400	x86_intercept_rdpmc,
	401	x86_intercept_pushf,
	402	x86_intercept_popf,
	403	x86_intercept_cpuid,
	404	x86_intercept_rsm,
	405	x86_intercept_iret,
	406	x86_intercept_intn,
	407	x86_intercept_invd,
	408	x86_intercept_pause,
	409	x86_intercept_hlt,
	410	x86_intercept_invlpg,
	411	x86_intercept_invlpga,
	412	x86_intercept_vmrun,
	413	x86_intercept_vmload,
	414	x86_intercept_vmsave,
	415	x86_intercept_vmmcall,
	416	x86_intercept_stgi,
	417	x86_intercept_clgi,
	418	x86_intercept_skinit,
	419	x86_intercept_rdtscp,
	420	x86_intercept_icebp,
	421	x86_intercept_wbinvd,
	422	x86_intercept_monitor,
	423	x86_intercept_mwait,
8061252e JR	424	x86_intercept_rdmsr,
8061252e JR	425	x86_intercept_wrmsr,
f6511935 JR	426	x86_intercept_in,
	427	x86_intercept_ins,
	428	x86_intercept_out,
	429	x86_intercept_outs,
c4f035c6 AK	430
	431	nr_x86_intercepts
	432	};
	433
6aa8b732	434	/* Host execution mode. */
d73fa29a	435	#if defined(CONFIG_X86_32)
6aa8b732	436	#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32
05b3e0c2	437	#elif defined(CONFIG_X86_64)
6aa8b732 AK	438	#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64
	439	#endif
	440
dc25e89e	441	int x86_decode_insn(struct x86_emulate_ctxt ctxt, void insn, int insn_len);
1cb3f3ae	442	bool x86_page_table_writing_insn(struct x86_emulate_ctxt *ctxt);
d2ddd1c4 GN	443	#define EMULATION_FAILED -1
	444	#define EMULATION_OK 0
	445	#define EMULATION_RESTART 1
775fde86	446	#define EMULATION_INTERCEPTED 2
1498507a	447	void init_decode_cache(struct x86_emulate_ctxt *ctxt);
9aabc88f	448	int x86_emulate_insn(struct x86_emulate_ctxt *ctxt);
38ba30ba	449	int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
7f3d35fd	450	u16 tss_selector, int idt_index, int reason,
e269fb21	451	bool has_error_code, u32 error_code);
7b105ca2	452	int emulate_int_real(struct x86_emulate_ctxt *ctxt, int irq);
dd856efa AK	453	void emulator_invalidate_register_cache(struct x86_emulate_ctxt *ctxt);
dd856efa AK	454	void emulator_writeback_register_cache(struct x86_emulate_ctxt *ctxt);
0f89b207	455	bool emulator_can_use_gpa(struct x86_emulate_ctxt *ctxt);
dd856efa	456
1965aae3	457	#endif /* _ASM_X86_KVM_X86_EMULATE_H */