blob: ad1404860fb6b8e6940105701038325f20a96116 [file] [log] [blame]
Richard Smith89ee75d2014-04-20 21:07:34 +00001//===-- 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//===----------------------------------------------------------------------===//
Sean Callanan04cc3072009-12-19 02:59:52 +000016
Benjamin Kramera7c40ef2014-08-13 16:26:38 +000017#ifndef LLVM_LIB_TARGET_X86_DISASSEMBLER_X86DISASSEMBLERDECODERCOMMON_H
18#define LLVM_LIB_TARGET_X86_DISASSEMBLER_X86DISASSEMBLERDECODERCOMMON_H
Sean Callanan04cc3072009-12-19 02:59:52 +000019
Michael J. Spencer447762d2010-11-29 18:16:10 +000020#include "llvm/Support/DataTypes.h"
Sean Callanan04cc3072009-12-19 02:59:52 +000021
Richard Smith89ee75d2014-04-20 21:07:34 +000022namespace llvm {
23namespace X86Disassembler {
24
Sean Callanan04cc3072009-12-19 02:59:52 +000025#define INSTRUCTIONS_SYM x86DisassemblerInstrSpecifiers
26#define CONTEXTS_SYM x86DisassemblerContexts
27#define ONEBYTE_SYM x86DisassemblerOneByteOpcodes
28#define TWOBYTE_SYM x86DisassemblerTwoByteOpcodes
29#define THREEBYTE38_SYM x86DisassemblerThreeByte38Opcodes
30#define THREEBYTE3A_SYM x86DisassemblerThreeByte3AOpcodes
Craig Topper9e3e38a2013-10-03 05:17:48 +000031#define XOP8_MAP_SYM x86DisassemblerXOP8Opcodes
32#define XOP9_MAP_SYM x86DisassemblerXOP9Opcodes
33#define XOPA_MAP_SYM x86DisassemblerXOPAOpcodes
Sean Callanan04cc3072009-12-19 02:59:52 +000034
35#define INSTRUCTIONS_STR "x86DisassemblerInstrSpecifiers"
36#define CONTEXTS_STR "x86DisassemblerContexts"
37#define ONEBYTE_STR "x86DisassemblerOneByteOpcodes"
38#define TWOBYTE_STR "x86DisassemblerTwoByteOpcodes"
39#define THREEBYTE38_STR "x86DisassemblerThreeByte38Opcodes"
40#define THREEBYTE3A_STR "x86DisassemblerThreeByte3AOpcodes"
Craig Topper9e3e38a2013-10-03 05:17:48 +000041#define XOP8_MAP_STR "x86DisassemblerXOP8Opcodes"
42#define XOP9_MAP_STR "x86DisassemblerXOP9Opcodes"
43#define XOPA_MAP_STR "x86DisassemblerXOPAOpcodes"
Sean Callanan04cc3072009-12-19 02:59:52 +000044
Richard Smith6a6967e2014-04-20 22:10:16 +000045// Attributes of an instruction that must be known before the opcode can be
46// processed correctly. Most of these indicate the presence of particular
47// prefixes, but ATTR_64BIT is simply an attribute of the decoding context.
Elena Demikhovsky371e3632013-12-25 11:40:51 +000048#define ATTRIBUTE_BITS \
49 ENUM_ENTRY(ATTR_NONE, 0x00) \
50 ENUM_ENTRY(ATTR_64BIT, (0x1 << 0)) \
51 ENUM_ENTRY(ATTR_XS, (0x1 << 1)) \
52 ENUM_ENTRY(ATTR_XD, (0x1 << 2)) \
53 ENUM_ENTRY(ATTR_REXW, (0x1 << 3)) \
54 ENUM_ENTRY(ATTR_OPSIZE, (0x1 << 4)) \
55 ENUM_ENTRY(ATTR_ADSIZE, (0x1 << 5)) \
56 ENUM_ENTRY(ATTR_VEX, (0x1 << 6)) \
57 ENUM_ENTRY(ATTR_VEXL, (0x1 << 7)) \
58 ENUM_ENTRY(ATTR_EVEX, (0x1 << 8)) \
59 ENUM_ENTRY(ATTR_EVEXL, (0x1 << 9)) \
60 ENUM_ENTRY(ATTR_EVEXL2, (0x1 << 10)) \
61 ENUM_ENTRY(ATTR_EVEXK, (0x1 << 11)) \
62 ENUM_ENTRY(ATTR_EVEXKZ, (0x1 << 12)) \
63 ENUM_ENTRY(ATTR_EVEXB, (0x1 << 13))
Sean Callanan04cc3072009-12-19 02:59:52 +000064
65#define ENUM_ENTRY(n, v) n = v,
66enum attributeBits {
67 ATTRIBUTE_BITS
68 ATTR_max
69};
70#undef ENUM_ENTRY
71
Richard Smith6a6967e2014-04-20 22:10:16 +000072// Combinations of the above attributes that are relevant to instruction
73// decode. Although other combinations are possible, they can be reduced to
74// these without affecting the ultimately decoded instruction.
Sean Callanan04cc3072009-12-19 02:59:52 +000075
Richard Smith6a6967e2014-04-20 22:10:16 +000076// Class name Rank Rationale for rank assignment
Sean Callanan04cc3072009-12-19 02:59:52 +000077#define INSTRUCTION_CONTEXTS \
78 ENUM_ENTRY(IC, 0, "says nothing about the instruction") \
79 ENUM_ENTRY(IC_64BIT, 1, "says the instruction applies in " \
80 "64-bit mode but no more") \
81 ENUM_ENTRY(IC_OPSIZE, 3, "requires an OPSIZE prefix, so " \
82 "operands change width") \
Craig Topper6491c802012-02-27 01:54:29 +000083 ENUM_ENTRY(IC_ADSIZE, 3, "requires an ADSIZE prefix, so " \
84 "operands change width") \
Craig Topper99bcab72014-12-31 07:07:31 +000085 ENUM_ENTRY(IC_OPSIZE_ADSIZE, 4, "requires ADSIZE and OPSIZE prefixes") \
Sean Callanan04cc3072009-12-19 02:59:52 +000086 ENUM_ENTRY(IC_XD, 2, "may say something about the opcode " \
87 "but not the operands") \
88 ENUM_ENTRY(IC_XS, 2, "may say something about the opcode " \
89 "but not the operands") \
Craig Topper88cb33e2011-10-01 19:54:56 +000090 ENUM_ENTRY(IC_XD_OPSIZE, 3, "requires an OPSIZE prefix, so " \
91 "operands change width") \
Craig Toppera6978522011-10-11 04:34:23 +000092 ENUM_ENTRY(IC_XS_OPSIZE, 3, "requires an OPSIZE prefix, so " \
93 "operands change width") \
Craig Topper99bcab72014-12-31 07:07:31 +000094 ENUM_ENTRY(IC_64BIT_REXW, 5, "requires a REX.W prefix, so operands "\
Sean Callanan04cc3072009-12-19 02:59:52 +000095 "change width; overrides IC_OPSIZE") \
Craig Topperae8e1b32015-01-03 00:00:20 +000096 ENUM_ENTRY(IC_64BIT_REXW_ADSIZE, 6, "requires a REX.W prefix and 0x67 " \
97 "prefix") \
Sean Callanan04cc3072009-12-19 02:59:52 +000098 ENUM_ENTRY(IC_64BIT_OPSIZE, 3, "Just as meaningful as IC_OPSIZE") \
Craig Topper6491c802012-02-27 01:54:29 +000099 ENUM_ENTRY(IC_64BIT_ADSIZE, 3, "Just as meaningful as IC_ADSIZE") \
Craig Topper99bcab72014-12-31 07:07:31 +0000100 ENUM_ENTRY(IC_64BIT_OPSIZE_ADSIZE, 4, "Just as meaningful as IC_OPSIZE/" \
101 "IC_ADSIZE") \
102 ENUM_ENTRY(IC_64BIT_XD, 6, "XD instructions are SSE; REX.W is " \
Sean Callanan04cc3072009-12-19 02:59:52 +0000103 "secondary") \
Craig Topper99bcab72014-12-31 07:07:31 +0000104 ENUM_ENTRY(IC_64BIT_XS, 6, "Just as meaningful as IC_64BIT_XD") \
Craig Topper88cb33e2011-10-01 19:54:56 +0000105 ENUM_ENTRY(IC_64BIT_XD_OPSIZE, 3, "Just as meaningful as IC_XD_OPSIZE") \
Craig Toppera6978522011-10-11 04:34:23 +0000106 ENUM_ENTRY(IC_64BIT_XS_OPSIZE, 3, "Just as meaningful as IC_XS_OPSIZE") \
Craig Topper99bcab72014-12-31 07:07:31 +0000107 ENUM_ENTRY(IC_64BIT_REXW_XS, 7, "OPSIZE could mean a different " \
Sean Callanan04cc3072009-12-19 02:59:52 +0000108 "opcode") \
Craig Topper99bcab72014-12-31 07:07:31 +0000109 ENUM_ENTRY(IC_64BIT_REXW_XD, 7, "Just as meaningful as " \
Sean Callanan04cc3072009-12-19 02:59:52 +0000110 "IC_64BIT_REXW_XS") \
Craig Topper99bcab72014-12-31 07:07:31 +0000111 ENUM_ENTRY(IC_64BIT_REXW_OPSIZE, 8, "The Dynamic Duo! Prefer over all " \
Sean Callanan04cc3072009-12-19 02:59:52 +0000112 "else because this changes most " \
Sean Callananc3fd5232011-03-15 01:23:15 +0000113 "operands' meaning") \
114 ENUM_ENTRY(IC_VEX, 1, "requires a VEX prefix") \
115 ENUM_ENTRY(IC_VEX_XS, 2, "requires VEX and the XS prefix") \
116 ENUM_ENTRY(IC_VEX_XD, 2, "requires VEX and the XD prefix") \
117 ENUM_ENTRY(IC_VEX_OPSIZE, 2, "requires VEX and the OpSize prefix") \
118 ENUM_ENTRY(IC_VEX_W, 3, "requires VEX and the W prefix") \
119 ENUM_ENTRY(IC_VEX_W_XS, 4, "requires VEX, W, and XS prefix") \
120 ENUM_ENTRY(IC_VEX_W_XD, 4, "requires VEX, W, and XD prefix") \
121 ENUM_ENTRY(IC_VEX_W_OPSIZE, 4, "requires VEX, W, and OpSize") \
122 ENUM_ENTRY(IC_VEX_L, 3, "requires VEX and the L prefix") \
123 ENUM_ENTRY(IC_VEX_L_XS, 4, "requires VEX and the L and XS prefix")\
Craig Topperf18c8962011-10-04 06:30:42 +0000124 ENUM_ENTRY(IC_VEX_L_XD, 4, "requires VEX and the L and XD prefix")\
Craig Topperf01f1b52011-11-06 23:04:08 +0000125 ENUM_ENTRY(IC_VEX_L_OPSIZE, 4, "requires VEX, L, and OpSize") \
Craig Toppered59dd32013-09-30 02:46:36 +0000126 ENUM_ENTRY(IC_VEX_L_W, 4, "requires VEX, L and W") \
127 ENUM_ENTRY(IC_VEX_L_W_XS, 5, "requires VEX, L, W and XS prefix") \
128 ENUM_ENTRY(IC_VEX_L_W_XD, 5, "requires VEX, L, W and XD prefix") \
129 ENUM_ENTRY(IC_VEX_L_W_OPSIZE, 5, "requires VEX, L, W and OpSize") \
Elena Demikhovsky003e7d72013-07-28 08:28:38 +0000130 ENUM_ENTRY(IC_EVEX, 1, "requires an EVEX prefix") \
131 ENUM_ENTRY(IC_EVEX_XS, 2, "requires EVEX and the XS prefix") \
132 ENUM_ENTRY(IC_EVEX_XD, 2, "requires EVEX and the XD prefix") \
133 ENUM_ENTRY(IC_EVEX_OPSIZE, 2, "requires EVEX and the OpSize prefix") \
134 ENUM_ENTRY(IC_EVEX_W, 3, "requires EVEX and the W prefix") \
135 ENUM_ENTRY(IC_EVEX_W_XS, 4, "requires EVEX, W, and XS prefix") \
136 ENUM_ENTRY(IC_EVEX_W_XD, 4, "requires EVEX, W, and XD prefix") \
137 ENUM_ENTRY(IC_EVEX_W_OPSIZE, 4, "requires EVEX, W, and OpSize") \
138 ENUM_ENTRY(IC_EVEX_L, 3, "requires EVEX and the L prefix") \
139 ENUM_ENTRY(IC_EVEX_L_XS, 4, "requires EVEX and the L and XS prefix")\
140 ENUM_ENTRY(IC_EVEX_L_XD, 4, "requires EVEX and the L and XD prefix")\
141 ENUM_ENTRY(IC_EVEX_L_OPSIZE, 4, "requires EVEX, L, and OpSize") \
142 ENUM_ENTRY(IC_EVEX_L_W, 3, "requires EVEX, L and W") \
143 ENUM_ENTRY(IC_EVEX_L_W_XS, 4, "requires EVEX, L, W and XS prefix") \
144 ENUM_ENTRY(IC_EVEX_L_W_XD, 4, "requires EVEX, L, W and XD prefix") \
145 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE, 4, "requires EVEX, L, W and OpSize") \
146 ENUM_ENTRY(IC_EVEX_L2, 3, "requires EVEX and the L2 prefix") \
147 ENUM_ENTRY(IC_EVEX_L2_XS, 4, "requires EVEX and the L2 and XS prefix")\
148 ENUM_ENTRY(IC_EVEX_L2_XD, 4, "requires EVEX and the L2 and XD prefix")\
149 ENUM_ENTRY(IC_EVEX_L2_OPSIZE, 4, "requires EVEX, L2, and OpSize") \
150 ENUM_ENTRY(IC_EVEX_L2_W, 3, "requires EVEX, L2 and W") \
151 ENUM_ENTRY(IC_EVEX_L2_W_XS, 4, "requires EVEX, L2, W and XS prefix") \
152 ENUM_ENTRY(IC_EVEX_L2_W_XD, 4, "requires EVEX, L2, W and XD prefix") \
153 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE, 4, "requires EVEX, L2, W and OpSize") \
154 ENUM_ENTRY(IC_EVEX_K, 1, "requires an EVEX_K prefix") \
155 ENUM_ENTRY(IC_EVEX_XS_K, 2, "requires EVEX_K and the XS prefix") \
156 ENUM_ENTRY(IC_EVEX_XD_K, 2, "requires EVEX_K and the XD prefix") \
157 ENUM_ENTRY(IC_EVEX_OPSIZE_K, 2, "requires EVEX_K and the OpSize prefix") \
158 ENUM_ENTRY(IC_EVEX_W_K, 3, "requires EVEX_K and the W prefix") \
159 ENUM_ENTRY(IC_EVEX_W_XS_K, 4, "requires EVEX_K, W, and XS prefix") \
160 ENUM_ENTRY(IC_EVEX_W_XD_K, 4, "requires EVEX_K, W, and XD prefix") \
161 ENUM_ENTRY(IC_EVEX_W_OPSIZE_K, 4, "requires EVEX_K, W, and OpSize") \
162 ENUM_ENTRY(IC_EVEX_L_K, 3, "requires EVEX_K and the L prefix") \
163 ENUM_ENTRY(IC_EVEX_L_XS_K, 4, "requires EVEX_K and the L and XS prefix")\
164 ENUM_ENTRY(IC_EVEX_L_XD_K, 4, "requires EVEX_K and the L and XD prefix")\
165 ENUM_ENTRY(IC_EVEX_L_OPSIZE_K, 4, "requires EVEX_K, L, and OpSize") \
166 ENUM_ENTRY(IC_EVEX_L_W_K, 3, "requires EVEX_K, L and W") \
167 ENUM_ENTRY(IC_EVEX_L_W_XS_K, 4, "requires EVEX_K, L, W and XS prefix") \
168 ENUM_ENTRY(IC_EVEX_L_W_XD_K, 4, "requires EVEX_K, L, W and XD prefix") \
169 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_K, 4, "requires EVEX_K, L, W and OpSize") \
170 ENUM_ENTRY(IC_EVEX_L2_K, 3, "requires EVEX_K and the L2 prefix") \
171 ENUM_ENTRY(IC_EVEX_L2_XS_K, 4, "requires EVEX_K and the L2 and XS prefix")\
172 ENUM_ENTRY(IC_EVEX_L2_XD_K, 4, "requires EVEX_K and the L2 and XD prefix")\
173 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_K, 4, "requires EVEX_K, L2, and OpSize") \
174 ENUM_ENTRY(IC_EVEX_L2_W_K, 3, "requires EVEX_K, L2 and W") \
175 ENUM_ENTRY(IC_EVEX_L2_W_XS_K, 4, "requires EVEX_K, L2, W and XS prefix") \
176 ENUM_ENTRY(IC_EVEX_L2_W_XD_K, 4, "requires EVEX_K, L2, W and XD prefix") \
177 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_K, 4, "requires EVEX_K, L2, W and OpSize") \
178 ENUM_ENTRY(IC_EVEX_B, 1, "requires an EVEX_B prefix") \
179 ENUM_ENTRY(IC_EVEX_XS_B, 2, "requires EVEX_B and the XS prefix") \
180 ENUM_ENTRY(IC_EVEX_XD_B, 2, "requires EVEX_B and the XD prefix") \
181 ENUM_ENTRY(IC_EVEX_OPSIZE_B, 2, "requires EVEX_B and the OpSize prefix") \
182 ENUM_ENTRY(IC_EVEX_W_B, 3, "requires EVEX_B and the W prefix") \
183 ENUM_ENTRY(IC_EVEX_W_XS_B, 4, "requires EVEX_B, W, and XS prefix") \
184 ENUM_ENTRY(IC_EVEX_W_XD_B, 4, "requires EVEX_B, W, and XD prefix") \
185 ENUM_ENTRY(IC_EVEX_W_OPSIZE_B, 4, "requires EVEX_B, W, and OpSize") \
186 ENUM_ENTRY(IC_EVEX_L_B, 3, "requires EVEX_B and the L prefix") \
187 ENUM_ENTRY(IC_EVEX_L_XS_B, 4, "requires EVEX_B and the L and XS prefix")\
188 ENUM_ENTRY(IC_EVEX_L_XD_B, 4, "requires EVEX_B and the L and XD prefix")\
189 ENUM_ENTRY(IC_EVEX_L_OPSIZE_B, 4, "requires EVEX_B, L, and OpSize") \
190 ENUM_ENTRY(IC_EVEX_L_W_B, 3, "requires EVEX_B, L and W") \
191 ENUM_ENTRY(IC_EVEX_L_W_XS_B, 4, "requires EVEX_B, L, W and XS prefix") \
192 ENUM_ENTRY(IC_EVEX_L_W_XD_B, 4, "requires EVEX_B, L, W and XD prefix") \
193 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_B, 4, "requires EVEX_B, L, W and OpSize") \
194 ENUM_ENTRY(IC_EVEX_L2_B, 3, "requires EVEX_B and the L2 prefix") \
195 ENUM_ENTRY(IC_EVEX_L2_XS_B, 4, "requires EVEX_B and the L2 and XS prefix")\
196 ENUM_ENTRY(IC_EVEX_L2_XD_B, 4, "requires EVEX_B and the L2 and XD prefix")\
197 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_B, 4, "requires EVEX_B, L2, and OpSize") \
198 ENUM_ENTRY(IC_EVEX_L2_W_B, 3, "requires EVEX_B, L2 and W") \
199 ENUM_ENTRY(IC_EVEX_L2_W_XS_B, 4, "requires EVEX_B, L2, W and XS prefix") \
200 ENUM_ENTRY(IC_EVEX_L2_W_XD_B, 4, "requires EVEX_B, L2, W and XD prefix") \
201 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_B, 4, "requires EVEX_B, L2, W and OpSize") \
Elena Demikhovsky371e3632013-12-25 11:40:51 +0000202 ENUM_ENTRY(IC_EVEX_K_B, 1, "requires EVEX_B and EVEX_K prefix") \
203 ENUM_ENTRY(IC_EVEX_XS_K_B, 2, "requires EVEX_B, EVEX_K and the XS prefix") \
204 ENUM_ENTRY(IC_EVEX_XD_K_B, 2, "requires EVEX_B, EVEX_K and the XD prefix") \
205 ENUM_ENTRY(IC_EVEX_OPSIZE_K_B, 2, "requires EVEX_B, EVEX_K and the OpSize prefix") \
206 ENUM_ENTRY(IC_EVEX_W_K_B, 3, "requires EVEX_B, EVEX_K and the W prefix") \
207 ENUM_ENTRY(IC_EVEX_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, W, and XS prefix") \
208 ENUM_ENTRY(IC_EVEX_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, W, and XD prefix") \
209 ENUM_ENTRY(IC_EVEX_W_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, W, and OpSize") \
210 ENUM_ENTRY(IC_EVEX_L_K_B, 3, "requires EVEX_B, EVEX_K and the L prefix") \
211 ENUM_ENTRY(IC_EVEX_L_XS_K_B, 4, "requires EVEX_B, EVEX_K and the L and XS prefix")\
212 ENUM_ENTRY(IC_EVEX_L_XD_K_B, 4, "requires EVEX_B, EVEX_K and the L and XD prefix")\
213 ENUM_ENTRY(IC_EVEX_L_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, L, and OpSize") \
214 ENUM_ENTRY(IC_EVEX_L_W_K_B, 3, "requires EVEX_B, EVEX_K, L and W") \
215 ENUM_ENTRY(IC_EVEX_L_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, L, W and XS prefix") \
216 ENUM_ENTRY(IC_EVEX_L_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, L, W and XD prefix") \
217 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_K_B,4, "requires EVEX_B, EVEX_K, L, W and OpSize") \
218 ENUM_ENTRY(IC_EVEX_L2_K_B, 3, "requires EVEX_B, EVEX_K and the L2 prefix") \
219 ENUM_ENTRY(IC_EVEX_L2_XS_K_B, 4, "requires EVEX_B, EVEX_K and the L2 and XS prefix")\
220 ENUM_ENTRY(IC_EVEX_L2_XD_K_B, 4, "requires EVEX_B, EVEX_K and the L2 and XD prefix")\
221 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_K_B, 4, "requires EVEX_B, EVEX_K, L2, and OpSize") \
222 ENUM_ENTRY(IC_EVEX_L2_W_K_B, 3, "requires EVEX_B, EVEX_K, L2 and W") \
223 ENUM_ENTRY(IC_EVEX_L2_W_XS_K_B, 4, "requires EVEX_B, EVEX_K, L2, W and XS prefix") \
224 ENUM_ENTRY(IC_EVEX_L2_W_XD_K_B, 4, "requires EVEX_B, EVEX_K, L2, W and XD prefix") \
225 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_K_B,4, "requires EVEX_B, EVEX_K, L2, W and OpSize") \
226 ENUM_ENTRY(IC_EVEX_KZ_B, 1, "requires EVEX_B and EVEX_KZ prefix") \
227 ENUM_ENTRY(IC_EVEX_XS_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the XS prefix") \
228 ENUM_ENTRY(IC_EVEX_XD_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the XD prefix") \
229 ENUM_ENTRY(IC_EVEX_OPSIZE_KZ_B, 2, "requires EVEX_B, EVEX_KZ and the OpSize prefix") \
230 ENUM_ENTRY(IC_EVEX_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the W prefix") \
231 ENUM_ENTRY(IC_EVEX_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and XS prefix") \
232 ENUM_ENTRY(IC_EVEX_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and XD prefix") \
233 ENUM_ENTRY(IC_EVEX_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, W, and OpSize") \
Elena Demikhovskydacddb02013-11-03 13:46:31 +0000234 ENUM_ENTRY(IC_EVEX_L_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the L prefix") \
235 ENUM_ENTRY(IC_EVEX_L_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L and XS prefix")\
236 ENUM_ENTRY(IC_EVEX_L_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L and XD prefix")\
237 ENUM_ENTRY(IC_EVEX_L_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, and OpSize") \
238 ENUM_ENTRY(IC_EVEX_L_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ, L and W") \
239 ENUM_ENTRY(IC_EVEX_L_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and XS prefix") \
240 ENUM_ENTRY(IC_EVEX_L_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and XD prefix") \
241 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L, W and OpSize") \
242 ENUM_ENTRY(IC_EVEX_L2_KZ_B, 3, "requires EVEX_B, EVEX_KZ and the L2 prefix") \
243 ENUM_ENTRY(IC_EVEX_L2_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L2 and XS prefix")\
244 ENUM_ENTRY(IC_EVEX_L2_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ and the L2 and XD prefix")\
245 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, and OpSize") \
246 ENUM_ENTRY(IC_EVEX_L2_W_KZ_B, 3, "requires EVEX_B, EVEX_KZ, L2 and W") \
247 ENUM_ENTRY(IC_EVEX_L2_W_XS_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and XS prefix") \
248 ENUM_ENTRY(IC_EVEX_L2_W_XD_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and XD prefix") \
249 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_KZ_B, 4, "requires EVEX_B, EVEX_KZ, L2, W and OpSize") \
250 ENUM_ENTRY(IC_EVEX_KZ, 1, "requires an EVEX_KZ prefix") \
251 ENUM_ENTRY(IC_EVEX_XS_KZ, 2, "requires EVEX_KZ and the XS prefix") \
252 ENUM_ENTRY(IC_EVEX_XD_KZ, 2, "requires EVEX_KZ and the XD prefix") \
253 ENUM_ENTRY(IC_EVEX_OPSIZE_KZ, 2, "requires EVEX_KZ and the OpSize prefix") \
254 ENUM_ENTRY(IC_EVEX_W_KZ, 3, "requires EVEX_KZ and the W prefix") \
255 ENUM_ENTRY(IC_EVEX_W_XS_KZ, 4, "requires EVEX_KZ, W, and XS prefix") \
256 ENUM_ENTRY(IC_EVEX_W_XD_KZ, 4, "requires EVEX_KZ, W, and XD prefix") \
257 ENUM_ENTRY(IC_EVEX_W_OPSIZE_KZ, 4, "requires EVEX_KZ, W, and OpSize") \
258 ENUM_ENTRY(IC_EVEX_L_KZ, 3, "requires EVEX_KZ and the L prefix") \
259 ENUM_ENTRY(IC_EVEX_L_XS_KZ, 4, "requires EVEX_KZ and the L and XS prefix")\
260 ENUM_ENTRY(IC_EVEX_L_XD_KZ, 4, "requires EVEX_KZ and the L and XD prefix")\
261 ENUM_ENTRY(IC_EVEX_L_OPSIZE_KZ, 4, "requires EVEX_KZ, L, and OpSize") \
262 ENUM_ENTRY(IC_EVEX_L_W_KZ, 3, "requires EVEX_KZ, L and W") \
263 ENUM_ENTRY(IC_EVEX_L_W_XS_KZ, 4, "requires EVEX_KZ, L, W and XS prefix") \
264 ENUM_ENTRY(IC_EVEX_L_W_XD_KZ, 4, "requires EVEX_KZ, L, W and XD prefix") \
265 ENUM_ENTRY(IC_EVEX_L_W_OPSIZE_KZ, 4, "requires EVEX_KZ, L, W and OpSize") \
266 ENUM_ENTRY(IC_EVEX_L2_KZ, 3, "requires EVEX_KZ and the L2 prefix") \
267 ENUM_ENTRY(IC_EVEX_L2_XS_KZ, 4, "requires EVEX_KZ and the L2 and XS prefix")\
268 ENUM_ENTRY(IC_EVEX_L2_XD_KZ, 4, "requires EVEX_KZ and the L2 and XD prefix")\
269 ENUM_ENTRY(IC_EVEX_L2_OPSIZE_KZ, 4, "requires EVEX_KZ, L2, and OpSize") \
270 ENUM_ENTRY(IC_EVEX_L2_W_KZ, 3, "requires EVEX_KZ, L2 and W") \
271 ENUM_ENTRY(IC_EVEX_L2_W_XS_KZ, 4, "requires EVEX_KZ, L2, W and XS prefix") \
272 ENUM_ENTRY(IC_EVEX_L2_W_XD_KZ, 4, "requires EVEX_KZ, L2, W and XD prefix") \
Robert Khasanovbfa01312014-07-21 14:54:21 +0000273 ENUM_ENTRY(IC_EVEX_L2_W_OPSIZE_KZ, 4, "requires EVEX_KZ, L2, W and OpSize")
Sean Callanan04cc3072009-12-19 02:59:52 +0000274
Craig Topper5f33d902012-07-31 04:38:27 +0000275#define ENUM_ENTRY(n, r, d) n,
Richard Smith89ee75d2014-04-20 21:07:34 +0000276enum InstructionContext {
Sean Callanan04cc3072009-12-19 02:59:52 +0000277 INSTRUCTION_CONTEXTS
278 IC_max
Richard Smith89ee75d2014-04-20 21:07:34 +0000279};
Sean Callanan04cc3072009-12-19 02:59:52 +0000280#undef ENUM_ENTRY
281
Richard Smith6a6967e2014-04-20 22:10:16 +0000282// Opcode types, which determine which decode table to use, both in the Intel
283// manual and also for the decoder.
Richard Smith89ee75d2014-04-20 21:07:34 +0000284enum OpcodeType {
Sean Callanan04cc3072009-12-19 02:59:52 +0000285 ONEBYTE = 0,
286 TWOBYTE = 1,
287 THREEBYTE_38 = 2,
Joerg Sonnenbergerfc4789d2011-04-04 16:58:13 +0000288 THREEBYTE_3A = 3,
Craig Topper0d1fd552014-02-19 05:34:21 +0000289 XOP8_MAP = 4,
290 XOP9_MAP = 5,
291 XOPA_MAP = 6
Richard Smith89ee75d2014-04-20 21:07:34 +0000292};
Sean Callanan04cc3072009-12-19 02:59:52 +0000293
Richard Smith6a6967e2014-04-20 22:10:16 +0000294// The following structs are used for the hierarchical decode table. After
295// determining the instruction's class (i.e., which IC_* constant applies to
296// it), the decoder reads the opcode. Some instructions require specific
297// values of the ModR/M byte, so the ModR/M byte indexes into the final table.
298//
299// If a ModR/M byte is not required, "required" is left unset, and the values
300// for each instructionID are identical.
Sean Callanan04cc3072009-12-19 02:59:52 +0000301typedef uint16_t InstrUID;
302
Richard Smith6a6967e2014-04-20 22:10:16 +0000303// ModRMDecisionType - describes the type of ModR/M decision, allowing the
304// consumer to determine the number of entries in it.
305//
306// MODRM_ONEENTRY - No matter what the value of the ModR/M byte is, the decoded
307// instruction is the same.
308// MODRM_SPLITRM - If the ModR/M byte is between 0x00 and 0xbf, the opcode
309// corresponds to one instruction; otherwise, it corresponds to
310// a different instruction.
311// MODRM_SPLITMISC- If the ModR/M byte is between 0x00 and 0xbf, ModR/M byte
312// divided by 8 is used to select instruction; otherwise, each
313// value of the ModR/M byte could correspond to a different
314// instruction.
315// MODRM_SPLITREG - ModR/M byte divided by 8 is used to select instruction. This
316// corresponds to instructions that use reg field as opcode
317// MODRM_FULL - Potentially, each value of the ModR/M byte could correspond
318// to a different instruction.
Sean Callanan04cc3072009-12-19 02:59:52 +0000319#define MODRMTYPES \
320 ENUM_ENTRY(MODRM_ONEENTRY) \
321 ENUM_ENTRY(MODRM_SPLITRM) \
Craig Topper963305b2012-09-13 05:45:42 +0000322 ENUM_ENTRY(MODRM_SPLITMISC) \
Craig Toppera0cd9702012-02-09 08:58:07 +0000323 ENUM_ENTRY(MODRM_SPLITREG) \
Sean Callanan04cc3072009-12-19 02:59:52 +0000324 ENUM_ENTRY(MODRM_FULL)
325
Craig Topper5f33d902012-07-31 04:38:27 +0000326#define ENUM_ENTRY(n) n,
Richard Smith89ee75d2014-04-20 21:07:34 +0000327enum ModRMDecisionType {
Sean Callanan04cc3072009-12-19 02:59:52 +0000328 MODRMTYPES
329 MODRM_max
Richard Smith89ee75d2014-04-20 21:07:34 +0000330};
Sean Callanan04cc3072009-12-19 02:59:52 +0000331#undef ENUM_ENTRY
332
Adam Nemet5933c2f2014-07-17 17:04:56 +0000333#define CASE_ENCODING_RM \
334 case ENCODING_RM: \
335 case ENCODING_RM_CD2: \
336 case ENCODING_RM_CD4: \
337 case ENCODING_RM_CD8: \
338 case ENCODING_RM_CD16: \
339 case ENCODING_RM_CD32: \
340 case ENCODING_RM_CD64
341
Craig Topper33ac0642017-01-16 05:44:25 +0000342#define CASE_ENCODING_VSIB \
343 case ENCODING_VSIB: \
344 case ENCODING_VSIB_CD2: \
345 case ENCODING_VSIB_CD4: \
346 case ENCODING_VSIB_CD8: \
347 case ENCODING_VSIB_CD16: \
348 case ENCODING_VSIB_CD32: \
349 case ENCODING_VSIB_CD64
350
Richard Smith6a6967e2014-04-20 22:10:16 +0000351// Physical encodings of instruction operands.
Sean Callanan04cc3072009-12-19 02:59:52 +0000352#define ENCODINGS \
353 ENUM_ENTRY(ENCODING_NONE, "") \
354 ENUM_ENTRY(ENCODING_REG, "Register operand in ModR/M byte.") \
355 ENUM_ENTRY(ENCODING_RM, "R/M operand in ModR/M byte.") \
Adam Nemet5933c2f2014-07-17 17:04:56 +0000356 ENUM_ENTRY(ENCODING_RM_CD2, "R/M operand with CDisp scaling of 2") \
357 ENUM_ENTRY(ENCODING_RM_CD4, "R/M operand with CDisp scaling of 4") \
358 ENUM_ENTRY(ENCODING_RM_CD8, "R/M operand with CDisp scaling of 8") \
359 ENUM_ENTRY(ENCODING_RM_CD16,"R/M operand with CDisp scaling of 16") \
360 ENUM_ENTRY(ENCODING_RM_CD32,"R/M operand with CDisp scaling of 32") \
361 ENUM_ENTRY(ENCODING_RM_CD64,"R/M operand with CDisp scaling of 64") \
Craig Topper33ac0642017-01-16 05:44:25 +0000362 ENUM_ENTRY(ENCODING_VSIB, "VSIB operand in ModR/M byte.") \
363 ENUM_ENTRY(ENCODING_VSIB_CD2, "VSIB operand with CDisp scaling of 2") \
364 ENUM_ENTRY(ENCODING_VSIB_CD4, "VSIB operand with CDisp scaling of 4") \
365 ENUM_ENTRY(ENCODING_VSIB_CD8, "VSIB operand with CDisp scaling of 8") \
366 ENUM_ENTRY(ENCODING_VSIB_CD16,"VSIB operand with CDisp scaling of 16") \
367 ENUM_ENTRY(ENCODING_VSIB_CD32,"VSIB operand with CDisp scaling of 32") \
368 ENUM_ENTRY(ENCODING_VSIB_CD64,"VSIB operand with CDisp scaling of 64") \
Sean Callananc3fd5232011-03-15 01:23:15 +0000369 ENUM_ENTRY(ENCODING_VVVV, "Register operand in VEX.vvvv byte.") \
Elena Demikhovsky003e7d72013-07-28 08:28:38 +0000370 ENUM_ENTRY(ENCODING_WRITEMASK, "Register operand in EVEX.aaa byte.") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000371 ENUM_ENTRY(ENCODING_IB, "1-byte immediate") \
372 ENUM_ENTRY(ENCODING_IW, "2-byte") \
373 ENUM_ENTRY(ENCODING_ID, "4-byte") \
374 ENUM_ENTRY(ENCODING_IO, "8-byte") \
375 ENUM_ENTRY(ENCODING_RB, "(AL..DIL, R8L..R15L) Register code added to " \
376 "the opcode byte") \
377 ENUM_ENTRY(ENCODING_RW, "(AX..DI, R8W..R15W)") \
378 ENUM_ENTRY(ENCODING_RD, "(EAX..EDI, R8D..R15D)") \
379 ENUM_ENTRY(ENCODING_RO, "(RAX..RDI, R8..R15)") \
Craig Topper623b0d62014-01-01 14:22:37 +0000380 ENUM_ENTRY(ENCODING_FP, "Position on floating-point stack in ModR/M " \
381 "byte.") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000382 \
383 ENUM_ENTRY(ENCODING_Iv, "Immediate of operand size") \
384 ENUM_ENTRY(ENCODING_Ia, "Immediate of address size") \
Craig Topper326008c2017-10-23 02:26:24 +0000385 ENUM_ENTRY(ENCODING_IRC, "Immediate for static rounding control") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000386 ENUM_ENTRY(ENCODING_Rv, "Register code of operand size added to the " \
387 "opcode byte") \
388 ENUM_ENTRY(ENCODING_DUP, "Duplicate of another operand; ID is encoded " \
David Woodhouse2ef8d9c2014-01-22 15:08:08 +0000389 "in type") \
David Woodhouseb33c2ef2014-01-22 15:08:21 +0000390 ENUM_ENTRY(ENCODING_SI, "Source index; encoded in OpSize/Adsize prefix") \
391 ENUM_ENTRY(ENCODING_DI, "Destination index; encoded in prefixes")
Sean Callanan04cc3072009-12-19 02:59:52 +0000392
Craig Topper5f33d902012-07-31 04:38:27 +0000393#define ENUM_ENTRY(n, d) n,
Richard Smith89ee75d2014-04-20 21:07:34 +0000394enum OperandEncoding {
395 ENCODINGS
396 ENCODING_max
397};
Sean Callanan04cc3072009-12-19 02:59:52 +0000398#undef ENUM_ENTRY
399
Richard Smith6a6967e2014-04-20 22:10:16 +0000400// Semantic interpretations of instruction operands.
Sean Callanan04cc3072009-12-19 02:59:52 +0000401#define TYPES \
402 ENUM_ENTRY(TYPE_NONE, "") \
Craig Topperfba613e2017-01-16 06:49:09 +0000403 ENUM_ENTRY(TYPE_REL, "immediate address") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000404 ENUM_ENTRY(TYPE_R8, "1-byte register operand") \
405 ENUM_ENTRY(TYPE_R16, "2-byte") \
406 ENUM_ENTRY(TYPE_R32, "4-byte") \
407 ENUM_ENTRY(TYPE_R64, "8-byte") \
Craig Topperad944a12017-01-16 06:49:03 +0000408 ENUM_ENTRY(TYPE_IMM, "immediate operand") \
Sean Callanan1efe6612010-04-07 21:42:19 +0000409 ENUM_ENTRY(TYPE_IMM3, "1-byte immediate operand between 0 and 7") \
Craig Topper7629d632012-04-03 05:20:24 +0000410 ENUM_ENTRY(TYPE_IMM5, "1-byte immediate operand between 0 and 31") \
Craig Topper7d3c6d32015-01-28 10:09:56 +0000411 ENUM_ENTRY(TYPE_AVX512ICC, "1-byte immediate operand for AVX512 icmp") \
Craig Topper620b50c2015-01-21 08:15:54 +0000412 ENUM_ENTRY(TYPE_UIMM8, "1-byte unsigned immediate operand") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000413 ENUM_ENTRY(TYPE_M, "Memory operand") \
Craig Topperca2382d2017-10-21 20:03:20 +0000414 ENUM_ENTRY(TYPE_MVSIBX, "Memory operand using XMM index") \
415 ENUM_ENTRY(TYPE_MVSIBY, "Memory operand using YMM index") \
416 ENUM_ENTRY(TYPE_MVSIBZ, "Memory operand using ZMM index") \
Craig Topperad944a12017-01-16 06:49:03 +0000417 ENUM_ENTRY(TYPE_SRCIDX, "memory at source index") \
418 ENUM_ENTRY(TYPE_DSTIDX, "memory at destination index") \
419 ENUM_ENTRY(TYPE_MOFFS, "memory offset (relative to segment base)") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000420 ENUM_ENTRY(TYPE_ST, "Position on the floating-point stack") \
Craig Topper23fa4782015-01-07 07:47:52 +0000421 ENUM_ENTRY(TYPE_MM64, "8-byte MMX register") \
Craig Topperad944a12017-01-16 06:49:03 +0000422 ENUM_ENTRY(TYPE_XMM, "16-byte") \
423 ENUM_ENTRY(TYPE_YMM, "32-byte") \
424 ENUM_ENTRY(TYPE_ZMM, "64-byte") \
425 ENUM_ENTRY(TYPE_VK, "mask register") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000426 ENUM_ENTRY(TYPE_SEGMENTREG, "Segment register operand") \
427 ENUM_ENTRY(TYPE_DEBUGREG, "Debug register operand") \
Sean Callanane7e1cf92010-05-06 20:59:00 +0000428 ENUM_ENTRY(TYPE_CONTROLREG, "Control register operand") \
Elena Demikhovsky6b62b652015-06-09 13:02:10 +0000429 ENUM_ENTRY(TYPE_BNDR, "MPX bounds register") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000430 \
Sean Callanan04cc3072009-12-19 02:59:52 +0000431 ENUM_ENTRY(TYPE_Rv, "Register operand of operand size") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000432 ENUM_ENTRY(TYPE_RELv, "Immediate address of operand size") \
433 ENUM_ENTRY(TYPE_DUP0, "Duplicate of operand 0") \
434 ENUM_ENTRY(TYPE_DUP1, "operand 1") \
435 ENUM_ENTRY(TYPE_DUP2, "operand 2") \
436 ENUM_ENTRY(TYPE_DUP3, "operand 3") \
437 ENUM_ENTRY(TYPE_DUP4, "operand 4") \
Sean Callanan04cc3072009-12-19 02:59:52 +0000438
Craig Topper5f33d902012-07-31 04:38:27 +0000439#define ENUM_ENTRY(n, d) n,
Richard Smith89ee75d2014-04-20 21:07:34 +0000440enum OperandType {
Sean Callanan04cc3072009-12-19 02:59:52 +0000441 TYPES
442 TYPE_max
Richard Smith89ee75d2014-04-20 21:07:34 +0000443};
Sean Callanan04cc3072009-12-19 02:59:52 +0000444#undef ENUM_ENTRY
445
Richard Smith6a6967e2014-04-20 22:10:16 +0000446/// \brief The specification for how to extract and interpret one operand.
Sean Callanan04cc3072009-12-19 02:59:52 +0000447struct OperandSpecifier {
Craig Topper6dedbae2012-03-04 02:16:41 +0000448 uint8_t encoding;
449 uint8_t type;
Sean Callanan04cc3072009-12-19 02:59:52 +0000450};
451
Adam Nemet4688a2e2014-08-05 17:23:01 +0000452static const unsigned X86_MAX_OPERANDS = 6;
Sean Callanan04cc3072009-12-19 02:59:52 +0000453
Richard Smith6a6967e2014-04-20 22:10:16 +0000454/// Decoding mode for the Intel disassembler. 16-bit, 32-bit, and 64-bit mode
455/// are supported, and represent real mode, IA-32e, and IA-32e in 64-bit mode,
456/// respectively.
Richard Smith89ee75d2014-04-20 21:07:34 +0000457enum DisassemblerMode {
Sean Callanan04cc3072009-12-19 02:59:52 +0000458 MODE_16BIT,
459 MODE_32BIT,
460 MODE_64BIT
Richard Smith89ee75d2014-04-20 21:07:34 +0000461};
462
463} // namespace X86Disassembler
464} // namespace llvm
Sean Callanan04cc3072009-12-19 02:59:52 +0000465
466#endif