]>
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 |
12 | #define _ASM_X86_KVM_X86_EMULATE_H | |
6aa8b732 | 13 | |
38ba30ba GN |
14 | #include <asm/desc_defs.h> |
15 | ||
6aa8b732 | 16 | struct x86_emulate_ctxt; |
c4f035c6 AK |
17 | enum x86_intercept; |
18 | enum x86_intercept_stage; | |
6aa8b732 | 19 | |
da9cb575 AK |
20 | struct x86_exception { |
21 | u8 vector; | |
22 | bool error_code_valid; | |
23 | u16 error_code; | |
6389ee94 AK |
24 | bool nested_page_fault; |
25 | u64 address; /* cr2 or nested page fault gpa */ | |
da9cb575 AK |
26 | }; |
27 | ||
8a76d7f2 JR |
28 | /* |
29 | * This struct is used to carry enough information from the instruction | |
30 | * decoder to main KVM so that a decision can be made whether the | |
31 | * instruction needs to be intercepted or not. | |
32 | */ | |
33 | struct x86_instruction_info { | |
34 | u8 intercept; /* which intercept */ | |
35 | u8 rep_prefix; /* rep prefix? */ | |
36 | u8 modrm_mod; /* mod part of modrm */ | |
37 | u8 modrm_reg; /* index of register used */ | |
38 | u8 modrm_rm; /* rm part of modrm */ | |
39 | u64 src_val; /* value of source operand */ | |
40 | u8 src_bytes; /* size of source operand */ | |
41 | u8 dst_bytes; /* size of destination operand */ | |
42 | u8 ad_bytes; /* size of src/dst address */ | |
43 | u64 next_rip; /* rip following the instruction */ | |
44 | }; | |
45 | ||
6aa8b732 AK |
46 | /* |
47 | * x86_emulate_ops: | |
48 | * | |
49 | * These operations represent the instruction emulator's interface to memory. | |
50 | * There are two categories of operation: those that act on ordinary memory | |
51 | * regions (*_std), and those that act on memory regions known to require | |
52 | * special treatment or emulation (*_emulated). | |
53 | * | |
54 | * The emulator assumes that an instruction accesses only one 'emulated memory' | |
55 | * location, that this location is the given linear faulting address (cr2), and | |
56 | * that this is one of the instruction's data operands. Instruction fetches and | |
57 | * stack operations are assumed never to access emulated memory. The emulator | |
58 | * automatically deduces which operand of a string-move operation is accessing | |
59 | * emulated memory, and assumes that the other operand accesses normal memory. | |
60 | * | |
61 | * NOTES: | |
62 | * 1. The emulator isn't very smart about emulated vs. standard memory. | |
63 | * 'Emulated memory' access addresses should be checked for sanity. | |
64 | * 'Normal memory' accesses may fault, and the caller must arrange to | |
65 | * detect and handle reentrancy into the emulator via recursive faults. | |
66 | * Accesses may be unaligned and may cross page boundaries. | |
67 | * 2. If the access fails (cannot emulate, or a standard access faults) then | |
68 | * it is up to the memop to propagate the fault to the guest VM via | |
69 | * some out-of-band mechanism, unknown to the emulator. The memop signals | |
70 | * failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will | |
71 | * then immediately bail. | |
72 | * 3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only | |
73 | * cmpxchg8b_emulated need support 8-byte accesses. | |
74 | * 4. The emulator cannot handle 64-bit mode emulation on an x86/32 system. | |
75 | */ | |
76 | /* Access completed successfully: continue emulation as normal. */ | |
77 | #define X86EMUL_CONTINUE 0 | |
78 | /* Access is unhandleable: bail from emulation and return error to caller. */ | |
79 | #define X86EMUL_UNHANDLEABLE 1 | |
80 | /* Terminate emulation but return success to the caller. */ | |
81 | #define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */ | |
e680080e GN |
82 | #define X86EMUL_RETRY_INSTR 3 /* retry the instruction for some reason */ |
83 | #define X86EMUL_CMPXCHG_FAILED 4 /* cmpxchg did not see expected value */ | |
c3cd7ffa | 84 | #define X86EMUL_IO_NEEDED 5 /* IO is needed to complete emulation */ |
c4f035c6 | 85 | #define X86EMUL_INTERCEPTED 6 /* Intercepted by nested VMCB/VMCS */ |
e680080e | 86 | |
6aa8b732 AK |
87 | struct x86_emulate_ops { |
88 | /* | |
89 | * read_std: Read bytes of standard (non-emulated/special) memory. | |
1871c602 | 90 | * Used for descriptor reading. |
6aa8b732 AK |
91 | * @addr: [IN ] Linear address from which to read. |
92 | * @val: [OUT] Value read from memory, zero-extended to 'u_long'. | |
93 | * @bytes: [IN ] Number of bytes to read from memory. | |
94 | */ | |
4c690a1e | 95 | int (*read_std)(unsigned long addr, void *val, |
bcc55cba AK |
96 | unsigned int bytes, struct kvm_vcpu *vcpu, |
97 | struct x86_exception *fault); | |
1871c602 | 98 | |
2dafc6c2 GN |
99 | /* |
100 | * write_std: Write bytes of standard (non-emulated/special) memory. | |
101 | * Used for descriptor writing. | |
102 | * @addr: [IN ] Linear address to which to write. | |
103 | * @val: [OUT] Value write to memory, zero-extended to 'u_long'. | |
104 | * @bytes: [IN ] Number of bytes to write to memory. | |
105 | */ | |
106 | int (*write_std)(unsigned long addr, void *val, | |
bcc55cba AK |
107 | unsigned int bytes, struct kvm_vcpu *vcpu, |
108 | struct x86_exception *fault); | |
1871c602 GN |
109 | /* |
110 | * fetch: Read bytes of standard (non-emulated/special) memory. | |
111 | * Used for instruction fetch. | |
112 | * @addr: [IN ] Linear address from which to read. | |
113 | * @val: [OUT] Value read from memory, zero-extended to 'u_long'. | |
114 | * @bytes: [IN ] Number of bytes to read from memory. | |
115 | */ | |
116 | int (*fetch)(unsigned long addr, void *val, | |
bcc55cba AK |
117 | unsigned int bytes, struct kvm_vcpu *vcpu, |
118 | struct x86_exception *fault); | |
6aa8b732 AK |
119 | |
120 | /* | |
121 | * read_emulated: Read bytes from emulated/special memory area. | |
122 | * @addr: [IN ] Linear address from which to read. | |
123 | * @val: [OUT] Value read from memory, zero-extended to 'u_long'. | |
124 | * @bytes: [IN ] Number of bytes to read from memory. | |
125 | */ | |
0c7825e6 JP |
126 | int (*read_emulated)(unsigned long addr, |
127 | void *val, | |
128 | unsigned int bytes, | |
bcc55cba | 129 | struct x86_exception *fault, |
0c7825e6 | 130 | struct kvm_vcpu *vcpu); |
6aa8b732 AK |
131 | |
132 | /* | |
0d178975 | 133 | * write_emulated: Write bytes to emulated/special memory area. |
6aa8b732 AK |
134 | * @addr: [IN ] Linear address to which to write. |
135 | * @val: [IN ] Value to write to memory (low-order bytes used as | |
136 | * required). | |
137 | * @bytes: [IN ] Number of bytes to write to memory. | |
138 | */ | |
0c7825e6 JP |
139 | int (*write_emulated)(unsigned long addr, |
140 | const void *val, | |
141 | unsigned int bytes, | |
bcc55cba | 142 | struct x86_exception *fault, |
0c7825e6 | 143 | struct kvm_vcpu *vcpu); |
6aa8b732 AK |
144 | |
145 | /* | |
146 | * cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an | |
147 | * emulated/special memory area. | |
148 | * @addr: [IN ] Linear address to access. | |
149 | * @old: [IN ] Value expected to be current at @addr. | |
150 | * @new: [IN ] Value to write to @addr. | |
151 | * @bytes: [IN ] Number of bytes to access using CMPXCHG. | |
152 | */ | |
0c7825e6 JP |
153 | int (*cmpxchg_emulated)(unsigned long addr, |
154 | const void *old, | |
155 | const void *new, | |
156 | unsigned int bytes, | |
bcc55cba | 157 | struct x86_exception *fault, |
0c7825e6 | 158 | struct kvm_vcpu *vcpu); |
cf8f70bf GN |
159 | |
160 | int (*pio_in_emulated)(int size, unsigned short port, void *val, | |
161 | unsigned int count, struct kvm_vcpu *vcpu); | |
162 | ||
163 | int (*pio_out_emulated)(int size, unsigned short port, const void *val, | |
164 | unsigned int count, struct kvm_vcpu *vcpu); | |
165 | ||
5601d05b | 166 | bool (*get_cached_descriptor)(struct desc_struct *desc, u32 *base3, |
2dafc6c2 | 167 | int seg, struct kvm_vcpu *vcpu); |
5601d05b | 168 | void (*set_cached_descriptor)(struct desc_struct *desc, u32 base3, |
2dafc6c2 GN |
169 | int seg, struct kvm_vcpu *vcpu); |
170 | u16 (*get_segment_selector)(int seg, struct kvm_vcpu *vcpu); | |
171 | void (*set_segment_selector)(u16 sel, int seg, struct kvm_vcpu *vcpu); | |
5951c442 | 172 | unsigned long (*get_cached_segment_base)(int seg, struct kvm_vcpu *vcpu); |
2dafc6c2 | 173 | void (*get_gdt)(struct desc_ptr *dt, struct kvm_vcpu *vcpu); |
160ce1f1 | 174 | void (*get_idt)(struct desc_ptr *dt, struct kvm_vcpu *vcpu); |
52a46617 | 175 | ulong (*get_cr)(int cr, struct kvm_vcpu *vcpu); |
0f12244f | 176 | int (*set_cr)(int cr, ulong val, struct kvm_vcpu *vcpu); |
9c537244 | 177 | int (*cpl)(struct kvm_vcpu *vcpu); |
35aa5375 GN |
178 | int (*get_dr)(int dr, unsigned long *dest, struct kvm_vcpu *vcpu); |
179 | int (*set_dr)(int dr, unsigned long value, struct kvm_vcpu *vcpu); | |
3fb1b5db GN |
180 | int (*set_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 data); |
181 | int (*get_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 *pdata); | |
5037f6f3 AK |
182 | void (*get_fpu)(struct x86_emulate_ctxt *ctxt); /* disables preempt */ |
183 | void (*put_fpu)(struct x86_emulate_ctxt *ctxt); /* reenables preempt */ | |
8a76d7f2 JR |
184 | int (*intercept)(struct kvm_vcpu *vcpu, |
185 | struct x86_instruction_info *info, | |
c4f035c6 | 186 | enum x86_intercept_stage stage); |
6aa8b732 AK |
187 | }; |
188 | ||
1253791d AK |
189 | typedef u32 __attribute__((vector_size(16))) sse128_t; |
190 | ||
e4e03ded LV |
191 | /* Type, address-of, and value of an instruction's operand. */ |
192 | struct operand { | |
1253791d | 193 | enum { OP_REG, OP_MEM, OP_IMM, OP_XMM, OP_NONE } type; |
e4e03ded | 194 | unsigned int bytes; |
16518d5a AK |
195 | union { |
196 | unsigned long orig_val; | |
197 | u64 orig_val64; | |
198 | }; | |
1a6440ae AK |
199 | union { |
200 | unsigned long *reg; | |
90de84f5 AK |
201 | struct segmented_address { |
202 | ulong ea; | |
203 | unsigned seg; | |
204 | } mem; | |
1253791d | 205 | unsigned xmm; |
1a6440ae | 206 | } addr; |
414e6277 GN |
207 | union { |
208 | unsigned long val; | |
16518d5a | 209 | u64 val64; |
414e6277 | 210 | char valptr[sizeof(unsigned long) + 2]; |
1253791d | 211 | sse128_t vec_val; |
414e6277 | 212 | }; |
e4e03ded LV |
213 | }; |
214 | ||
62266869 AK |
215 | struct fetch_cache { |
216 | u8 data[15]; | |
217 | unsigned long start; | |
218 | unsigned long end; | |
219 | }; | |
220 | ||
7b262e90 GN |
221 | struct read_cache { |
222 | u8 data[1024]; | |
223 | unsigned long pos; | |
224 | unsigned long end; | |
225 | }; | |
226 | ||
e4e03ded LV |
227 | struct decode_cache { |
228 | u8 twobyte; | |
229 | u8 b; | |
c4f035c6 | 230 | u8 intercept; |
e4e03ded LV |
231 | u8 lock_prefix; |
232 | u8 rep_prefix; | |
233 | u8 op_bytes; | |
234 | u8 ad_bytes; | |
33615aa9 | 235 | u8 rex_prefix; |
e4e03ded | 236 | struct operand src; |
0dc8d10f | 237 | struct operand src2; |
e4e03ded | 238 | struct operand dst; |
7a5b56df AK |
239 | bool has_seg_override; |
240 | u8 seg_override; | |
e4e03ded | 241 | unsigned int d; |
ef65c889 | 242 | int (*execute)(struct x86_emulate_ctxt *ctxt); |
d09beabd | 243 | int (*check_perm)(struct x86_emulate_ctxt *ctxt); |
e4e03ded | 244 | unsigned long regs[NR_VCPU_REGS]; |
063db061 | 245 | unsigned long eip; |
e4e03ded LV |
246 | /* modrm */ |
247 | u8 modrm; | |
248 | u8 modrm_mod; | |
249 | u8 modrm_reg; | |
250 | u8 modrm_rm; | |
09ee57cd | 251 | u8 modrm_seg; |
f5b4edcd | 252 | bool rip_relative; |
62266869 | 253 | struct fetch_cache fetch; |
7b262e90 | 254 | struct read_cache io_read; |
9de41573 | 255 | struct read_cache mem_read; |
e4e03ded LV |
256 | }; |
257 | ||
6aa8b732 | 258 | struct x86_emulate_ctxt { |
9aabc88f AK |
259 | struct x86_emulate_ops *ops; |
260 | ||
6aa8b732 AK |
261 | /* Register state before/after emulation. */ |
262 | struct kvm_vcpu *vcpu; | |
263 | ||
6aa8b732 | 264 | unsigned long eflags; |
063db061 | 265 | unsigned long eip; /* eip before instruction emulation */ |
6aa8b732 AK |
266 | /* Emulated execution mode, represented by an X86EMUL_MODE value. */ |
267 | int mode; | |
7a5b56df | 268 | u32 cs_base; |
e4e03ded | 269 | |
310b5d30 GC |
270 | /* interruptibility state, as a result of execution of STI or MOV SS */ |
271 | int interruptibility; | |
272 | ||
c4f035c6 | 273 | bool guest_mode; /* guest running a nested guest */ |
4fc40f07 | 274 | bool perm_ok; /* do not check permissions if true */ |
d867162c | 275 | bool only_vendor_specific_insn; |
54b8486f | 276 | |
da9cb575 AK |
277 | bool have_exception; |
278 | struct x86_exception exception; | |
54b8486f | 279 | |
e4e03ded | 280 | /* decode cache */ |
e4e03ded | 281 | struct decode_cache decode; |
6aa8b732 AK |
282 | }; |
283 | ||
90e0a28f | 284 | /* Repeat String Operation Prefix */ |
1d6b114f AK |
285 | #define REPE_PREFIX 0xf3 |
286 | #define REPNE_PREFIX 0xf2 | |
90e0a28f | 287 | |
6aa8b732 AK |
288 | /* Execution mode, passed to the emulator. */ |
289 | #define X86EMUL_MODE_REAL 0 /* Real mode. */ | |
a0044755 | 290 | #define X86EMUL_MODE_VM86 1 /* Virtual 8086 mode. */ |
6aa8b732 AK |
291 | #define X86EMUL_MODE_PROT16 2 /* 16-bit protected mode. */ |
292 | #define X86EMUL_MODE_PROT32 4 /* 32-bit protected mode. */ | |
293 | #define X86EMUL_MODE_PROT64 8 /* 64-bit (long) mode. */ | |
294 | ||
8ea7d6ae JR |
295 | /* any protected mode */ |
296 | #define X86EMUL_MODE_PROT (X86EMUL_MODE_PROT16|X86EMUL_MODE_PROT32| \ | |
297 | X86EMUL_MODE_PROT64) | |
298 | ||
c4f035c6 AK |
299 | enum x86_intercept_stage { |
300 | X86_ICPT_PRE_EXCEPT, | |
301 | X86_ICPT_POST_EXCEPT, | |
302 | X86_ICPT_POST_MEMACCESS, | |
303 | }; | |
304 | ||
305 | enum x86_intercept { | |
306 | x86_intercept_none, | |
cfec82cb JR |
307 | x86_intercept_cr_read, |
308 | x86_intercept_cr_write, | |
309 | x86_intercept_clts, | |
3c6e276f AK |
310 | x86_intercept_lmsw, |
311 | x86_intercept_smsw, | |
3b88e41a JR |
312 | x86_intercept_dr_read, |
313 | x86_intercept_dr_write, | |
3c6e276f AK |
314 | x86_intercept_lidt, |
315 | x86_intercept_sidt, | |
316 | x86_intercept_lgdt, | |
317 | x86_intercept_sgdt, | |
318 | x86_intercept_lldt, | |
319 | x86_intercept_sldt, | |
320 | x86_intercept_ltr, | |
321 | x86_intercept_str, | |
322 | x86_intercept_rdtsc, | |
323 | x86_intercept_rdpmc, | |
324 | x86_intercept_pushf, | |
325 | x86_intercept_popf, | |
326 | x86_intercept_cpuid, | |
327 | x86_intercept_rsm, | |
328 | x86_intercept_iret, | |
329 | x86_intercept_intn, | |
330 | x86_intercept_invd, | |
331 | x86_intercept_pause, | |
332 | x86_intercept_hlt, | |
333 | x86_intercept_invlpg, | |
334 | x86_intercept_invlpga, | |
335 | x86_intercept_vmrun, | |
336 | x86_intercept_vmload, | |
337 | x86_intercept_vmsave, | |
338 | x86_intercept_vmmcall, | |
339 | x86_intercept_stgi, | |
340 | x86_intercept_clgi, | |
341 | x86_intercept_skinit, | |
342 | x86_intercept_rdtscp, | |
343 | x86_intercept_icebp, | |
344 | x86_intercept_wbinvd, | |
345 | x86_intercept_monitor, | |
346 | x86_intercept_mwait, | |
8061252e JR |
347 | x86_intercept_rdmsr, |
348 | x86_intercept_wrmsr, | |
c4f035c6 AK |
349 | |
350 | nr_x86_intercepts | |
351 | }; | |
352 | ||
6aa8b732 | 353 | /* Host execution mode. */ |
d73fa29a | 354 | #if defined(CONFIG_X86_32) |
6aa8b732 | 355 | #define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32 |
05b3e0c2 | 356 | #elif defined(CONFIG_X86_64) |
6aa8b732 AK |
357 | #define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64 |
358 | #endif | |
359 | ||
dc25e89e | 360 | int x86_decode_insn(struct x86_emulate_ctxt *ctxt, void *insn, int insn_len); |
d2ddd1c4 GN |
361 | #define EMULATION_FAILED -1 |
362 | #define EMULATION_OK 0 | |
363 | #define EMULATION_RESTART 1 | |
775fde86 | 364 | #define EMULATION_INTERCEPTED 2 |
9aabc88f | 365 | int x86_emulate_insn(struct x86_emulate_ctxt *ctxt); |
38ba30ba | 366 | int emulator_task_switch(struct x86_emulate_ctxt *ctxt, |
e269fb21 JK |
367 | u16 tss_selector, int reason, |
368 | bool has_error_code, u32 error_code); | |
4ab8e024 MG |
369 | int emulate_int_real(struct x86_emulate_ctxt *ctxt, |
370 | struct x86_emulate_ops *ops, int irq); | |
1965aae3 | 371 | #endif /* _ASM_X86_KVM_X86_EMULATE_H */ |