xref: /linux/arch/x86/kvm/kvm_emulate.h (revision c85aaff26d55920d783adac431a59ec738a35aef)
1 /* SPDX-License-Identifier: GPL-2.0 */
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 
12 #ifndef _ASM_X86_KVM_X86_EMULATE_H
13 #define _ASM_X86_KVM_X86_EMULATE_H
14 
15 #include <asm/desc_defs.h>
16 #include "fpu.h"
17 
18 struct x86_emulate_ctxt;
19 enum x86_intercept;
20 enum x86_intercept_stage;
21 
22 struct x86_exception {
23 	u8 vector;
24 	bool error_code_valid;
25 	u16 error_code;
26 	bool nested_page_fault;
27 	u64 address; /* cr2 or nested page fault gpa */
28 	u8 async_page_fault;
29 	unsigned long exit_qualification;
30 };
31 
32 /*
33  * This struct is used to carry enough information from the instruction
34  * decoder to main KVM so that a decision can be made whether the
35  * instruction needs to be intercepted or not.
36  */
37 struct x86_instruction_info {
38 	u8  intercept;          /* which intercept                      */
39 	u8  rep_prefix;         /* rep prefix?                          */
40 	u8  modrm_mod;		/* mod part of modrm			*/
41 	u8  modrm_reg;          /* index of register used               */
42 	u8  modrm_rm;		/* rm part of modrm			*/
43 	u64 src_val;            /* value of source operand              */
44 	u64 dst_val;            /* value of destination operand         */
45 	u8  src_bytes;          /* size of source operand               */
46 	u8  dst_bytes;          /* size of destination operand          */
47 	u8  src_type;		/* type of source operand		*/
48 	u8  dst_type;		/* type of destination operand		*/
49 	u8  ad_bytes;           /* size of src/dst address              */
50 	u64 rip;		/* rip of the instruction		*/
51 	u64 next_rip;           /* rip following the instruction        */
52 };
53 
54 /*
55  * x86_emulate_ops:
56  *
57  * These operations represent the instruction emulator's interface to memory.
58  * There are two categories of operation: those that act on ordinary memory
59  * regions (*_std), and those that act on memory regions known to require
60  * special treatment or emulation (*_emulated).
61  *
62  * The emulator assumes that an instruction accesses only one 'emulated memory'
63  * location, that this location is the given linear faulting address (cr2), and
64  * that this is one of the instruction's data operands. Instruction fetches and
65  * stack operations are assumed never to access emulated memory. The emulator
66  * automatically deduces which operand of a string-move operation is accessing
67  * emulated memory, and assumes that the other operand accesses normal memory.
68  *
69  * NOTES:
70  *  1. The emulator isn't very smart about emulated vs. standard memory.
71  *     'Emulated memory' access addresses should be checked for sanity.
72  *     'Normal memory' accesses may fault, and the caller must arrange to
73  *     detect and handle reentrancy into the emulator via recursive faults.
74  *     Accesses may be unaligned and may cross page boundaries.
75  *  2. If the access fails (cannot emulate, or a standard access faults) then
76  *     it is up to the memop to propagate the fault to the guest VM via
77  *     some out-of-band mechanism, unknown to the emulator. The memop signals
78  *     failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will
79  *     then immediately bail.
80  *  3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only
81  *     cmpxchg8b_emulated need support 8-byte accesses.
82  *  4. The emulator cannot handle 64-bit mode emulation on an x86/32 system.
83  */
84 /* Access completed successfully: continue emulation as normal. */
85 #define X86EMUL_CONTINUE        0
86 /* Access is unhandleable: bail from emulation and return error to caller. */
87 #define X86EMUL_UNHANDLEABLE    1
88 /* Terminate emulation but return success to the caller. */
89 #define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */
90 #define X86EMUL_RETRY_INSTR     3 /* retry the instruction for some reason */
91 #define X86EMUL_CMPXCHG_FAILED  4 /* cmpxchg did not see expected value */
92 #define X86EMUL_IO_NEEDED       5 /* IO is needed to complete emulation */
93 #define X86EMUL_INTERCEPTED     6 /* Intercepted by nested VMCB/VMCS */
94 /* Emulation during event vectoring is unhandleable. */
95 #define X86EMUL_UNHANDLEABLE_VECTORING	7
96 
97 /* x86-specific emulation flags */
98 #define X86EMUL_F_WRITE			BIT(0)
99 #define X86EMUL_F_FETCH			BIT(1)
100 #define X86EMUL_F_IMPLICIT		BIT(2)
101 #define X86EMUL_F_INVLPG		BIT(3)
102 #define X86EMUL_F_MSR			BIT(4)
103 #define X86EMUL_F_DT_LOAD		BIT(5)
104 
105 struct x86_emulate_ops {
106 	void (*vm_bugged)(struct x86_emulate_ctxt *ctxt);
107 	/*
108 	 * read_gpr: read a general purpose register (rax - r15)
109 	 *
110 	 * @reg: gpr number.
111 	 */
112 	ulong (*read_gpr)(struct x86_emulate_ctxt *ctxt, unsigned reg);
113 	/*
114 	 * write_gpr: write a general purpose register (rax - r15)
115 	 *
116 	 * @reg: gpr number.
117 	 * @val: value to write.
118 	 */
119 	void (*write_gpr)(struct x86_emulate_ctxt *ctxt, unsigned reg, ulong val);
120 	/*
121 	 * read_std: Read bytes of standard (non-emulated/special) memory.
122 	 *           Used for descriptor reading.
123 	 *  @addr:  [IN ] Linear address from which to read.
124 	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
125 	 *  @bytes: [IN ] Number of bytes to read from memory.
126 	 *  @system:[IN ] Whether the access is forced to be at CPL0.
127 	 */
128 	int (*read_std)(struct x86_emulate_ctxt *ctxt,
129 			unsigned long addr, void *val,
130 			unsigned int bytes,
131 			struct x86_exception *fault, bool system);
132 
133 	/*
134 	 * write_std: Write bytes of standard (non-emulated/special) memory.
135 	 *            Used for descriptor writing.
136 	 *  @addr:  [IN ] Linear address to which to write.
137 	 *  @val:   [OUT] Value write to memory, zero-extended to 'u_long'.
138 	 *  @bytes: [IN ] Number of bytes to write to memory.
139 	 *  @system:[IN ] Whether the access is forced to be at CPL0.
140 	 */
141 	int (*write_std)(struct x86_emulate_ctxt *ctxt,
142 			 unsigned long addr, void *val, unsigned int bytes,
143 			 struct x86_exception *fault, bool system);
144 	/*
145 	 * fetch: Read bytes of standard (non-emulated/special) memory.
146 	 *        Used for instruction fetch.
147 	 *  @addr:  [IN ] Linear address from which to read.
148 	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
149 	 *  @bytes: [IN ] Number of bytes to read from memory.
150 	 */
151 	int (*fetch)(struct x86_emulate_ctxt *ctxt,
152 		     unsigned long addr, void *val, unsigned int bytes,
153 		     struct x86_exception *fault);
154 
155 	/*
156 	 * read_emulated: Read bytes from emulated/special memory area.
157 	 *  @addr:  [IN ] Linear address from which to read.
158 	 *  @val:   [OUT] Value read from memory, zero-extended to 'u_long'.
159 	 *  @bytes: [IN ] Number of bytes to read from memory.
160 	 */
161 	int (*read_emulated)(struct x86_emulate_ctxt *ctxt,
162 			     unsigned long addr, void *val, unsigned int bytes,
163 			     struct x86_exception *fault);
164 
165 	/*
166 	 * write_emulated: Write bytes to emulated/special memory area.
167 	 *  @addr:  [IN ] Linear address to which to write.
168 	 *  @val:   [IN ] Value to write to memory (low-order bytes used as
169 	 *                required).
170 	 *  @bytes: [IN ] Number of bytes to write to memory.
171 	 */
172 	int (*write_emulated)(struct x86_emulate_ctxt *ctxt,
173 			      unsigned long addr, const void *val,
174 			      unsigned int bytes,
175 			      struct x86_exception *fault);
176 
177 	/*
178 	 * cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an
179 	 *                   emulated/special memory area.
180 	 *  @addr:  [IN ] Linear address to access.
181 	 *  @old:   [IN ] Value expected to be current at @addr.
182 	 *  @new:   [IN ] Value to write to @addr.
183 	 *  @bytes: [IN ] Number of bytes to access using CMPXCHG.
184 	 */
185 	int (*cmpxchg_emulated)(struct x86_emulate_ctxt *ctxt,
186 				unsigned long addr,
187 				const void *old,
188 				const void *new,
189 				unsigned int bytes,
190 				struct x86_exception *fault);
191 	void (*invlpg)(struct x86_emulate_ctxt *ctxt, ulong addr);
192 
193 	int (*pio_in_emulated)(struct x86_emulate_ctxt *ctxt,
194 			       int size, unsigned short port, void *val,
195 			       unsigned int count);
196 
197 	int (*pio_out_emulated)(struct x86_emulate_ctxt *ctxt,
198 				int size, unsigned short port, const void *val,
199 				unsigned int count);
200 
201 	bool (*get_segment)(struct x86_emulate_ctxt *ctxt, u16 *selector,
202 			    struct desc_struct *desc, u32 *base3, int seg);
203 	void (*set_segment)(struct x86_emulate_ctxt *ctxt, u16 selector,
204 			    struct desc_struct *desc, u32 base3, int seg);
205 	unsigned long (*get_cached_segment_base)(struct x86_emulate_ctxt *ctxt,
206 						 int seg);
207 	void (*get_gdt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
208 	void (*get_idt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
209 	void (*set_gdt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
210 	void (*set_idt)(struct x86_emulate_ctxt *ctxt, struct desc_ptr *dt);
211 	ulong (*get_cr)(struct x86_emulate_ctxt *ctxt, int cr);
212 	int (*set_cr)(struct x86_emulate_ctxt *ctxt, int cr, ulong val);
213 	int (*cpl)(struct x86_emulate_ctxt *ctxt);
214 	ulong (*get_dr)(struct x86_emulate_ctxt *ctxt, int dr);
215 	int (*set_dr)(struct x86_emulate_ctxt *ctxt, int dr, ulong value);
216 	int (*set_msr_with_filter)(struct x86_emulate_ctxt *ctxt, u32 msr_index, u64 data);
217 	int (*get_msr_with_filter)(struct x86_emulate_ctxt *ctxt, u32 msr_index, u64 *pdata);
218 	int (*get_msr)(struct x86_emulate_ctxt *ctxt, u32 msr_index, u64 *pdata);
219 	int (*check_rdpmc_early)(struct x86_emulate_ctxt *ctxt, u32 pmc);
220 	int (*read_pmc)(struct x86_emulate_ctxt *ctxt, u32 pmc, u64 *pdata);
221 	void (*halt)(struct x86_emulate_ctxt *ctxt);
222 	void (*wbinvd)(struct x86_emulate_ctxt *ctxt);
223 	int (*fix_hypercall)(struct x86_emulate_ctxt *ctxt);
224 	int (*intercept)(struct x86_emulate_ctxt *ctxt,
225 			 struct x86_instruction_info *info,
226 			 enum x86_intercept_stage stage);
227 
228 	bool (*get_cpuid)(struct x86_emulate_ctxt *ctxt, u32 *eax, u32 *ebx,
229 			  u32 *ecx, u32 *edx, bool exact_only);
230 	bool (*guest_has_movbe)(struct x86_emulate_ctxt *ctxt);
231 	bool (*guest_has_fxsr)(struct x86_emulate_ctxt *ctxt);
232 	bool (*guest_has_rdpid)(struct x86_emulate_ctxt *ctxt);
233 	bool (*guest_cpuid_is_intel_compatible)(struct x86_emulate_ctxt *ctxt);
234 
235 	void (*set_nmi_mask)(struct x86_emulate_ctxt *ctxt, bool masked);
236 
237 	bool (*is_smm)(struct x86_emulate_ctxt *ctxt);
238 	int (*leave_smm)(struct x86_emulate_ctxt *ctxt);
239 	void (*triple_fault)(struct x86_emulate_ctxt *ctxt);
240 	int (*get_xcr)(struct x86_emulate_ctxt *ctxt, u32 index, u64 *xcr);
241 	int (*set_xcr)(struct x86_emulate_ctxt *ctxt, u32 index, u64 xcr);
242 
243 	gva_t (*get_untagged_addr)(struct x86_emulate_ctxt *ctxt, gva_t addr,
244 				   unsigned int flags);
245 
246 	bool (*is_canonical_addr)(struct x86_emulate_ctxt *ctxt, gva_t addr,
247 				  unsigned int flags);
248 
249 	bool (*page_address_valid)(struct x86_emulate_ctxt *ctxt, gpa_t gpa);
250 };
251 
252 /* Type, address-of, and value of an instruction's operand. */
253 struct operand {
254 	enum { OP_REG, OP_MEM, OP_MEM_STR, OP_IMM, OP_XMM, OP_YMM, OP_MM, OP_NONE } type;
255 	unsigned int bytes;
256 	unsigned int count;
257 	union {
258 		unsigned long orig_val;
259 		u64 orig_val64;
260 	};
261 	union {
262 		unsigned long *reg;
263 		struct segmented_address {
264 			ulong ea;
265 			unsigned seg;
266 		} mem;
267 		unsigned xmm;
268 		unsigned mm;
269 	} addr;
270 	union {
271 		unsigned long val;
272 		u64 val64;
273 		char valptr[sizeof(avx256_t)];
274 		sse128_t vec_val;
275 		avx256_t vec_val2;
276 		u64 mm_val;
277 		void *data;
278 	} __aligned(32);
279 };
280 
281 #define X86_MAX_INSTRUCTION_LENGTH	15
282 
283 struct fetch_cache {
284 	u8 data[X86_MAX_INSTRUCTION_LENGTH];
285 	u8 *ptr;
286 	u8 *end;
287 };
288 
289 struct read_cache {
290 	u8 data[1024];
291 	unsigned long pos;
292 	unsigned long end;
293 };
294 
295 /* Execution mode, passed to the emulator. */
296 enum x86emul_mode {
297 	X86EMUL_MODE_REAL,	/* Real mode.             */
298 	X86EMUL_MODE_VM86,	/* Virtual 8086 mode.     */
299 	X86EMUL_MODE_PROT16,	/* 16-bit protected mode. */
300 	X86EMUL_MODE_PROT32,	/* 32-bit protected mode. */
301 	X86EMUL_MODE_PROT64,	/* 64-bit (long) mode.    */
302 };
303 
304 /*
305  * fastop functions are declared as taking a never-defined fastop parameter,
306  * so they can't be called from C directly.
307  */
308 struct fastop;
309 
310 typedef void (*fastop_t)(struct fastop *);
311 
312 /*
313  * The emulator's _regs array tracks only the GPRs, i.e. excludes RIP.  RIP is
314  * tracked/accessed via _eip, and except for RIP relative addressing, which
315  * also uses _eip, RIP cannot be a register operand nor can it be an operand in
316  * a ModRM or SIB byte.
317  */
318 #ifdef CONFIG_X86_64
319 #define NR_EMULATOR_GPRS	16
320 #else
321 #define NR_EMULATOR_GPRS	8
322 #endif
323 
324 /*
325  * Distinguish between no prefix, REX, or in the future REX2.
326  */
327 enum rex_type {
328 	REX_NONE,
329 	REX_PREFIX,
330 };
331 
332 struct x86_emulate_ctxt {
333 	void *vcpu;
334 	const struct x86_emulate_ops *ops;
335 
336 	/* Register state before/after emulation. */
337 	unsigned long eflags;
338 	unsigned long eip; /* eip before instruction emulation */
339 	/* Emulated execution mode, represented by an X86EMUL_MODE value. */
340 	enum x86emul_mode mode;
341 
342 	/* interruptibility state, as a result of execution of STI or MOV SS */
343 	int interruptibility;
344 
345 	bool perm_ok; /* do not check permissions if true */
346 	bool tf;	/* TF value before instruction (after for syscall/sysret) */
347 
348 	bool have_exception;
349 	struct x86_exception exception;
350 
351 	/* GPA available */
352 	bool gpa_available;
353 	gpa_t gpa_val;
354 
355 	/*
356 	 * decode cache
357 	 */
358 
359 	/* current opcode length in bytes */
360 	u8 opcode_len;
361 	u8 b;
362 	u8 intercept;
363 	bool op_prefix;
364 	u8 op_bytes;
365 	u8 ad_bytes;
366 	union {
367 		int (*execute)(struct x86_emulate_ctxt *ctxt);
368 		fastop_t fop;
369 	};
370 	int (*check_perm)(struct x86_emulate_ctxt *ctxt);
371 
372 	bool rip_relative;
373 	enum rex_type rex_prefix;
374 	u8 rex_bits;
375 	u8 lock_prefix;
376 	u8 rep_prefix;
377 	/* bitmaps of registers in _regs[] that can be read */
378 	u16 regs_valid;
379 	/* bitmaps of registers in _regs[] that have been written */
380 	u16 regs_dirty;
381 	/* modrm */
382 	u8 modrm;
383 	u8 modrm_mod;
384 	u8 modrm_reg;
385 	u8 modrm_rm;
386 	u8 modrm_seg;
387 	u8 seg_override;
388 	u64 d;
389 	unsigned long _eip;
390 
391 	/* Here begins the usercopy section. */
392 	struct operand src;
393 	struct operand src2;
394 	struct operand dst;
395 	struct operand memop;
396 	unsigned long _regs[NR_EMULATOR_GPRS];
397 	struct operand *memopp;
398 	struct fetch_cache fetch;
399 	struct read_cache io_read;
400 	struct read_cache mem_read;
401 	bool is_branch;
402 };
403 
404 #define KVM_EMULATOR_BUG_ON(cond, ctxt)		\
405 ({						\
406 	int __ret = (cond);			\
407 						\
408 	if (WARN_ON_ONCE(__ret))		\
409 		ctxt->ops->vm_bugged(ctxt);	\
410 	unlikely(__ret);			\
411 })
412 
413 /* Repeat String Operation Prefix */
414 #define REPE_PREFIX	0xf3
415 #define REPNE_PREFIX	0xf2
416 
417 /* CPUID vendors */
418 #define X86EMUL_CPUID_VENDOR_AuthenticAMD_ebx 0x68747541
419 #define X86EMUL_CPUID_VENDOR_AuthenticAMD_ecx 0x444d4163
420 #define X86EMUL_CPUID_VENDOR_AuthenticAMD_edx 0x69746e65
421 
422 #define X86EMUL_CPUID_VENDOR_AMDisbetterI_ebx 0x69444d41
423 #define X86EMUL_CPUID_VENDOR_AMDisbetterI_ecx 0x21726574
424 #define X86EMUL_CPUID_VENDOR_AMDisbetterI_edx 0x74656273
425 
426 #define X86EMUL_CPUID_VENDOR_HygonGenuine_ebx 0x6f677948
427 #define X86EMUL_CPUID_VENDOR_HygonGenuine_ecx 0x656e6975
428 #define X86EMUL_CPUID_VENDOR_HygonGenuine_edx 0x6e65476e
429 
430 #define X86EMUL_CPUID_VENDOR_GenuineIntel_ebx 0x756e6547
431 #define X86EMUL_CPUID_VENDOR_GenuineIntel_ecx 0x6c65746e
432 #define X86EMUL_CPUID_VENDOR_GenuineIntel_edx 0x49656e69
433 
434 #define X86EMUL_CPUID_VENDOR_CentaurHauls_ebx 0x746e6543
435 #define X86EMUL_CPUID_VENDOR_CentaurHauls_ecx 0x736c7561
436 #define X86EMUL_CPUID_VENDOR_CentaurHauls_edx 0x48727561
437 
438 static inline bool is_guest_vendor_intel(u32 ebx, u32 ecx, u32 edx)
439 {
440 	return ebx == X86EMUL_CPUID_VENDOR_GenuineIntel_ebx &&
441 	       ecx == X86EMUL_CPUID_VENDOR_GenuineIntel_ecx &&
442 	       edx == X86EMUL_CPUID_VENDOR_GenuineIntel_edx;
443 }
444 
445 static inline bool is_guest_vendor_amd(u32 ebx, u32 ecx, u32 edx)
446 {
447 	return (ebx == X86EMUL_CPUID_VENDOR_AuthenticAMD_ebx &&
448 		ecx == X86EMUL_CPUID_VENDOR_AuthenticAMD_ecx &&
449 		edx == X86EMUL_CPUID_VENDOR_AuthenticAMD_edx) ||
450 	       (ebx == X86EMUL_CPUID_VENDOR_AMDisbetterI_ebx &&
451 		ecx == X86EMUL_CPUID_VENDOR_AMDisbetterI_ecx &&
452 		edx == X86EMUL_CPUID_VENDOR_AMDisbetterI_edx);
453 }
454 
455 static inline bool is_guest_vendor_hygon(u32 ebx, u32 ecx, u32 edx)
456 {
457 	return ebx == X86EMUL_CPUID_VENDOR_HygonGenuine_ebx &&
458 	       ecx == X86EMUL_CPUID_VENDOR_HygonGenuine_ecx &&
459 	       edx == X86EMUL_CPUID_VENDOR_HygonGenuine_edx;
460 }
461 
462 enum x86_intercept_stage {
463 	X86_ICTP_NONE = 0,   /* Allow zero-init to not match anything */
464 	X86_ICPT_PRE_EXCEPT,
465 	X86_ICPT_POST_EXCEPT,
466 	X86_ICPT_POST_MEMACCESS,
467 };
468 
469 enum x86_intercept {
470 	x86_intercept_none,
471 	x86_intercept_cr_read,
472 	x86_intercept_cr_write,
473 	x86_intercept_clts,
474 	x86_intercept_lmsw,
475 	x86_intercept_smsw,
476 	x86_intercept_dr_read,
477 	x86_intercept_dr_write,
478 	x86_intercept_lidt,
479 	x86_intercept_sidt,
480 	x86_intercept_lgdt,
481 	x86_intercept_sgdt,
482 	x86_intercept_lldt,
483 	x86_intercept_sldt,
484 	x86_intercept_ltr,
485 	x86_intercept_str,
486 	x86_intercept_rdtsc,
487 	x86_intercept_rdpmc,
488 	x86_intercept_pushf,
489 	x86_intercept_popf,
490 	x86_intercept_cpuid,
491 	x86_intercept_rsm,
492 	x86_intercept_iret,
493 	x86_intercept_intn,
494 	x86_intercept_invd,
495 	x86_intercept_pause,
496 	x86_intercept_hlt,
497 	x86_intercept_invlpg,
498 	x86_intercept_invlpga,
499 	x86_intercept_vmrun,
500 	x86_intercept_vmload,
501 	x86_intercept_vmsave,
502 	x86_intercept_vmmcall,
503 	x86_intercept_stgi,
504 	x86_intercept_clgi,
505 	x86_intercept_skinit,
506 	x86_intercept_rdtscp,
507 	x86_intercept_rdpid,
508 	x86_intercept_icebp,
509 	x86_intercept_wbinvd,
510 	x86_intercept_monitor,
511 	x86_intercept_mwait,
512 	x86_intercept_rdmsr,
513 	x86_intercept_wrmsr,
514 	x86_intercept_in,
515 	x86_intercept_ins,
516 	x86_intercept_out,
517 	x86_intercept_outs,
518 	x86_intercept_xsetbv,
519 
520 	nr_x86_intercepts
521 };
522 
523 /* Host execution mode. */
524 #if defined(CONFIG_X86_32)
525 #define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32
526 #elif defined(CONFIG_X86_64)
527 #define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64
528 #endif
529 
530 int x86_decode_insn(struct x86_emulate_ctxt *ctxt, void *insn, int insn_len, int emulation_type);
531 bool x86_page_table_writing_insn(struct x86_emulate_ctxt *ctxt);
532 #define EMULATION_FAILED -1
533 #define EMULATION_OK 0
534 #define EMULATION_RESTART 1
535 #define EMULATION_INTERCEPTED 2
536 void init_decode_cache(struct x86_emulate_ctxt *ctxt);
537 int x86_emulate_insn(struct x86_emulate_ctxt *ctxt, bool check_intercepts);
538 int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
539 			 u16 tss_selector, int idt_index, int reason,
540 			 bool has_error_code, u32 error_code);
541 int emulate_int_real(struct x86_emulate_ctxt *ctxt, int irq);
542 void emulator_invalidate_register_cache(struct x86_emulate_ctxt *ctxt);
543 void emulator_writeback_register_cache(struct x86_emulate_ctxt *ctxt);
544 bool emulator_can_use_gpa(struct x86_emulate_ctxt *ctxt);
545 
546 static inline ulong reg_read(struct x86_emulate_ctxt *ctxt, unsigned nr)
547 {
548 	if (KVM_EMULATOR_BUG_ON(nr >= NR_EMULATOR_GPRS, ctxt))
549 		nr &= NR_EMULATOR_GPRS - 1;
550 
551 	if (!(ctxt->regs_valid & (1 << nr))) {
552 		ctxt->regs_valid |= 1 << nr;
553 		ctxt->_regs[nr] = ctxt->ops->read_gpr(ctxt, nr);
554 	}
555 	return ctxt->_regs[nr];
556 }
557 
558 static inline ulong *reg_write(struct x86_emulate_ctxt *ctxt, unsigned nr)
559 {
560 	if (KVM_EMULATOR_BUG_ON(nr >= NR_EMULATOR_GPRS, ctxt))
561 		nr &= NR_EMULATOR_GPRS - 1;
562 
563 	BUILD_BUG_ON(sizeof(ctxt->regs_dirty) * BITS_PER_BYTE < NR_EMULATOR_GPRS);
564 	BUILD_BUG_ON(sizeof(ctxt->regs_valid) * BITS_PER_BYTE < NR_EMULATOR_GPRS);
565 
566 	ctxt->regs_valid |= 1 << nr;
567 	ctxt->regs_dirty |= 1 << nr;
568 	return &ctxt->_regs[nr];
569 }
570 
571 static inline ulong *reg_rmw(struct x86_emulate_ctxt *ctxt, unsigned nr)
572 {
573 	reg_read(ctxt, nr);
574 	return reg_write(ctxt, nr);
575 }
576 
577 #endif /* _ASM_X86_KVM_X86_EMULATE_H */
578