1d046b725SJosh Poimboeuf /* SPDX-License-Identifier: GPL-2.0-or-later */ 2d046b725SJosh Poimboeuf #ifndef _ASM_X86_INSN_H 3d046b725SJosh Poimboeuf #define _ASM_X86_INSN_H 4d046b725SJosh Poimboeuf /* 5d046b725SJosh Poimboeuf * x86 instruction analysis 6d046b725SJosh Poimboeuf * 7d046b725SJosh Poimboeuf * Copyright (C) IBM Corporation, 2009 8d046b725SJosh Poimboeuf */ 9d046b725SJosh Poimboeuf 101d509f2aSMartin Schwidefsky #include <asm/byteorder.h> 11d046b725SJosh Poimboeuf /* insn_attr_t is defined in inat.h */ 12*d30c7b82SBorislav Petkov #include "inat.h" /* __ignore_sync_check__ */ 13d046b725SJosh Poimboeuf 141d509f2aSMartin Schwidefsky #if defined(__BYTE_ORDER) ? __BYTE_ORDER == __LITTLE_ENDIAN : defined(__LITTLE_ENDIAN) 151d509f2aSMartin Schwidefsky 16d046b725SJosh Poimboeuf struct insn_field { 17d046b725SJosh Poimboeuf union { 18d046b725SJosh Poimboeuf insn_value_t value; 19d046b725SJosh Poimboeuf insn_byte_t bytes[4]; 20d046b725SJosh Poimboeuf }; 21d046b725SJosh Poimboeuf /* !0 if we've run insn_get_xxx() for this field */ 22d046b725SJosh Poimboeuf unsigned char got; 23d046b725SJosh Poimboeuf unsigned char nbytes; 24d046b725SJosh Poimboeuf }; 25d046b725SJosh Poimboeuf 261d509f2aSMartin Schwidefsky static inline void insn_field_set(struct insn_field *p, insn_value_t v, 271d509f2aSMartin Schwidefsky unsigned char n) 281d509f2aSMartin Schwidefsky { 291d509f2aSMartin Schwidefsky p->value = v; 301d509f2aSMartin Schwidefsky p->nbytes = n; 311d509f2aSMartin Schwidefsky } 321d509f2aSMartin Schwidefsky 335ed934e5SVasily Gorbik static inline void insn_set_byte(struct insn_field *p, unsigned char n, 345ed934e5SVasily Gorbik insn_byte_t v) 355ed934e5SVasily Gorbik { 365ed934e5SVasily Gorbik p->bytes[n] = v; 375ed934e5SVasily Gorbik } 385ed934e5SVasily Gorbik 391d509f2aSMartin Schwidefsky #else 401d509f2aSMartin Schwidefsky 411d509f2aSMartin Schwidefsky struct insn_field { 421d509f2aSMartin Schwidefsky insn_value_t value; 431d509f2aSMartin Schwidefsky union { 441d509f2aSMartin Schwidefsky insn_value_t little; 451d509f2aSMartin Schwidefsky insn_byte_t bytes[4]; 461d509f2aSMartin Schwidefsky }; 471d509f2aSMartin Schwidefsky /* !0 if we've run insn_get_xxx() for this field */ 481d509f2aSMartin Schwidefsky unsigned char got; 491d509f2aSMartin Schwidefsky unsigned char nbytes; 501d509f2aSMartin Schwidefsky }; 511d509f2aSMartin Schwidefsky 521d509f2aSMartin Schwidefsky static inline void insn_field_set(struct insn_field *p, insn_value_t v, 531d509f2aSMartin Schwidefsky unsigned char n) 541d509f2aSMartin Schwidefsky { 551d509f2aSMartin Schwidefsky p->value = v; 561d509f2aSMartin Schwidefsky p->little = __cpu_to_le32(v); 571d509f2aSMartin Schwidefsky p->nbytes = n; 581d509f2aSMartin Schwidefsky } 591d509f2aSMartin Schwidefsky 605ed934e5SVasily Gorbik static inline void insn_set_byte(struct insn_field *p, unsigned char n, 615ed934e5SVasily Gorbik insn_byte_t v) 625ed934e5SVasily Gorbik { 635ed934e5SVasily Gorbik p->bytes[n] = v; 645ed934e5SVasily Gorbik p->value = __le32_to_cpu(p->little); 655ed934e5SVasily Gorbik } 661d509f2aSMartin Schwidefsky #endif 671d509f2aSMartin Schwidefsky 68d046b725SJosh Poimboeuf struct insn { 69d046b725SJosh Poimboeuf struct insn_field prefixes; /* 70d046b725SJosh Poimboeuf * Prefixes 71d046b725SJosh Poimboeuf * prefixes.bytes[3]: last prefix 72d046b725SJosh Poimboeuf */ 73d046b725SJosh Poimboeuf struct insn_field rex_prefix; /* REX prefix */ 74d046b725SJosh Poimboeuf struct insn_field vex_prefix; /* VEX prefix */ 75d046b725SJosh Poimboeuf struct insn_field opcode; /* 76d046b725SJosh Poimboeuf * opcode.bytes[0]: opcode1 77d046b725SJosh Poimboeuf * opcode.bytes[1]: opcode2 78d046b725SJosh Poimboeuf * opcode.bytes[2]: opcode3 79d046b725SJosh Poimboeuf */ 80d046b725SJosh Poimboeuf struct insn_field modrm; 81d046b725SJosh Poimboeuf struct insn_field sib; 82d046b725SJosh Poimboeuf struct insn_field displacement; 83d046b725SJosh Poimboeuf union { 84d046b725SJosh Poimboeuf struct insn_field immediate; 85d046b725SJosh Poimboeuf struct insn_field moffset1; /* for 64bit MOV */ 86d046b725SJosh Poimboeuf struct insn_field immediate1; /* for 64bit imm or off16/32 */ 87d046b725SJosh Poimboeuf }; 88d046b725SJosh Poimboeuf union { 89d046b725SJosh Poimboeuf struct insn_field moffset2; /* for 64bit MOV */ 90d046b725SJosh Poimboeuf struct insn_field immediate2; /* for 64bit imm or seg16 */ 91d046b725SJosh Poimboeuf }; 92d046b725SJosh Poimboeuf 934d65adfcSMasami Hiramatsu int emulate_prefix_size; 94d046b725SJosh Poimboeuf insn_attr_t attr; 95d046b725SJosh Poimboeuf unsigned char opnd_bytes; 96d046b725SJosh Poimboeuf unsigned char addr_bytes; 97d046b725SJosh Poimboeuf unsigned char length; 98d046b725SJosh Poimboeuf unsigned char x86_64; 99d046b725SJosh Poimboeuf 100d046b725SJosh Poimboeuf const insn_byte_t *kaddr; /* kernel address of insn to analyze */ 101d046b725SJosh Poimboeuf const insn_byte_t *end_kaddr; /* kernel address of last insn in buffer */ 102d046b725SJosh Poimboeuf const insn_byte_t *next_byte; 103d046b725SJosh Poimboeuf }; 104d046b725SJosh Poimboeuf 105d046b725SJosh Poimboeuf #define MAX_INSN_SIZE 15 106d046b725SJosh Poimboeuf 107d046b725SJosh Poimboeuf #define X86_MODRM_MOD(modrm) (((modrm) & 0xc0) >> 6) 108d046b725SJosh Poimboeuf #define X86_MODRM_REG(modrm) (((modrm) & 0x38) >> 3) 109d046b725SJosh Poimboeuf #define X86_MODRM_RM(modrm) ((modrm) & 0x07) 110d046b725SJosh Poimboeuf 111d046b725SJosh Poimboeuf #define X86_SIB_SCALE(sib) (((sib) & 0xc0) >> 6) 112d046b725SJosh Poimboeuf #define X86_SIB_INDEX(sib) (((sib) & 0x38) >> 3) 113d046b725SJosh Poimboeuf #define X86_SIB_BASE(sib) ((sib) & 0x07) 114d046b725SJosh Poimboeuf 115d046b725SJosh Poimboeuf #define X86_REX_W(rex) ((rex) & 8) 116d046b725SJosh Poimboeuf #define X86_REX_R(rex) ((rex) & 4) 117d046b725SJosh Poimboeuf #define X86_REX_X(rex) ((rex) & 2) 118d046b725SJosh Poimboeuf #define X86_REX_B(rex) ((rex) & 1) 119d046b725SJosh Poimboeuf 120d046b725SJosh Poimboeuf /* VEX bit flags */ 121d046b725SJosh Poimboeuf #define X86_VEX_W(vex) ((vex) & 0x80) /* VEX3 Byte2 */ 122d046b725SJosh Poimboeuf #define X86_VEX_R(vex) ((vex) & 0x80) /* VEX2/3 Byte1 */ 123d046b725SJosh Poimboeuf #define X86_VEX_X(vex) ((vex) & 0x40) /* VEX3 Byte1 */ 124d046b725SJosh Poimboeuf #define X86_VEX_B(vex) ((vex) & 0x20) /* VEX3 Byte1 */ 125d046b725SJosh Poimboeuf #define X86_VEX_L(vex) ((vex) & 0x04) /* VEX3 Byte2, VEX2 Byte1 */ 126d046b725SJosh Poimboeuf /* VEX bit fields */ 127d046b725SJosh Poimboeuf #define X86_EVEX_M(vex) ((vex) & 0x03) /* EVEX Byte1 */ 128d046b725SJosh Poimboeuf #define X86_VEX3_M(vex) ((vex) & 0x1f) /* VEX3 Byte1 */ 129d046b725SJosh Poimboeuf #define X86_VEX2_M 1 /* VEX2.M always 1 */ 130d046b725SJosh Poimboeuf #define X86_VEX_V(vex) (((vex) & 0x78) >> 3) /* VEX3 Byte2, VEX2 Byte1 */ 131d046b725SJosh Poimboeuf #define X86_VEX_P(vex) ((vex) & 0x03) /* VEX3 Byte2, VEX2 Byte1 */ 132d046b725SJosh Poimboeuf #define X86_VEX_M_MAX 0x1f /* VEX3.M Maximum value */ 133d046b725SJosh Poimboeuf 134d046b725SJosh Poimboeuf extern void insn_init(struct insn *insn, const void *kaddr, int buf_len, int x86_64); 135d046b725SJosh Poimboeuf extern void insn_get_prefixes(struct insn *insn); 136d046b725SJosh Poimboeuf extern void insn_get_opcode(struct insn *insn); 137d046b725SJosh Poimboeuf extern void insn_get_modrm(struct insn *insn); 138d046b725SJosh Poimboeuf extern void insn_get_sib(struct insn *insn); 139d046b725SJosh Poimboeuf extern void insn_get_displacement(struct insn *insn); 140d046b725SJosh Poimboeuf extern void insn_get_immediate(struct insn *insn); 141d046b725SJosh Poimboeuf extern void insn_get_length(struct insn *insn); 142d046b725SJosh Poimboeuf 143d046b725SJosh Poimboeuf /* Attribute will be determined after getting ModRM (for opcode groups) */ 144d046b725SJosh Poimboeuf static inline void insn_get_attribute(struct insn *insn) 145d046b725SJosh Poimboeuf { 146d046b725SJosh Poimboeuf insn_get_modrm(insn); 147d046b725SJosh Poimboeuf } 148d046b725SJosh Poimboeuf 149d046b725SJosh Poimboeuf /* Instruction uses RIP-relative addressing */ 150d046b725SJosh Poimboeuf extern int insn_rip_relative(struct insn *insn); 151d046b725SJosh Poimboeuf 152d046b725SJosh Poimboeuf /* Init insn for kernel text */ 153d046b725SJosh Poimboeuf static inline void kernel_insn_init(struct insn *insn, 154d046b725SJosh Poimboeuf const void *kaddr, int buf_len) 155d046b725SJosh Poimboeuf { 156d046b725SJosh Poimboeuf #ifdef CONFIG_X86_64 157d046b725SJosh Poimboeuf insn_init(insn, kaddr, buf_len, 1); 158d046b725SJosh Poimboeuf #else /* CONFIG_X86_32 */ 159d046b725SJosh Poimboeuf insn_init(insn, kaddr, buf_len, 0); 160d046b725SJosh Poimboeuf #endif 161d046b725SJosh Poimboeuf } 162d046b725SJosh Poimboeuf 163d046b725SJosh Poimboeuf static inline int insn_is_avx(struct insn *insn) 164d046b725SJosh Poimboeuf { 165d046b725SJosh Poimboeuf if (!insn->prefixes.got) 166d046b725SJosh Poimboeuf insn_get_prefixes(insn); 167d046b725SJosh Poimboeuf return (insn->vex_prefix.value != 0); 168d046b725SJosh Poimboeuf } 169d046b725SJosh Poimboeuf 170d046b725SJosh Poimboeuf static inline int insn_is_evex(struct insn *insn) 171d046b725SJosh Poimboeuf { 172d046b725SJosh Poimboeuf if (!insn->prefixes.got) 173d046b725SJosh Poimboeuf insn_get_prefixes(insn); 174d046b725SJosh Poimboeuf return (insn->vex_prefix.nbytes == 4); 175d046b725SJosh Poimboeuf } 176d046b725SJosh Poimboeuf 1774d65adfcSMasami Hiramatsu static inline int insn_has_emulate_prefix(struct insn *insn) 1784d65adfcSMasami Hiramatsu { 1794d65adfcSMasami Hiramatsu return !!insn->emulate_prefix_size; 1804d65adfcSMasami Hiramatsu } 1814d65adfcSMasami Hiramatsu 182d046b725SJosh Poimboeuf /* Ensure this instruction is decoded completely */ 183d046b725SJosh Poimboeuf static inline int insn_complete(struct insn *insn) 184d046b725SJosh Poimboeuf { 185d046b725SJosh Poimboeuf return insn->opcode.got && insn->modrm.got && insn->sib.got && 186d046b725SJosh Poimboeuf insn->displacement.got && insn->immediate.got; 187d046b725SJosh Poimboeuf } 188d046b725SJosh Poimboeuf 189d046b725SJosh Poimboeuf static inline insn_byte_t insn_vex_m_bits(struct insn *insn) 190d046b725SJosh Poimboeuf { 191d046b725SJosh Poimboeuf if (insn->vex_prefix.nbytes == 2) /* 2 bytes VEX */ 192d046b725SJosh Poimboeuf return X86_VEX2_M; 193d046b725SJosh Poimboeuf else if (insn->vex_prefix.nbytes == 3) /* 3 bytes VEX */ 194d046b725SJosh Poimboeuf return X86_VEX3_M(insn->vex_prefix.bytes[1]); 195d046b725SJosh Poimboeuf else /* EVEX */ 196d046b725SJosh Poimboeuf return X86_EVEX_M(insn->vex_prefix.bytes[1]); 197d046b725SJosh Poimboeuf } 198d046b725SJosh Poimboeuf 199d046b725SJosh Poimboeuf static inline insn_byte_t insn_vex_p_bits(struct insn *insn) 200d046b725SJosh Poimboeuf { 201d046b725SJosh Poimboeuf if (insn->vex_prefix.nbytes == 2) /* 2 bytes VEX */ 202d046b725SJosh Poimboeuf return X86_VEX_P(insn->vex_prefix.bytes[1]); 203d046b725SJosh Poimboeuf else 204d046b725SJosh Poimboeuf return X86_VEX_P(insn->vex_prefix.bytes[2]); 205d046b725SJosh Poimboeuf } 206d046b725SJosh Poimboeuf 207d046b725SJosh Poimboeuf /* Get the last prefix id from last prefix or VEX prefix */ 208d046b725SJosh Poimboeuf static inline int insn_last_prefix_id(struct insn *insn) 209d046b725SJosh Poimboeuf { 210d046b725SJosh Poimboeuf if (insn_is_avx(insn)) 211d046b725SJosh Poimboeuf return insn_vex_p_bits(insn); /* VEX_p is a SIMD prefix id */ 212d046b725SJosh Poimboeuf 213d046b725SJosh Poimboeuf if (insn->prefixes.bytes[3]) 214d046b725SJosh Poimboeuf return inat_get_last_prefix_id(insn->prefixes.bytes[3]); 215d046b725SJosh Poimboeuf 216d046b725SJosh Poimboeuf return 0; 217d046b725SJosh Poimboeuf } 218d046b725SJosh Poimboeuf 219d046b725SJosh Poimboeuf /* Offset of each field from kaddr */ 220d046b725SJosh Poimboeuf static inline int insn_offset_rex_prefix(struct insn *insn) 221d046b725SJosh Poimboeuf { 222d046b725SJosh Poimboeuf return insn->prefixes.nbytes; 223d046b725SJosh Poimboeuf } 224d046b725SJosh Poimboeuf static inline int insn_offset_vex_prefix(struct insn *insn) 225d046b725SJosh Poimboeuf { 226d046b725SJosh Poimboeuf return insn_offset_rex_prefix(insn) + insn->rex_prefix.nbytes; 227d046b725SJosh Poimboeuf } 228d046b725SJosh Poimboeuf static inline int insn_offset_opcode(struct insn *insn) 229d046b725SJosh Poimboeuf { 230d046b725SJosh Poimboeuf return insn_offset_vex_prefix(insn) + insn->vex_prefix.nbytes; 231d046b725SJosh Poimboeuf } 232d046b725SJosh Poimboeuf static inline int insn_offset_modrm(struct insn *insn) 233d046b725SJosh Poimboeuf { 234d046b725SJosh Poimboeuf return insn_offset_opcode(insn) + insn->opcode.nbytes; 235d046b725SJosh Poimboeuf } 236d046b725SJosh Poimboeuf static inline int insn_offset_sib(struct insn *insn) 237d046b725SJosh Poimboeuf { 238d046b725SJosh Poimboeuf return insn_offset_modrm(insn) + insn->modrm.nbytes; 239d046b725SJosh Poimboeuf } 240d046b725SJosh Poimboeuf static inline int insn_offset_displacement(struct insn *insn) 241d046b725SJosh Poimboeuf { 242d046b725SJosh Poimboeuf return insn_offset_sib(insn) + insn->sib.nbytes; 243d046b725SJosh Poimboeuf } 244d046b725SJosh Poimboeuf static inline int insn_offset_immediate(struct insn *insn) 245d046b725SJosh Poimboeuf { 246d046b725SJosh Poimboeuf return insn_offset_displacement(insn) + insn->displacement.nbytes; 247d046b725SJosh Poimboeuf } 248d046b725SJosh Poimboeuf 2494e9a5ae8SMasami Hiramatsu /** 2504e9a5ae8SMasami Hiramatsu * for_each_insn_prefix() -- Iterate prefixes in the instruction 2514e9a5ae8SMasami Hiramatsu * @insn: Pointer to struct insn. 2524e9a5ae8SMasami Hiramatsu * @idx: Index storage. 2534e9a5ae8SMasami Hiramatsu * @prefix: Prefix byte. 2544e9a5ae8SMasami Hiramatsu * 2554e9a5ae8SMasami Hiramatsu * Iterate prefix bytes of given @insn. Each prefix byte is stored in @prefix 2564e9a5ae8SMasami Hiramatsu * and the index is stored in @idx (note that this @idx is just for a cursor, 2574e9a5ae8SMasami Hiramatsu * do not change it.) 2584e9a5ae8SMasami Hiramatsu * Since prefixes.nbytes can be bigger than 4 if some prefixes 2594e9a5ae8SMasami Hiramatsu * are repeated, it cannot be used for looping over the prefixes. 2604e9a5ae8SMasami Hiramatsu */ 2614e9a5ae8SMasami Hiramatsu #define for_each_insn_prefix(insn, idx, prefix) \ 2624e9a5ae8SMasami Hiramatsu for (idx = 0; idx < ARRAY_SIZE(insn->prefixes.bytes) && (prefix = insn->prefixes.bytes[idx]) != 0; idx++) 2634e9a5ae8SMasami Hiramatsu 264d046b725SJosh Poimboeuf #define POP_SS_OPCODE 0x1f 265d046b725SJosh Poimboeuf #define MOV_SREG_OPCODE 0x8e 266d046b725SJosh Poimboeuf 267d046b725SJosh Poimboeuf /* 268d046b725SJosh Poimboeuf * Intel SDM Vol.3A 6.8.3 states; 269d046b725SJosh Poimboeuf * "Any single-step trap that would be delivered following the MOV to SS 270d046b725SJosh Poimboeuf * instruction or POP to SS instruction (because EFLAGS.TF is 1) is 271d046b725SJosh Poimboeuf * suppressed." 272d046b725SJosh Poimboeuf * This function returns true if @insn is MOV SS or POP SS. On these 273d046b725SJosh Poimboeuf * instructions, single stepping is suppressed. 274d046b725SJosh Poimboeuf */ 275d046b725SJosh Poimboeuf static inline int insn_masking_exception(struct insn *insn) 276d046b725SJosh Poimboeuf { 277d046b725SJosh Poimboeuf return insn->opcode.bytes[0] == POP_SS_OPCODE || 278d046b725SJosh Poimboeuf (insn->opcode.bytes[0] == MOV_SREG_OPCODE && 279d046b725SJosh Poimboeuf X86_MODRM_REG(insn->modrm.bytes[0]) == 2); 280d046b725SJosh Poimboeuf } 281d046b725SJosh Poimboeuf 282d046b725SJosh Poimboeuf #endif /* _ASM_X86_INSN_H */ 283