KVM: x86 emulator: implement movdqu instruction (f3 0f 6f, f3 0f 7f)
[deliverable/linux.git] / arch / x86 / include / asm / kvm_emulate.h
CommitLineData
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
AK
16struct x86_emulate_ctxt;
17
da9cb575
AK
18struct x86_exception {
19 u8 vector;
20 bool error_code_valid;
21 u16 error_code;
6389ee94
AK
22 bool nested_page_fault;
23 u64 address; /* cr2 or nested page fault gpa */
da9cb575
AK
24};
25
6aa8b732
AK
26/*
27 * x86_emulate_ops:
28 *
29 * These operations represent the instruction emulator's interface to memory.
30 * There are two categories of operation: those that act on ordinary memory
31 * regions (*_std), and those that act on memory regions known to require
32 * special treatment or emulation (*_emulated).
33 *
34 * The emulator assumes that an instruction accesses only one 'emulated memory'
35 * location, that this location is the given linear faulting address (cr2), and
36 * that this is one of the instruction's data operands. Instruction fetches and
37 * stack operations are assumed never to access emulated memory. The emulator
38 * automatically deduces which operand of a string-move operation is accessing
39 * emulated memory, and assumes that the other operand accesses normal memory.
40 *
41 * NOTES:
42 * 1. The emulator isn't very smart about emulated vs. standard memory.
43 * 'Emulated memory' access addresses should be checked for sanity.
44 * 'Normal memory' accesses may fault, and the caller must arrange to
45 * detect and handle reentrancy into the emulator via recursive faults.
46 * Accesses may be unaligned and may cross page boundaries.
47 * 2. If the access fails (cannot emulate, or a standard access faults) then
48 * it is up to the memop to propagate the fault to the guest VM via
49 * some out-of-band mechanism, unknown to the emulator. The memop signals
50 * failure by returning X86EMUL_PROPAGATE_FAULT to the emulator, which will
51 * then immediately bail.
52 * 3. Valid access sizes are 1, 2, 4 and 8 bytes. On x86/32 systems only
53 * cmpxchg8b_emulated need support 8-byte accesses.
54 * 4. The emulator cannot handle 64-bit mode emulation on an x86/32 system.
55 */
56/* Access completed successfully: continue emulation as normal. */
57#define X86EMUL_CONTINUE 0
58/* Access is unhandleable: bail from emulation and return error to caller. */
59#define X86EMUL_UNHANDLEABLE 1
60/* Terminate emulation but return success to the caller. */
61#define X86EMUL_PROPAGATE_FAULT 2 /* propagate a generated fault to guest */
e680080e
GN
62#define X86EMUL_RETRY_INSTR 3 /* retry the instruction for some reason */
63#define X86EMUL_CMPXCHG_FAILED 4 /* cmpxchg did not see expected value */
c3cd7ffa 64#define X86EMUL_IO_NEEDED 5 /* IO is needed to complete emulation */
e680080e 65
6aa8b732
AK
66struct x86_emulate_ops {
67 /*
68 * read_std: Read bytes of standard (non-emulated/special) memory.
1871c602 69 * Used for descriptor reading.
6aa8b732
AK
70 * @addr: [IN ] Linear address from which to read.
71 * @val: [OUT] Value read from memory, zero-extended to 'u_long'.
72 * @bytes: [IN ] Number of bytes to read from memory.
73 */
4c690a1e 74 int (*read_std)(unsigned long addr, void *val,
bcc55cba
AK
75 unsigned int bytes, struct kvm_vcpu *vcpu,
76 struct x86_exception *fault);
1871c602 77
2dafc6c2
GN
78 /*
79 * write_std: Write bytes of standard (non-emulated/special) memory.
80 * Used for descriptor writing.
81 * @addr: [IN ] Linear address to which to write.
82 * @val: [OUT] Value write to memory, zero-extended to 'u_long'.
83 * @bytes: [IN ] Number of bytes to write to memory.
84 */
85 int (*write_std)(unsigned long addr, void *val,
bcc55cba
AK
86 unsigned int bytes, struct kvm_vcpu *vcpu,
87 struct x86_exception *fault);
1871c602
GN
88 /*
89 * fetch: Read bytes of standard (non-emulated/special) memory.
90 * Used for instruction fetch.
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 */
95 int (*fetch)(unsigned long addr, void *val,
bcc55cba
AK
96 unsigned int bytes, struct kvm_vcpu *vcpu,
97 struct x86_exception *fault);
6aa8b732
AK
98
99 /*
100 * read_emulated: Read bytes from emulated/special memory area.
101 * @addr: [IN ] Linear address from which to read.
102 * @val: [OUT] Value read from memory, zero-extended to 'u_long'.
103 * @bytes: [IN ] Number of bytes to read from memory.
104 */
0c7825e6
JP
105 int (*read_emulated)(unsigned long addr,
106 void *val,
107 unsigned int bytes,
bcc55cba 108 struct x86_exception *fault,
0c7825e6 109 struct kvm_vcpu *vcpu);
6aa8b732
AK
110
111 /*
0d178975 112 * write_emulated: Write bytes to emulated/special memory area.
6aa8b732
AK
113 * @addr: [IN ] Linear address to which to write.
114 * @val: [IN ] Value to write to memory (low-order bytes used as
115 * required).
116 * @bytes: [IN ] Number of bytes to write to memory.
117 */
0c7825e6
JP
118 int (*write_emulated)(unsigned long addr,
119 const void *val,
120 unsigned int bytes,
bcc55cba 121 struct x86_exception *fault,
0c7825e6 122 struct kvm_vcpu *vcpu);
6aa8b732
AK
123
124 /*
125 * cmpxchg_emulated: Emulate an atomic (LOCKed) CMPXCHG operation on an
126 * emulated/special memory area.
127 * @addr: [IN ] Linear address to access.
128 * @old: [IN ] Value expected to be current at @addr.
129 * @new: [IN ] Value to write to @addr.
130 * @bytes: [IN ] Number of bytes to access using CMPXCHG.
131 */
0c7825e6
JP
132 int (*cmpxchg_emulated)(unsigned long addr,
133 const void *old,
134 const void *new,
135 unsigned int bytes,
bcc55cba 136 struct x86_exception *fault,
0c7825e6 137 struct kvm_vcpu *vcpu);
cf8f70bf
GN
138
139 int (*pio_in_emulated)(int size, unsigned short port, void *val,
140 unsigned int count, struct kvm_vcpu *vcpu);
141
142 int (*pio_out_emulated)(int size, unsigned short port, const void *val,
143 unsigned int count, struct kvm_vcpu *vcpu);
144
5601d05b 145 bool (*get_cached_descriptor)(struct desc_struct *desc, u32 *base3,
2dafc6c2 146 int seg, struct kvm_vcpu *vcpu);
5601d05b 147 void (*set_cached_descriptor)(struct desc_struct *desc, u32 base3,
2dafc6c2
GN
148 int seg, struct kvm_vcpu *vcpu);
149 u16 (*get_segment_selector)(int seg, struct kvm_vcpu *vcpu);
150 void (*set_segment_selector)(u16 sel, int seg, struct kvm_vcpu *vcpu);
5951c442 151 unsigned long (*get_cached_segment_base)(int seg, struct kvm_vcpu *vcpu);
2dafc6c2 152 void (*get_gdt)(struct desc_ptr *dt, struct kvm_vcpu *vcpu);
160ce1f1 153 void (*get_idt)(struct desc_ptr *dt, struct kvm_vcpu *vcpu);
52a46617 154 ulong (*get_cr)(int cr, struct kvm_vcpu *vcpu);
0f12244f 155 int (*set_cr)(int cr, ulong val, struct kvm_vcpu *vcpu);
9c537244 156 int (*cpl)(struct kvm_vcpu *vcpu);
35aa5375
GN
157 int (*get_dr)(int dr, unsigned long *dest, struct kvm_vcpu *vcpu);
158 int (*set_dr)(int dr, unsigned long value, struct kvm_vcpu *vcpu);
3fb1b5db
GN
159 int (*set_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 data);
160 int (*get_msr)(struct kvm_vcpu *vcpu, u32 msr_index, u64 *pdata);
5037f6f3
AK
161 void (*get_fpu)(struct x86_emulate_ctxt *ctxt); /* disables preempt */
162 void (*put_fpu)(struct x86_emulate_ctxt *ctxt); /* reenables preempt */
6aa8b732
AK
163};
164
1253791d
AK
165typedef u32 __attribute__((vector_size(16))) sse128_t;
166
e4e03ded
LV
167/* Type, address-of, and value of an instruction's operand. */
168struct operand {
1253791d 169 enum { OP_REG, OP_MEM, OP_IMM, OP_XMM, OP_NONE } type;
e4e03ded 170 unsigned int bytes;
16518d5a
AK
171 union {
172 unsigned long orig_val;
173 u64 orig_val64;
174 };
1a6440ae
AK
175 union {
176 unsigned long *reg;
90de84f5
AK
177 struct segmented_address {
178 ulong ea;
179 unsigned seg;
180 } mem;
1253791d 181 unsigned xmm;
1a6440ae 182 } addr;
414e6277
GN
183 union {
184 unsigned long val;
16518d5a 185 u64 val64;
414e6277 186 char valptr[sizeof(unsigned long) + 2];
1253791d 187 sse128_t vec_val;
414e6277 188 };
e4e03ded
LV
189};
190
62266869
AK
191struct fetch_cache {
192 u8 data[15];
193 unsigned long start;
194 unsigned long end;
195};
196
7b262e90
GN
197struct read_cache {
198 u8 data[1024];
199 unsigned long pos;
200 unsigned long end;
201};
202
e4e03ded
LV
203struct decode_cache {
204 u8 twobyte;
205 u8 b;
206 u8 lock_prefix;
207 u8 rep_prefix;
208 u8 op_bytes;
209 u8 ad_bytes;
33615aa9 210 u8 rex_prefix;
e4e03ded 211 struct operand src;
0dc8d10f 212 struct operand src2;
e4e03ded 213 struct operand dst;
7a5b56df
AK
214 bool has_seg_override;
215 u8 seg_override;
e4e03ded 216 unsigned int d;
ef65c889 217 int (*execute)(struct x86_emulate_ctxt *ctxt);
e4e03ded 218 unsigned long regs[NR_VCPU_REGS];
063db061 219 unsigned long eip;
e4e03ded
LV
220 /* modrm */
221 u8 modrm;
222 u8 modrm_mod;
223 u8 modrm_reg;
224 u8 modrm_rm;
09ee57cd 225 u8 modrm_seg;
f5b4edcd 226 bool rip_relative;
62266869 227 struct fetch_cache fetch;
7b262e90 228 struct read_cache io_read;
9de41573 229 struct read_cache mem_read;
e4e03ded
LV
230};
231
6aa8b732 232struct x86_emulate_ctxt {
9aabc88f
AK
233 struct x86_emulate_ops *ops;
234
6aa8b732
AK
235 /* Register state before/after emulation. */
236 struct kvm_vcpu *vcpu;
237
6aa8b732 238 unsigned long eflags;
063db061 239 unsigned long eip; /* eip before instruction emulation */
6aa8b732
AK
240 /* Emulated execution mode, represented by an X86EMUL_MODE value. */
241 int mode;
7a5b56df 242 u32 cs_base;
e4e03ded 243
310b5d30
GC
244 /* interruptibility state, as a result of execution of STI or MOV SS */
245 int interruptibility;
246
4fc40f07 247 bool perm_ok; /* do not check permissions if true */
d867162c 248 bool only_vendor_specific_insn;
54b8486f 249
da9cb575
AK
250 bool have_exception;
251 struct x86_exception exception;
54b8486f 252
e4e03ded 253 /* decode cache */
e4e03ded 254 struct decode_cache decode;
6aa8b732
AK
255};
256
90e0a28f 257/* Repeat String Operation Prefix */
1d6b114f
AK
258#define REPE_PREFIX 0xf3
259#define REPNE_PREFIX 0xf2
90e0a28f 260
6aa8b732
AK
261/* Execution mode, passed to the emulator. */
262#define X86EMUL_MODE_REAL 0 /* Real mode. */
a0044755 263#define X86EMUL_MODE_VM86 1 /* Virtual 8086 mode. */
6aa8b732
AK
264#define X86EMUL_MODE_PROT16 2 /* 16-bit protected mode. */
265#define X86EMUL_MODE_PROT32 4 /* 32-bit protected mode. */
266#define X86EMUL_MODE_PROT64 8 /* 64-bit (long) mode. */
267
268/* Host execution mode. */
d73fa29a 269#if defined(CONFIG_X86_32)
6aa8b732 270#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT32
05b3e0c2 271#elif defined(CONFIG_X86_64)
6aa8b732
AK
272#define X86EMUL_MODE_HOST X86EMUL_MODE_PROT64
273#endif
274
dc25e89e 275int x86_decode_insn(struct x86_emulate_ctxt *ctxt, void *insn, int insn_len);
d2ddd1c4
GN
276#define EMULATION_FAILED -1
277#define EMULATION_OK 0
278#define EMULATION_RESTART 1
9aabc88f 279int x86_emulate_insn(struct x86_emulate_ctxt *ctxt);
38ba30ba 280int emulator_task_switch(struct x86_emulate_ctxt *ctxt,
e269fb21
JK
281 u16 tss_selector, int reason,
282 bool has_error_code, u32 error_code);
4ab8e024
MG
283int emulate_int_real(struct x86_emulate_ctxt *ctxt,
284 struct x86_emulate_ops *ops, int irq);
1965aae3 285#endif /* _ASM_X86_KVM_X86_EMULATE_H */
This page took 0.415369 seconds and 5 git commands to generate.