1 /*===-- X86DisassemblerDecoderCommon.h - Disassembler decoder -----*- C -*-===*
2 *
3 * The LLVM Compiler Infrastructure
4 *
5 * This file is distributed under the University of Illinois Open Source
6 * License. See LICENSE.TXT for details.
7 *
8 *===----------------------------------------------------------------------===*
9 *
10 * This file is part of the X86 Disassembler.
11 * It contains common definitions used by both the disassembler and the table
12 * generator.
13 * Documentation for the disassembler can be found in X86Disassembler.h.
14 *
15 *===----------------------------------------------------------------------===*/
17 /*
18 * This header file provides those definitions that need to be shared between
19 * the decoder and the table generator in a C-friendly manner.
20 */
22 #ifndef X86DISASSEMBLERDECODERCOMMON_H
23 #define X86DISASSEMBLERDECODERCOMMON_H
25 #include "llvm/Support/DataTypes.h"
27 #define INSTRUCTIONS_SYM x86DisassemblerInstrSpecifiers
28 #define CONTEXTS_SYM x86DisassemblerContexts
29 #define ONEBYTE_SYM x86DisassemblerOneByteOpcodes
30 #define TWOBYTE_SYM x86DisassemblerTwoByteOpcodes
31 #define THREEBYTE38_SYM x86DisassemblerThreeByte38Opcodes
32 #define THREEBYTE3A_SYM x86DisassemblerThreeByte3AOpcodes
33 #define THREEBYTEA6_SYM x86DisassemblerThreeByteA6Opcodes
34 #define THREEBYTEA7_SYM x86DisassemblerThreeByteA7Opcodes
35 #define XOP8_MAP_SYM x86DisassemblerXOP8Opcodes
36 #define XOP9_MAP_SYM x86DisassemblerXOP9Opcodes
37 #define XOPA_MAP_SYM x86DisassemblerXOPAOpcodes
39 #define INSTRUCTIONS_STR "x86DisassemblerInstrSpecifiers"
40 #define CONTEXTS_STR "x86DisassemblerContexts"
41 #define ONEBYTE_STR "x86DisassemblerOneByteOpcodes"
42 #define TWOBYTE_STR "x86DisassemblerTwoByteOpcodes"
43 #define THREEBYTE38_STR "x86DisassemblerThreeByte38Opcodes"
44 #define THREEBYTE3A_STR "x86DisassemblerThreeByte3AOpcodes"
45 #define THREEBYTEA6_STR "x86DisassemblerThreeByteA6Opcodes"
46 #define THREEBYTEA7_STR "x86DisassemblerThreeByteA7Opcodes"
47 #define XOP8_MAP_STR "x86DisassemblerXOP8Opcodes"
48 #define XOP9_MAP_STR "x86DisassemblerXOP9Opcodes"
49 #define XOPA_MAP_STR "x86DisassemblerXOPAOpcodes"
51 /*
52 * Attributes of an instruction that must be known before the opcode can be
53 * processed correctly. Most of these indicate the presence of particular
54 * prefixes, but ATTR_64BIT is simply an attribute of the decoding context.
55 */
56 #define ATTRIBUTE_BITS \
57 ENUM_ENTRY(ATTR_NONE, 0x00) \
58 ENUM_ENTRY(ATTR_64BIT, (0x1 << 0)) \
59 ENUM_ENTRY(ATTR_XS, (0x1 << 1)) \
60 ENUM_ENTRY(ATTR_XD, (0x1 << 2)) \
61 ENUM_ENTRY(ATTR_REXW, (0x1 << 3)) \
62 ENUM_ENTRY(ATTR_OPSIZE, (0x1 << 4)) \
63 ENUM_ENTRY(ATTR_ADSIZE, (0x1 << 5)) \
64 ENUM_ENTRY(ATTR_VEX, (0x1 << 6)) \
65 ENUM_ENTRY(ATTR_VEXL, (0x1 << 7)) \
66 ENUM_ENTRY(ATTR_EVEX, (0x1 << 8)) \
67 ENUM_ENTRY(ATTR_EVEXL, (0x1 << 9)) \
68 ENUM_ENTRY(ATTR_EVEXL2, (0x1 << 10)) \
69 ENUM_ENTRY(ATTR_EVEXK, (0x1 << 11)) \
70 ENUM_ENTRY(ATTR_EVEXKZ, (0x1 << 12)) \
71 ENUM_ENTRY(ATTR_EVEXB, (0x1 << 13))
73 #define ENUM_ENTRY(n, v) n = v,
74 enum attributeBits {
75 ATTRIBUTE_BITS
76 ATTR_max
77 };
78 #undef ENUM_ENTRY
80 /*
81 * Combinations of the above attributes that are relevant to instruction
82 * decode. Although other combinations are possible, they can be reduced to
83 * these without affecting the ultimately decoded instruction.
84 */
86 /* Class name Rank Rationale for rank assignment */
87 #define INSTRUCTION_CONTEXTS \
88 ENUM_ENTRY(IC, 0, "says nothing about the instruction") \
89 ENUM_ENTRY(IC_64BIT, 1, "says the instruction applies in " \
90 "64-bit mode but no more") \
91 ENUM_ENTRY(IC_OPSIZE, 3, "requires an OPSIZE prefix, so " \
92 "operands change width") \
93 ENUM_ENTRY(IC_ADSIZE, 3, "requires an ADSIZE prefix, so " \
94 "operands change width") \
95 ENUM_ENTRY(IC_XD, 2, "may say something about the opcode " \
96 "but not the operands") \
97 ENUM_ENTRY(IC_XS, 2, "may say something about the opcode " \
98 "but not the operands") \
99 ENUM_ENTRY(IC_XD_OPSIZE, 3, "requires an OPSIZE prefix, so " \
100 "operands change width") \
101 ENUM_ENTRY(IC_XS_OPSIZE, 3, "requires an OPSIZE prefix, so " \
102 "operands change width") \
103 ENUM_ENTRY(IC_64BIT_REXW, 4, "requires a REX.W prefix, so operands "\
104 "change width; overrides IC_OPSIZE") \
105 ENUM_ENTRY(IC_64BIT_OPSIZE, 3, "Just as meaningful as IC_OPSIZE") \
106 ENUM_ENTRY(IC_64BIT_ADSIZE, 3, "Just as meaningful as IC_ADSIZE") \
107 ENUM_ENTRY(IC_64BIT_XD, 5, "XD instructions are SSE; REX.W is " \
108 "secondary") \
109 ENUM_ENTRY(IC_64BIT_XS, 5, "Just as meaningful as IC_64BIT_XD") \
110 ENUM_ENTRY(IC_64BIT_XD_OPSIZE, 3, "Just as meaningful as IC_XD_OPSIZE") \
111 ENUM_ENTRY(IC_64BIT_XS_OPSIZE, 3, "Just as meaningful as IC_XS_OPSIZE") \
112 ENUM_ENTRY(IC_64BIT_REXW_XS, 6, "OPSIZE could mean a different " \
113 "opcode") \
114 ENUM_ENTRY(IC_64BIT_REXW_XD, 6, "Just as meaningful as " \
115 "IC_64BIT_REXW_XS") \
116 ENUM_ENTRY(IC_64BIT_REXW_OPSIZE, 7, "The Dynamic Duo! Prefer over all " \
117 "else because this changes most " \
118 "operands' meaning") \
119 ENUM_ENTRY(IC_VEX, 1, "requires a VEX prefix") \
120 ENUM_ENTRY(IC_VEX_XS, 2, "requires VEX and the XS prefix") \
121 ENUM_ENTRY(IC_VEX_XD, 2, "requires VEX and the XD prefix") \
122 ENUM_ENTRY(IC_VEX_OPSIZE, 2, "requires VEX and the OpSize prefix") \
123 ENUM_ENTRY(IC_VEX_W, 3, "requires VEX and the W prefix") \
124 ENUM_ENTRY(IC_VEX_W_XS, 4, "requires VEX, W, and XS prefix") \
125 ENUM_ENTRY(IC_VEX_W_XD, 4, "requires VEX, W, and XD prefix") \
126 ENUM_ENTRY(IC_VEX_W_OPSIZE, 4, "requires VEX, W, and OpSize") \
127 ENUM_ENTRY(IC_VEX_L, 3, "requires VEX and the L prefix") \
128 ENUM_ENTRY(IC_VEX_L_XS, 4, "requires VEX and the L and XS prefix")\
129 ENUM_ENTRY(IC_VEX_L_XD, 4, "requires VEX and the L and XD prefix")\
130 ENUM_ENTRY(IC_VEX_L_OPSIZE, 4, "requires VEX, L, and OpSize") \
131 ENUM_ENTRY(IC_VEX_L_W, 4, "requires VEX, L and W") \
132 ENUM_ENTRY(IC_VEX_L_W_XS, 5, "requires VEX, L, W and XS prefix") \
133 ENUM_ENTRY(IC_VEX_L_W_XD, 5, "requires VEX, L, W and XD prefix") \
134 ENUM_ENTRY(IC_VEX_L_W_OPSIZE, 5, "requires VEX, L, W and OpSize") \
135 ENUM_ENTRY(IC_EVEX, 1, "requires an EVEX prefix") \
136 ENUM_ENTRY(IC_EVEX_XS, 2, "requires EVEX and the XS prefix") \
137 ENUM_ENTRY(IC_EVEX_XD, 2, "requires EVEX and the XD prefix") \
138 ENUM_ENTRY(IC_EVEX_OPSIZE, 2, "requires EVEX and the OpSize prefix") \
139 ENUM_ENTRY(IC_EVEX_W, 3, "requires EVEX and the W prefix") \
140 ENUM_ENTRY(IC_EVEX_W_XS, 4, "requires EVEX, W, and XS prefix") \
141 ENUM_ENTRY(IC_EVEX_W_XD, 4, "requires EVEX, W, and XD prefix") \
142 ENUM_ENTRY(IC_EVEX_W_OPSIZE, 4, "requires EVEX, W, and OpSize") \
143 ENUM_ENTRY(IC_EVEX_L, 3, "requires EVEX and the L prefix") \
144 ENUM_ENTRY(IC_EVEX_L_XS, 4, "requires EVEX and the L and XS prefix")\
145 ENUM_ENTRY(IC_EVEX_L_XD, 4, "requires EVEX and the L and XD prefix")\
146 ENUM_ENTRY(IC_EVEX_L_OPSIZE, 4, "requires EVEX, L, and OpSize") \
147 ENUM_ENTRY(IC_EVEX_L_W, 3, "requires EVEX, L and W") \
148 ENUM_ENTRY(IC_EVEX_L_W_XS, 4, "requires EVEX, L, W and XS prefix") \
149 ENUM_ENTRY(IC_EVEX_L_W_XD, 4, "requires EVEX, L, W and XD prefix") \
150 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE, 4, "requires EVEX, L, W and OpSize") \
151 ENUM_ENTRY(IC_EVEX_L2, 3, "requires EVEX and the L2 prefix") \
152 ENUM_ENTRY(IC_EVEX_L2_XS, 4, "requires EVEX and the L2 and XS prefix")\
153 ENUM_ENTRY(IC_EVEX_L2_XD, 4, "requires EVEX and the L2 and XD prefix")\
154 ENUM_ENTRY(IC_EVEX_L2_OPSIZE, 4, "requires EVEX, L2, and OpSize") \
155 ENUM_ENTRY(IC_EVEX_L2_W, 3, "requires EVEX, L2 and W") \
156 ENUM_ENTRY(IC_EVEX_L2_W_XS, 4, "requires EVEX, L2, W and XS prefix") \
157 ENUM_ENTRY(IC_EVEX_L2_W_XD, 4, "requires EVEX, L2, W and XD prefix") \
158 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE, 4, "requires EVEX, L2, W and OpSize") \
159 ENUM_ENTRY(IC_EVEX_K, 1, "requires an EVEX_K prefix") \
160 ENUM_ENTRY(IC_EVEX_XS_K, 2, "requires EVEX_K and the XS prefix") \
161 ENUM_ENTRY(IC_EVEX_XD_K, 2, "requires EVEX_K and the XD prefix") \
162 ENUM_ENTRY(IC_EVEX_OPSIZE_K, 2, "requires EVEX_K and the OpSize prefix") \
163 ENUM_ENTRY(IC_EVEX_W_K, 3, "requires EVEX_K and the W prefix") \
164 ENUM_ENTRY(IC_EVEX_W_XS_K, 4, "requires EVEX_K, W, and XS prefix") \
165 ENUM_ENTRY(IC_EVEX_W_XD_K, 4, "requires EVEX_K, W, and XD prefix") \
166 ENUM_ENTRY(IC_EVEX_W_OPSIZE_K, 4, "requires EVEX_K, W, and OpSize") \
167 ENUM_ENTRY(IC_EVEX_L_K, 3, "requires EVEX_K and the L prefix") \
168 ENUM_ENTRY(IC_EVEX_L_XS_K, 4, "requires EVEX_K and the L and XS prefix")\
169 ENUM_ENTRY(IC_EVEX_L_XD_K, 4, "requires EVEX_K and the L and XD prefix")\
170 ENUM_ENTRY(IC_EVEX_L_OPSIZE_K, 4, "requires EVEX_K, L, and OpSize") \
171 ENUM_ENTRY(IC_EVEX_L_W_K, 3, "requires EVEX_K, L and W") \
172 ENUM_ENTRY(IC_EVEX_L_W_XS_K, 4, "requires EVEX_K, L, W and XS prefix") \
173 ENUM_ENTRY(IC_EVEX_L_W_XD_K, 4, "requires EVEX_K, L, W and XD prefix") \
174 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_K, 4, "requires EVEX_K, L, W and OpSize") \
175 ENUM_ENTRY(IC_EVEX_L2_K, 3, "requires EVEX_K and the L2 prefix") \
176 ENUM_ENTRY(IC_EVEX_L2_XS_K, 4, "requires EVEX_K and the L2 and XS prefix")\
177 ENUM_ENTRY(IC_EVEX_L2_XD_K, 4, "requires EVEX_K and the L2 and XD prefix")\
178 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_K, 4, "requires EVEX_K, L2, and OpSize") \
179 ENUM_ENTRY(IC_EVEX_L2_W_K, 3, "requires EVEX_K, L2 and W") \
180 ENUM_ENTRY(IC_EVEX_L2_W_XS_K, 4, "requires EVEX_K, L2, W and XS prefix") \
181 ENUM_ENTRY(IC_EVEX_L2_W_XD_K, 4, "requires EVEX_K, L2, W and XD prefix") \
182 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_K, 4, "requires EVEX_K, L2, W and OpSize") \
183 ENUM_ENTRY(IC_EVEX_B, 1, "requires an EVEX_B prefix") \
184 ENUM_ENTRY(IC_EVEX_XS_B, 2, "requires EVEX_B and the XS prefix") \
185 ENUM_ENTRY(IC_EVEX_XD_B, 2, "requires EVEX_B and the XD prefix") \
186 ENUM_ENTRY(IC_EVEX_OPSIZE_B, 2, "requires EVEX_B and the OpSize prefix") \
187 ENUM_ENTRY(IC_EVEX_W_B, 3, "requires EVEX_B and the W prefix") \
188 ENUM_ENTRY(IC_EVEX_W_XS_B, 4, "requires EVEX_B, W, and XS prefix") \
189 ENUM_ENTRY(IC_EVEX_W_XD_B, 4, "requires EVEX_B, W, and XD prefix") \
190 ENUM_ENTRY(IC_EVEX_W_OPSIZE_B, 4, "requires EVEX_B, W, and OpSize") \
191 ENUM_ENTRY(IC_EVEX_L_B, 3, "requires EVEX_B and the L prefix") \
192 ENUM_ENTRY(IC_EVEX_L_XS_B, 4, "requires EVEX_B and the L and XS prefix")\
193 ENUM_ENTRY(IC_EVEX_L_XD_B, 4, "requires EVEX_B and the L and XD prefix")\
194 ENUM_ENTRY(IC_EVEX_L_OPSIZE_B, 4, "requires EVEX_B, L, and OpSize") \
195 ENUM_ENTRY(IC_EVEX_L_W_B, 3, "requires EVEX_B, L and W") \
196 ENUM_ENTRY(IC_EVEX_L_W_XS_B, 4, "requires EVEX_B, L, W and XS prefix") \
197 ENUM_ENTRY(IC_EVEX_L_W_XD_B, 4, "requires EVEX_B, L, W and XD prefix") \
198 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_B, 4, "requires EVEX_B, L, W and OpSize") \
199 ENUM_ENTRY(IC_EVEX_L2_B, 3, "requires EVEX_B and the L2 prefix") \
200 ENUM_ENTRY(IC_EVEX_L2_XS_B, 4, "requires EVEX_B and the L2 and XS prefix")\
201 ENUM_ENTRY(IC_EVEX_L2_XD_B, 4, "requires EVEX_B and the L2 and XD prefix")\
202 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_B, 4, "requires EVEX_B, L2, and OpSize") \
203 ENUM_ENTRY(IC_EVEX_L2_W_B, 3, "requires EVEX_B, L2 and W") \
204 ENUM_ENTRY(IC_EVEX_L2_W_XS_B, 4, "requires EVEX_B, L2, W and XS prefix") \
205 ENUM_ENTRY(IC_EVEX_L2_W_XD_B, 4, "requires EVEX_B, L2, W and XD prefix") \
206 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_B, 4, "requires EVEX_B, L2, W and OpSize") \
207 ENUM_ENTRY(IC_EVEX_K_B, 1, "requires EVEX_B and EVEX_K prefix") \
208 ENUM_ENTRY(IC_EVEX_XS_K_B, 2, "requires EVEX_B, EVEX_K and the XS prefix") \
209 ENUM_ENTRY(IC_EVEX_XD_K_B, 2, "requires EVEX_B, EVEX_K and the XD prefix") \
210 ENUM_ENTRY(IC_EVEX_OPSIZE_K_B, 2, "requires EVEX_B, EVEX_K and the OpSize prefix") \
211 ENUM_ENTRY(IC_EVEX_W_K_B, 3, "requires EVEX_B, EVEX_K and the W prefix") \
212 ENUM_ENTRY(IC_EVEX_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, W, and XS prefix") \
213 ENUM_ENTRY(IC_EVEX_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, W, and XD prefix") \
214 ENUM_ENTRY(IC_EVEX_W_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, W, and OpSize") \
215 ENUM_ENTRY(IC_EVEX_L_K_B, 3, "requires EVEX_B, EVEX_K and the L prefix") \
216 ENUM_ENTRY(IC_EVEX_L_XS_K_B, 4, "requires EVEX_B, EVEX_K and the L and XS prefix")\
217 ENUM_ENTRY(IC_EVEX_L_XD_K_B, 4, "requires EVEX_B, EVEX_K and the L and XD prefix")\
218 ENUM_ENTRY(IC_EVEX_L_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, L, and OpSize") \
219 ENUM_ENTRY(IC_EVEX_L_W_K_B, 3, "requires EVEX_B, EVEX_K, L and W") \
220 ENUM_ENTRY(IC_EVEX_L_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, L, W and XS prefix") \
221 ENUM_ENTRY(IC_EVEX_L_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, L, W and XD prefix") \
222 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_K_B,4, "requires EVEX_B, EVEX_K, L, W and OpSize") \
223 ENUM_ENTRY(IC_EVEX_L2_K_B, 3, "requires EVEX_B, EVEX_K and the L2 prefix") \
224 ENUM_ENTRY(IC_EVEX_L2_XS_K_B, 4, "requires EVEX_B, EVEX_K and the L2 and XS prefix")\
225 ENUM_ENTRY(IC_EVEX_L2_XD_K_B, 4, "requires EVEX_B, EVEX_K and the L2 and XD prefix")\
226 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, L2, and OpSize") \
227 ENUM_ENTRY(IC_EVEX_L2_W_K_B, 3, "requires EVEX_B, EVEX_K, L2 and W") \
228 ENUM_ENTRY(IC_EVEX_L2_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, L2, W and XS prefix") \
229 ENUM_ENTRY(IC_EVEX_L2_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, L2, W and XD prefix") \
230 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_K_B,4, "requires EVEX_B, EVEX_K, L2, W and OpSize") \
231 ENUM_ENTRY(IC_EVEX_KZ_B, 1, "requires EVEX_B and EVEX_KZ prefix") \
232 ENUM_ENTRY(IC_EVEX_XS_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the XS prefix") \
233 ENUM_ENTRY(IC_EVEX_XD_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the XD prefix") \
234 ENUM_ENTRY(IC_EVEX_OPSIZE_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the OpSize prefix") \
235 ENUM_ENTRY(IC_EVEX_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the W prefix") \
236 ENUM_ENTRY(IC_EVEX_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and XS prefix") \
237 ENUM_ENTRY(IC_EVEX_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and XD prefix") \
238 ENUM_ENTRY(IC_EVEX_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and OpSize") \
239 ENUM_ENTRY(IC_EVEX_L_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the L prefix") \
240 ENUM_ENTRY(IC_EVEX_L_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L and XS prefix")\
241 ENUM_ENTRY(IC_EVEX_L_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L and XD prefix")\
242 ENUM_ENTRY(IC_EVEX_L_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, and OpSize") \
243 ENUM_ENTRY(IC_EVEX_L_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ, L and W") \
244 ENUM_ENTRY(IC_EVEX_L_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and XS prefix") \
245 ENUM_ENTRY(IC_EVEX_L_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and XD prefix") \
246 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and OpSize") \
247 ENUM_ENTRY(IC_EVEX_L2_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the L2 prefix") \
248 ENUM_ENTRY(IC_EVEX_L2_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L2 and XS prefix")\
249 ENUM_ENTRY(IC_EVEX_L2_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L2 and XD prefix")\
250 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, and OpSize") \
251 ENUM_ENTRY(IC_EVEX_L2_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ, L2 and W") \
252 ENUM_ENTRY(IC_EVEX_L2_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and XS prefix") \
253 ENUM_ENTRY(IC_EVEX_L2_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and XD prefix") \
254 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and OpSize") \
255 ENUM_ENTRY(IC_EVEX_KZ, 1, "requires an EVEX_KZ prefix") \
256 ENUM_ENTRY(IC_EVEX_XS_KZ, 2, "requires EVEX_KZ and the XS prefix") \
257 ENUM_ENTRY(IC_EVEX_XD_KZ, 2, "requires EVEX_KZ and the XD prefix") \
258 ENUM_ENTRY(IC_EVEX_OPSIZE_KZ, 2, "requires EVEX_KZ and the OpSize prefix") \
259 ENUM_ENTRY(IC_EVEX_W_KZ, 3, "requires EVEX_KZ and the W prefix") \
260 ENUM_ENTRY(IC_EVEX_W_XS_KZ, 4, "requires EVEX_KZ, W, and XS prefix") \
261 ENUM_ENTRY(IC_EVEX_W_XD_KZ, 4, "requires EVEX_KZ, W, and XD prefix") \
262 ENUM_ENTRY(IC_EVEX_W_OPSIZE_KZ, 4, "requires EVEX_KZ, W, and OpSize") \
263 ENUM_ENTRY(IC_EVEX_L_KZ, 3, "requires EVEX_KZ and the L prefix") \
264 ENUM_ENTRY(IC_EVEX_L_XS_KZ, 4, "requires EVEX_KZ and the L and XS prefix")\
265 ENUM_ENTRY(IC_EVEX_L_XD_KZ, 4, "requires EVEX_KZ and the L and XD prefix")\
266 ENUM_ENTRY(IC_EVEX_L_OPSIZE_KZ, 4, "requires EVEX_KZ, L, and OpSize") \
267 ENUM_ENTRY(IC_EVEX_L_W_KZ, 3, "requires EVEX_KZ, L and W") \
268 ENUM_ENTRY(IC_EVEX_L_W_XS_KZ, 4, "requires EVEX_KZ, L, W and XS prefix") \
269 ENUM_ENTRY(IC_EVEX_L_W_XD_KZ, 4, "requires EVEX_KZ, L, W and XD prefix") \
270 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_KZ, 4, "requires EVEX_KZ, L, W and OpSize") \
271 ENUM_ENTRY(IC_EVEX_L2_KZ, 3, "requires EVEX_KZ and the L2 prefix") \
272 ENUM_ENTRY(IC_EVEX_L2_XS_KZ, 4, "requires EVEX_KZ and the L2 and XS prefix")\
273 ENUM_ENTRY(IC_EVEX_L2_XD_KZ, 4, "requires EVEX_KZ and the L2 and XD prefix")\
274 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_KZ, 4, "requires EVEX_KZ, L2, and OpSize") \
275 ENUM_ENTRY(IC_EVEX_L2_W_KZ, 3, "requires EVEX_KZ, L2 and W") \
276 ENUM_ENTRY(IC_EVEX_L2_W_XS_KZ, 4, "requires EVEX_KZ, L2, W and XS prefix") \
277 ENUM_ENTRY(IC_EVEX_L2_W_XD_KZ, 4, "requires EVEX_KZ, L2, W and XD prefix") \
278 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_KZ, 4, "requires EVEX_KZ, L2, W and OpSize")
280 #define ENUM_ENTRY(n, r, d) n,
281 typedef enum {
282 INSTRUCTION_CONTEXTS
283 IC_max
284 } InstructionContext;
285 #undef ENUM_ENTRY
287 /*
288 * Opcode types, which determine which decode table to use, both in the Intel
289 * manual and also for the decoder.
290 */
291 typedef enum {
292 ONEBYTE = 0,
293 TWOBYTE = 1,
294 THREEBYTE_38 = 2,
295 THREEBYTE_3A = 3,
296 THREEBYTE_A6 = 4,
297 THREEBYTE_A7 = 5,
298 XOP8_MAP = 6,
299 XOP9_MAP = 7,
300 XOPA_MAP = 8
301 } OpcodeType;
303 /*
304 * The following structs are used for the hierarchical decode table. After
305 * determining the instruction's class (i.e., which IC_* constant applies to
306 * it), the decoder reads the opcode. Some instructions require specific
307 * values of the ModR/M byte, so the ModR/M byte indexes into the final table.
308 *
309 * If a ModR/M byte is not required, "required" is left unset, and the values
310 * for each instructionID are identical.
311 */
313 typedef uint16_t InstrUID;
315 /*
316 * ModRMDecisionType - describes the type of ModR/M decision, allowing the
317 * consumer to determine the number of entries in it.
318 *
319 * MODRM_ONEENTRY - No matter what the value of the ModR/M byte is, the decoded
320 * instruction is the same.
321 * MODRM_SPLITRM - If the ModR/M byte is between 0x00 and 0xbf, the opcode
322 * corresponds to one instruction; otherwise, it corresponds to
323 * a different instruction.
324 * MODRM_SPLITMISC- If the ModR/M byte is between 0x00 and 0xbf, ModR/M byte
325 * divided by 8 is used to select instruction; otherwise, each
326 * value of the ModR/M byte could correspond to a different
327 * instruction.
328 * MODRM_SPLITREG - ModR/M byte divided by 8 is used to select instruction. This
329 corresponds to instructions that use reg field as opcode
330 * MODRM_FULL - Potentially, each value of the ModR/M byte could correspond
331 * to a different instruction.
332 */
334 #define MODRMTYPES \
335 ENUM_ENTRY(MODRM_ONEENTRY) \
336 ENUM_ENTRY(MODRM_SPLITRM) \
337 ENUM_ENTRY(MODRM_SPLITMISC) \
338 ENUM_ENTRY(MODRM_SPLITREG) \
339 ENUM_ENTRY(MODRM_FULL)
341 #define ENUM_ENTRY(n) n,
342 typedef enum {
343 MODRMTYPES
344 MODRM_max
345 } ModRMDecisionType;
346 #undef ENUM_ENTRY
348 /*
349 * ModRMDecision - Specifies whether a ModR/M byte is needed and (if so) which
350 * instruction each possible value of the ModR/M byte corresponds to. Once
351 * this information is known, we have narrowed down to a single instruction.
352 */
353 struct ModRMDecision {
354 uint8_t modrm_type;
356 /* The macro below must be defined wherever this file is included. */
357 INSTRUCTION_IDS
358 };
360 /*
361 * OpcodeDecision - Specifies which set of ModR/M->instruction tables to look at
362 * given a particular opcode.
363 */
364 struct OpcodeDecision {
365 struct ModRMDecision modRMDecisions[256];
366 };
368 /*
369 * ContextDecision - Specifies which opcode->instruction tables to look at given
370 * a particular context (set of attributes). Since there are many possible
371 * contexts, the decoder first uses CONTEXTS_SYM to determine which context
372 * applies given a specific set of attributes. Hence there are only IC_max
373 * entries in this table, rather than 2^(ATTR_max).
374 */
375 struct ContextDecision {
376 struct OpcodeDecision opcodeDecisions[IC_max];
377 };
379 /*
380 * Physical encodings of instruction operands.
381 */
383 #define ENCODINGS \
384 ENUM_ENTRY(ENCODING_NONE, "") \
385 ENUM_ENTRY(ENCODING_REG, "Register operand in ModR/M byte.") \
386 ENUM_ENTRY(ENCODING_RM, "R/M operand in ModR/M byte.") \
387 ENUM_ENTRY(ENCODING_VVVV, "Register operand in VEX.vvvv byte.") \
388 ENUM_ENTRY(ENCODING_WRITEMASK, "Register operand in EVEX.aaa byte.") \
389 ENUM_ENTRY(ENCODING_CB, "1-byte code offset (possible new CS value)") \
390 ENUM_ENTRY(ENCODING_CW, "2-byte") \
391 ENUM_ENTRY(ENCODING_CD, "4-byte") \
392 ENUM_ENTRY(ENCODING_CP, "6-byte") \
393 ENUM_ENTRY(ENCODING_CO, "8-byte") \
394 ENUM_ENTRY(ENCODING_CT, "10-byte") \
395 ENUM_ENTRY(ENCODING_IB, "1-byte immediate") \
396 ENUM_ENTRY(ENCODING_IW, "2-byte") \
397 ENUM_ENTRY(ENCODING_ID, "4-byte") \
398 ENUM_ENTRY(ENCODING_IO, "8-byte") \
399 ENUM_ENTRY(ENCODING_RB, "(AL..DIL, R8L..R15L) Register code added to " \
400 "the opcode byte") \
401 ENUM_ENTRY(ENCODING_RW, "(AX..DI, R8W..R15W)") \
402 ENUM_ENTRY(ENCODING_RD, "(EAX..EDI, R8D..R15D)") \
403 ENUM_ENTRY(ENCODING_RO, "(RAX..RDI, R8..R15)") \
404 ENUM_ENTRY(ENCODING_FP, "Position on floating-point stack in ModR/M " \
405 "byte.") \
406 \
407 ENUM_ENTRY(ENCODING_Iv, "Immediate of operand size") \
408 ENUM_ENTRY(ENCODING_Ia, "Immediate of address size") \
409 ENUM_ENTRY(ENCODING_Rv, "Register code of operand size added to the " \
410 "opcode byte") \
411 ENUM_ENTRY(ENCODING_DUP, "Duplicate of another operand; ID is encoded " \
412 "in type")
414 #define ENUM_ENTRY(n, d) n,
415 typedef enum {
416 ENCODINGS
417 ENCODING_max
418 } OperandEncoding;
419 #undef ENUM_ENTRY
421 /*
422 * Semantic interpretations of instruction operands.
423 */
425 #define TYPES \
426 ENUM_ENTRY(TYPE_NONE, "") \
427 ENUM_ENTRY(TYPE_REL8, "1-byte immediate address") \
428 ENUM_ENTRY(TYPE_REL16, "2-byte") \
429 ENUM_ENTRY(TYPE_REL32, "4-byte") \
430 ENUM_ENTRY(TYPE_REL64, "8-byte") \
431 ENUM_ENTRY(TYPE_PTR1616, "2+2-byte segment+offset address") \
432 ENUM_ENTRY(TYPE_PTR1632, "2+4-byte") \
433 ENUM_ENTRY(TYPE_PTR1664, "2+8-byte") \
434 ENUM_ENTRY(TYPE_R8, "1-byte register operand") \
435 ENUM_ENTRY(TYPE_R16, "2-byte") \
436 ENUM_ENTRY(TYPE_R32, "4-byte") \
437 ENUM_ENTRY(TYPE_R64, "8-byte") \
438 ENUM_ENTRY(TYPE_IMM8, "1-byte immediate operand") \
439 ENUM_ENTRY(TYPE_IMM16, "2-byte") \
440 ENUM_ENTRY(TYPE_IMM32, "4-byte") \
441 ENUM_ENTRY(TYPE_IMM64, "8-byte") \
442 ENUM_ENTRY(TYPE_IMM3, "1-byte immediate operand between 0 and 7") \
443 ENUM_ENTRY(TYPE_IMM5, "1-byte immediate operand between 0 and 31") \
444 ENUM_ENTRY(TYPE_RM8, "1-byte register or memory operand") \
445 ENUM_ENTRY(TYPE_RM16, "2-byte") \
446 ENUM_ENTRY(TYPE_RM32, "4-byte") \
447 ENUM_ENTRY(TYPE_RM64, "8-byte") \
448 ENUM_ENTRY(TYPE_M, "Memory operand") \
449 ENUM_ENTRY(TYPE_M8, "1-byte") \
450 ENUM_ENTRY(TYPE_M16, "2-byte") \
451 ENUM_ENTRY(TYPE_M32, "4-byte") \
452 ENUM_ENTRY(TYPE_M64, "8-byte") \
453 ENUM_ENTRY(TYPE_LEA, "Effective address") \
454 ENUM_ENTRY(TYPE_M128, "16-byte (SSE/SSE2)") \
455 ENUM_ENTRY(TYPE_M256, "256-byte (AVX)") \
456 ENUM_ENTRY(TYPE_M1616, "2+2-byte segment+offset address") \
457 ENUM_ENTRY(TYPE_M1632, "2+4-byte") \
458 ENUM_ENTRY(TYPE_M1664, "2+8-byte") \
459 ENUM_ENTRY(TYPE_M16_32, "2+4-byte two-part memory operand (LIDT, LGDT)") \
460 ENUM_ENTRY(TYPE_M16_16, "2+2-byte (BOUND)") \
461 ENUM_ENTRY(TYPE_M32_32, "4+4-byte (BOUND)") \
462 ENUM_ENTRY(TYPE_M16_64, "2+8-byte (LIDT, LGDT)") \
463 ENUM_ENTRY(TYPE_MOFFS8, "1-byte memory offset (relative to segment " \
464 "base)") \
465 ENUM_ENTRY(TYPE_MOFFS16, "2-byte") \
466 ENUM_ENTRY(TYPE_MOFFS32, "4-byte") \
467 ENUM_ENTRY(TYPE_MOFFS64, "8-byte") \
468 ENUM_ENTRY(TYPE_SREG, "Byte with single bit set: 0 = ES, 1 = CS, " \
469 "2 = SS, 3 = DS, 4 = FS, 5 = GS") \
470 ENUM_ENTRY(TYPE_M32FP, "32-bit IEE754 memory floating-point operand") \
471 ENUM_ENTRY(TYPE_M64FP, "64-bit") \
472 ENUM_ENTRY(TYPE_M80FP, "80-bit extended") \
473 ENUM_ENTRY(TYPE_M16INT, "2-byte memory integer operand for use in " \
474 "floating-point instructions") \
475 ENUM_ENTRY(TYPE_M32INT, "4-byte") \
476 ENUM_ENTRY(TYPE_M64INT, "8-byte") \
477 ENUM_ENTRY(TYPE_ST, "Position on the floating-point stack") \
478 ENUM_ENTRY(TYPE_MM, "MMX register operand") \
479 ENUM_ENTRY(TYPE_MM32, "4-byte MMX register or memory operand") \
480 ENUM_ENTRY(TYPE_MM64, "8-byte") \
481 ENUM_ENTRY(TYPE_XMM, "XMM register operand") \
482 ENUM_ENTRY(TYPE_XMM32, "4-byte XMM register or memory operand") \
483 ENUM_ENTRY(TYPE_XMM64, "8-byte") \
484 ENUM_ENTRY(TYPE_XMM128, "16-byte") \
485 ENUM_ENTRY(TYPE_XMM256, "32-byte") \
486 ENUM_ENTRY(TYPE_XMM512, "64-byte") \
487 ENUM_ENTRY(TYPE_VK1, "1-bit") \
488 ENUM_ENTRY(TYPE_VK8, "8-bit") \
489 ENUM_ENTRY(TYPE_VK16, "16-bit") \
490 ENUM_ENTRY(TYPE_XMM0, "Implicit use of XMM0") \
491 ENUM_ENTRY(TYPE_SEGMENTREG, "Segment register operand") \
492 ENUM_ENTRY(TYPE_DEBUGREG, "Debug register operand") \
493 ENUM_ENTRY(TYPE_CONTROLREG, "Control register operand") \
494 \
495 ENUM_ENTRY(TYPE_Mv, "Memory operand of operand size") \
496 ENUM_ENTRY(TYPE_Rv, "Register operand of operand size") \
497 ENUM_ENTRY(TYPE_IMMv, "Immediate operand of operand size") \
498 ENUM_ENTRY(TYPE_RELv, "Immediate address of operand size") \
499 ENUM_ENTRY(TYPE_DUP0, "Duplicate of operand 0") \
500 ENUM_ENTRY(TYPE_DUP1, "operand 1") \
501 ENUM_ENTRY(TYPE_DUP2, "operand 2") \
502 ENUM_ENTRY(TYPE_DUP3, "operand 3") \
503 ENUM_ENTRY(TYPE_DUP4, "operand 4") \
504 ENUM_ENTRY(TYPE_M512, "512-bit FPU/MMX/XMM/MXCSR state")
506 #define ENUM_ENTRY(n, d) n,
507 typedef enum {
508 TYPES
509 TYPE_max
510 } OperandType;
511 #undef ENUM_ENTRY
513 /*
514 * OperandSpecifier - The specification for how to extract and interpret one
515 * operand.
516 */
517 struct OperandSpecifier {
518 uint8_t encoding;
519 uint8_t type;
520 };
522 /*
523 * Indicates where the opcode modifier (if any) is to be found. Extended
524 * opcodes with AddRegFrm have the opcode modifier in the ModR/M byte.
525 */
527 #define MODIFIER_TYPES \
528 ENUM_ENTRY(MODIFIER_NONE)
530 #define ENUM_ENTRY(n) n,
531 typedef enum {
532 MODIFIER_TYPES
533 MODIFIER_max
534 } ModifierType;
535 #undef ENUM_ENTRY
537 #define X86_MAX_OPERANDS 5
539 /*
540 * The specification for how to extract and interpret a full instruction and
541 * its operands.
542 */
543 struct InstructionSpecifier {
544 /* The macro below must be defined wherever this file is included. */
545 INSTRUCTION_SPECIFIER_FIELDS
546 };
548 /*
549 * Decoding mode for the Intel disassembler. 16-bit, 32-bit, and 64-bit mode
550 * are supported, and represent real mode, IA-32e, and IA-32e in 64-bit mode,
551 * respectively.
552 */
553 typedef enum {
554 MODE_16BIT,
555 MODE_32BIT,
556 MODE_64BIT
557 } DisassemblerMode;
559 #endif