arch/x86/include/asm/kvm_emulate.h

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