1 #ifndef _ASM_X86_INAT_H
2 #define _ASM_X86_INAT_H
4 * x86 instruction attributes
6 * Written by Masami Hiramatsu <mhiramat@redhat.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <asm/inat_types.h>
26 * Internal bits. Don't use bitmasks directly, because these bits are
27 * unstable. You should use checking functions.
30 #define INAT_OPCODE_TABLE_SIZE 256
31 #define INAT_GROUP_TABLE_SIZE 8
33 /* Legacy instruction prefixes */
34 #define INAT_PFX_OPNDSZ 1 /* 0x66 */ /* LPFX1 */
35 #define INAT_PFX_REPNE 2 /* 0xF2 */ /* LPFX2 */
36 #define INAT_PFX_REPE 3 /* 0xF3 */ /* LPFX3 */
37 #define INAT_PFX_LOCK 4 /* 0xF0 */
38 #define INAT_PFX_CS 5 /* 0x2E */
39 #define INAT_PFX_DS 6 /* 0x3E */
40 #define INAT_PFX_ES 7 /* 0x26 */
41 #define INAT_PFX_FS 8 /* 0x64 */
42 #define INAT_PFX_GS 9 /* 0x65 */
43 #define INAT_PFX_SS 10 /* 0x36 */
44 #define INAT_PFX_ADDRSZ 11 /* 0x67 */
46 #define INAT_LPREFIX_MAX 3
49 #define INAT_IMM_BYTE 1
50 #define INAT_IMM_WORD 2
51 #define INAT_IMM_DWORD 3
52 #define INAT_IMM_QWORD 4
53 #define INAT_IMM_PTR 5
54 #define INAT_IMM_VWORD32 6
55 #define INAT_IMM_VWORD 7
58 #define INAT_PFX_OFFS 0
59 #define INAT_PFX_BITS 4
60 #define INAT_PFX_MAX ((1 << INAT_PFX_BITS) - 1)
61 #define INAT_PFX_MASK (INAT_PFX_MAX << INAT_PFX_OFFS)
63 #define INAT_ESC_OFFS (INAT_PFX_OFFS + INAT_PFX_BITS)
64 #define INAT_ESC_BITS 2
65 #define INAT_ESC_MAX ((1 << INAT_ESC_BITS) - 1)
66 #define INAT_ESC_MASK (INAT_ESC_MAX << INAT_ESC_OFFS)
67 /* Group opcodes (1-16) */
68 #define INAT_GRP_OFFS (INAT_ESC_OFFS + INAT_ESC_BITS)
69 #define INAT_GRP_BITS 5
70 #define INAT_GRP_MAX ((1 << INAT_GRP_BITS) - 1)
71 #define INAT_GRP_MASK (INAT_GRP_MAX << INAT_GRP_OFFS)
73 #define INAT_IMM_OFFS (INAT_GRP_OFFS + INAT_GRP_BITS)
74 #define INAT_IMM_BITS 3
75 #define INAT_IMM_MASK (((1 << INAT_IMM_BITS) - 1) << INAT_IMM_OFFS)
77 #define INAT_FLAG_OFFS (INAT_IMM_OFFS + INAT_IMM_BITS)
78 #define INAT_REXPFX (1 << INAT_FLAG_OFFS)
79 #define INAT_MODRM (1 << (INAT_FLAG_OFFS + 1))
80 #define INAT_FORCE64 (1 << (INAT_FLAG_OFFS + 2))
81 #define INAT_SCNDIMM (1 << (INAT_FLAG_OFFS + 3))
82 #define INAT_MOFFSET (1 << (INAT_FLAG_OFFS + 4))
83 #define INAT_VARIANT (1 << (INAT_FLAG_OFFS + 5))
84 /* Attribute making macros for attribute tables */
85 #define INAT_MAKE_PREFIX(pfx) (pfx << INAT_PFX_OFFS)
86 #define INAT_MAKE_ESCAPE(esc) (esc << INAT_ESC_OFFS)
87 #define INAT_MAKE_GROUP(grp) ((grp << INAT_GRP_OFFS) | INAT_MODRM)
88 #define INAT_MAKE_IMM(imm) (imm << INAT_IMM_OFFS)
90 /* Attribute search APIs */
91 extern insn_attr_t inat_get_opcode_attribute(insn_byte_t opcode);
92 extern insn_attr_t inat_get_escape_attribute(insn_byte_t opcode,
94 insn_attr_t esc_attr);
95 extern insn_attr_t inat_get_group_attribute(insn_byte_t modrm,
97 insn_attr_t esc_attr);
99 /* Attribute checking functions */
100 static inline int inat_is_prefix(insn_attr_t attr)
102 return attr & INAT_PFX_MASK;
105 static inline int inat_is_address_size_prefix(insn_attr_t attr)
107 return (attr & INAT_PFX_MASK) == INAT_PFX_ADDRSZ;
110 static inline int inat_is_operand_size_prefix(insn_attr_t attr)
112 return (attr & INAT_PFX_MASK) == INAT_PFX_OPNDSZ;
115 static inline int inat_last_prefix_id(insn_attr_t attr)
117 if ((attr & INAT_PFX_MASK) > INAT_LPREFIX_MAX)
120 return attr & INAT_PFX_MASK;
123 static inline int inat_is_escape(insn_attr_t attr)
125 return attr & INAT_ESC_MASK;
128 static inline int inat_escape_id(insn_attr_t attr)
130 return (attr & INAT_ESC_MASK) >> INAT_ESC_OFFS;
133 static inline int inat_is_group(insn_attr_t attr)
135 return attr & INAT_GRP_MASK;
138 static inline int inat_group_id(insn_attr_t attr)
140 return (attr & INAT_GRP_MASK) >> INAT_GRP_OFFS;
143 static inline int inat_group_common_attribute(insn_attr_t attr)
145 return attr & ~INAT_GRP_MASK;
148 static inline int inat_has_immediate(insn_attr_t attr)
150 return attr & INAT_IMM_MASK;
153 static inline int inat_immediate_size(insn_attr_t attr)
155 return (attr & INAT_IMM_MASK) >> INAT_IMM_OFFS;
158 static inline int inat_is_rex_prefix(insn_attr_t attr)
160 return attr & INAT_REXPFX;
163 static inline int inat_has_modrm(insn_attr_t attr)
165 return attr & INAT_MODRM;
168 static inline int inat_is_force64(insn_attr_t attr)
170 return attr & INAT_FORCE64;
173 static inline int inat_has_second_immediate(insn_attr_t attr)
175 return attr & INAT_SCNDIMM;
178 static inline int inat_has_moffset(insn_attr_t attr)
180 return attr & INAT_MOFFSET;
183 static inline int inat_has_variant(insn_attr_t attr)
185 return attr & INAT_VARIANT;