Coverage Report

Created: 2026-08-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonenext/arch/X86/X86Disassembler.c
Line
Count
Source
1
//===-- X86Disassembler.cpp - Disassembler for x86 and x86_64 -------------===//
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 code to translate the data produced by the decoder into
12
//  MCInsts.
13
//
14
// The X86 disassembler is a table-driven disassembler for the 16-, 32-, and
15
// 64-bit X86 instruction sets.  The main decode sequence for an assembly
16
// instruction in this disassembler is:
17
//
18
// 1. Read the prefix bytes and determine the attributes of the instruction.
19
//    These attributes, recorded in enum attributeBits
20
//    (X86DisassemblerDecoderCommon.h), form a bitmask.  The table CONTEXTS_SYM
21
//    provides a mapping from bitmasks to contexts, which are represented by
22
//    enum InstructionContext (ibid.).
23
//
24
// 2. Read the opcode, and determine what kind of opcode it is.  The
25
//    disassembler distinguishes four kinds of opcodes, which are enumerated in
26
//    OpcodeType (X86DisassemblerDecoderCommon.h): one-byte (0xnn), two-byte
27
//    (0x0f 0xnn), three-byte-38 (0x0f 0x38 0xnn), or three-byte-3a
28
//    (0x0f 0x3a 0xnn).  Mandatory prefixes are treated as part of the context.
29
//
30
// 3. Depending on the opcode type, look in one of four ClassDecision structures
31
//    (X86DisassemblerDecoderCommon.h).  Use the opcode class to determine which
32
//    OpcodeDecision (ibid.) to look the opcode in.  Look up the opcode, to get
33
//    a ModRMDecision (ibid.).
34
//
35
// 4. Some instructions, such as escape opcodes or extended opcodes, or even
36
//    instructions that have ModRM*Reg / ModRM*Mem forms in LLVM, need the
37
//    ModR/M byte to complete decode.  The ModRMDecision's type is an entry from
38
//    ModRMDecisionType (X86DisassemblerDecoderCommon.h) that indicates if the
39
//    ModR/M byte is required and how to interpret it.
40
//
41
// 5. After resolving the ModRMDecision, the disassembler has a unique ID
42
//    of type InstrUID (X86DisassemblerDecoderCommon.h).  Looking this ID up in
43
//    INSTRUCTIONS_SYM yields the name of the instruction and the encodings and
44
//    meanings of its operands.
45
//
46
// 6. For each operand, its encoding is an entry from OperandEncoding
47
//    (X86DisassemblerDecoderCommon.h) and its type is an entry from
48
//    OperandType (ibid.).  The encoding indicates how to read it from the
49
//    instruction; the type indicates how to interpret the value once it has
50
//    been read.  For example, a register operand could be stored in the R/M
51
//    field of the ModR/M byte, the REG field of the ModR/M byte, or added to
52
//    the main opcode.  This is orthogonal from its meaning (an GPR or an XMM
53
//    register, for instance).  Given this information, the operands can be
54
//    extracted and interpreted.
55
//
56
// 7. As the last step, the disassembler translates the instruction information
57
//    and operands into a format understandable by the client - in this case, an
58
//    MCInst for use by the MC infrastructure.
59
//
60
// The disassembler is broken broadly into two parts: the table emitter that
61
// emits the instruction decode tables discussed above during compilation, and
62
// the disassembler itself.  The table emitter is documented in more detail in
63
// utils/TableGen/X86DisassemblerEmitter.h.
64
//
65
// X86Disassembler.cpp contains the code responsible for step 7, and for
66
//   invoking the decoder to execute steps 1-6.
67
// X86DisassemblerDecoderCommon.h contains the definitions needed by both the
68
//   table emitter and the disassembler.
69
// X86DisassemblerDecoder.h contains the public interface of the decoder,
70
//   factored out into C for possible use by other projects.
71
// X86DisassemblerDecoder.c contains the source code of the decoder, which is
72
//   responsible for steps 1-6.
73
//
74
//===----------------------------------------------------------------------===//
75
76
/* Capstone Disassembly Engine */
77
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2019 */
78
79
#ifdef CAPSTONE_HAS_X86
80
81
#ifdef _MSC_VER
82
// disable MSVC's warning on strncpy()
83
#pragma warning(disable : 4996)
84
// disable MSVC's warning on strncpy()
85
#pragma warning(disable : 28719)
86
#endif
87
88
#include <capstone/platform.h>
89
90
#if defined(CAPSTONE_HAS_OSXKERNEL)
91
#include <Availability.h>
92
#endif
93
94
#include <string.h>
95
96
#include "../../cs_priv.h"
97
98
#include "X86BaseInfo.h"
99
#include "X86Disassembler.h"
100
#include "X86DisassemblerDecoderCommon.h"
101
#include "X86DisassemblerDecoder.h"
102
#include "../../MCInst.h"
103
#include "../../utils.h"
104
#include "X86Mapping.h"
105
106
#define GET_REGINFO_ENUM
107
#define GET_REGINFO_MC_DESC
108
#include "X86GenRegisterInfo.inc"
109
110
#define GET_INSTRINFO_ENUM
111
#ifdef CAPSTONE_X86_REDUCE
112
#include "X86GenInstrInfo_reduce.inc"
113
#else
114
#include "X86GenInstrInfo.inc"
115
#endif
116
117
// Fill-ins to make the compiler happy.  These constants are never actually
118
//   assigned; they are just filler to make an automatically-generated switch
119
//   statement work.
120
enum {
121
  X86_BX_SI = 500,
122
  X86_BX_DI = 501,
123
  X86_BP_SI = 502,
124
  X86_BP_DI = 503,
125
  X86_sib = 504,
126
  X86_sib64 = 505
127
};
128
129
//
130
// Private code that translates from struct InternalInstructions to MCInsts.
131
//
132
133
/// translateRegister - Translates an internal register to the appropriate LLVM
134
///   register, and appends it as an operand to an MCInst.
135
///
136
/// @param mcInst     - The MCInst to append to.
137
/// @param reg        - The Reg to append.
138
static void translateRegister(MCInst *mcInst, Reg reg)
139
770k
{
140
171M
#define ENTRY(x) X86_##x,
141
770k
  static const uint16_t llvmRegnums[] = { ALL_REGS 0 };
142
770k
#undef ENTRY
143
144
770k
  uint16_t llvmRegnum = llvmRegnums[reg];
145
770k
  MCOperand_CreateReg0(mcInst, llvmRegnum);
146
770k
}
147
148
static const uint8_t segmentRegnums[SEG_OVERRIDE_max] = {
149
  0, // SEG_OVERRIDE_NONE
150
  X86_CS, X86_SS, X86_DS, X86_ES, X86_FS, X86_GS
151
};
152
153
/// translateSrcIndex   - Appends a source index operand to an MCInst.
154
///
155
/// @param mcInst       - The MCInst to append to.
156
/// @param insn         - The internal instruction.
157
static bool translateSrcIndex(MCInst *mcInst, InternalInstruction *insn)
158
52.0k
{
159
52.0k
  unsigned baseRegNo;
160
161
52.0k
  if (insn->mode == MODE_64BIT)
162
21.0k
    baseRegNo = insn->hasAdSize ? X86_ESI : X86_RSI;
163
31.0k
  else if (insn->mode == MODE_32BIT)
164
12.7k
    baseRegNo = insn->hasAdSize ? X86_SI : X86_ESI;
165
18.3k
  else {
166
    // assert(insn->mode == MODE_16BIT);
167
18.3k
    baseRegNo = insn->hasAdSize ? X86_ESI : X86_SI;
168
18.3k
  }
169
170
52.0k
  MCOperand_CreateReg0(mcInst, baseRegNo);
171
172
52.0k
  MCOperand_CreateReg0(mcInst, segmentRegnums[insn->segmentOverride]);
173
174
52.0k
  return false;
175
52.0k
}
176
177
/// translateDstIndex   - Appends a destination index operand to an MCInst.
178
///
179
/// @param mcInst       - The MCInst to append to.
180
/// @param insn         - The internal instruction.
181
static bool translateDstIndex(MCInst *mcInst, InternalInstruction *insn)
182
62.1k
{
183
62.1k
  unsigned baseRegNo;
184
185
62.1k
  if (insn->mode == MODE_64BIT)
186
22.4k
    baseRegNo = insn->hasAdSize ? X86_EDI : X86_RDI;
187
39.7k
  else if (insn->mode == MODE_32BIT)
188
16.3k
    baseRegNo = insn->hasAdSize ? X86_DI : X86_EDI;
189
23.3k
  else {
190
    // assert(insn->mode == MODE_16BIT);
191
23.3k
    baseRegNo = insn->hasAdSize ? X86_EDI : X86_DI;
192
23.3k
  }
193
194
62.1k
  MCOperand_CreateReg0(mcInst, baseRegNo);
195
196
62.1k
  return false;
197
62.1k
}
198
199
/// translateImmediate  - Appends an immediate operand to an MCInst.
200
///
201
/// @param mcInst       - The MCInst to append to.
202
/// @param immediate    - The immediate value to append.
203
/// @param operand      - The operand, as stored in the descriptor table.
204
/// @param insn         - The internal instruction.
205
static void translateImmediate(MCInst *mcInst, uint64_t immediate,
206
             const OperandSpecifier *operand,
207
             InternalInstruction *insn)
208
297k
{
209
297k
  OperandType type;
210
211
297k
  type = (OperandType)operand->type;
212
297k
  if (type == TYPE_REL) {
213
    //isBranch = true;
214
    //pcrel = insn->startLocation + insn->immediateOffset + insn->immediateSize;
215
68.0k
    switch (operand->encoding) {
216
0
    default:
217
0
      break;
218
4.79k
    case ENCODING_Iv:
219
4.79k
      switch (insn->displacementSize) {
220
0
      default:
221
0
        break;
222
0
      case 1:
223
0
        if (immediate & 0x80)
224
0
          immediate |= ~(0xffull);
225
0
        break;
226
2.08k
      case 2:
227
2.08k
        if (immediate & 0x8000)
228
1.38k
          immediate |= ~(0xffffull);
229
2.08k
        break;
230
2.70k
      case 4:
231
2.70k
        if (immediate & 0x80000000)
232
1.45k
          immediate |= ~(0xffffffffull);
233
2.70k
        break;
234
0
      case 8:
235
0
        break;
236
4.79k
      }
237
4.79k
      break;
238
59.9k
    case ENCODING_IB:
239
59.9k
      if (immediate & 0x80)
240
21.3k
        immediate |= ~(0xffull);
241
59.9k
      break;
242
1.35k
    case ENCODING_IW:
243
1.35k
      if (immediate & 0x8000)
244
943
        immediate |= ~(0xffffull);
245
1.35k
      break;
246
1.92k
    case ENCODING_ID:
247
1.92k
      if (immediate & 0x80000000)
248
986
        immediate |= ~(0xffffffffull);
249
1.92k
      break;
250
68.0k
    }
251
68.0k
  } // By default sign-extend all X86 immediates based on their encoding.
252
229k
  else if (type == TYPE_IMM) {
253
151k
    switch (operand->encoding) {
254
44.7k
    default:
255
44.7k
      break;
256
87.3k
    case ENCODING_IB:
257
87.3k
      if (immediate & 0x80)
258
34.8k
        immediate |= ~(0xffull);
259
87.3k
      break;
260
15.0k
    case ENCODING_IW:
261
15.0k
      if (immediate & 0x8000)
262
7.47k
        immediate |= ~(0xffffull);
263
15.0k
      break;
264
3.61k
    case ENCODING_ID:
265
3.61k
      if (immediate & 0x80000000)
266
1.27k
        immediate |= ~(0xffffffffull);
267
3.61k
      break;
268
688
    case ENCODING_IO:
269
688
      break;
270
151k
    }
271
151k
  } else if (type == TYPE_IMM3) {
272
10.4k
#ifndef CAPSTONE_X86_REDUCE
273
    // Check for immediates that printSSECC can't handle.
274
10.4k
    if (immediate >= 8) {
275
6.25k
      unsigned NewOpc = 0;
276
277
6.25k
      switch (MCInst_getOpcode(mcInst)) {
278
0
      default:
279
0
        break; // never reach
280
328
      case X86_CMPPDrmi:
281
328
        NewOpc = X86_CMPPDrmi_alt;
282
328
        break;
283
388
      case X86_CMPPDrri:
284
388
        NewOpc = X86_CMPPDrri_alt;
285
388
        break;
286
615
      case X86_CMPPSrmi:
287
615
        NewOpc = X86_CMPPSrmi_alt;
288
615
        break;
289
753
      case X86_CMPPSrri:
290
753
        NewOpc = X86_CMPPSrri_alt;
291
753
        break;
292
221
      case X86_CMPSDrm:
293
221
        NewOpc = X86_CMPSDrm_alt;
294
221
        break;
295
273
      case X86_CMPSDrr:
296
273
        NewOpc = X86_CMPSDrr_alt;
297
273
        break;
298
442
      case X86_CMPSSrm:
299
442
        NewOpc = X86_CMPSSrm_alt;
300
442
        break;
301
138
      case X86_CMPSSrr:
302
138
        NewOpc = X86_CMPSSrr_alt;
303
138
        break;
304
169
      case X86_VPCOMBri:
305
169
        NewOpc = X86_VPCOMBri_alt;
306
169
        break;
307
117
      case X86_VPCOMBmi:
308
117
        NewOpc = X86_VPCOMBmi_alt;
309
117
        break;
310
113
      case X86_VPCOMWri:
311
113
        NewOpc = X86_VPCOMWri_alt;
312
113
        break;
313
436
      case X86_VPCOMWmi:
314
436
        NewOpc = X86_VPCOMWmi_alt;
315
436
        break;
316
76
      case X86_VPCOMDri:
317
76
        NewOpc = X86_VPCOMDri_alt;
318
76
        break;
319
186
      case X86_VPCOMDmi:
320
186
        NewOpc = X86_VPCOMDmi_alt;
321
186
        break;
322
203
      case X86_VPCOMQri:
323
203
        NewOpc = X86_VPCOMQri_alt;
324
203
        break;
325
44
      case X86_VPCOMQmi:
326
44
        NewOpc = X86_VPCOMQmi_alt;
327
44
        break;
328
314
      case X86_VPCOMUBri:
329
314
        NewOpc = X86_VPCOMUBri_alt;
330
314
        break;
331
148
      case X86_VPCOMUBmi:
332
148
        NewOpc = X86_VPCOMUBmi_alt;
333
148
        break;
334
401
      case X86_VPCOMUWri:
335
401
        NewOpc = X86_VPCOMUWri_alt;
336
401
        break;
337
132
      case X86_VPCOMUWmi:
338
132
        NewOpc = X86_VPCOMUWmi_alt;
339
132
        break;
340
265
      case X86_VPCOMUDri:
341
265
        NewOpc = X86_VPCOMUDri_alt;
342
265
        break;
343
93
      case X86_VPCOMUDmi:
344
93
        NewOpc = X86_VPCOMUDmi_alt;
345
93
        break;
346
83
      case X86_VPCOMUQri:
347
83
        NewOpc = X86_VPCOMUQri_alt;
348
83
        break;
349
320
      case X86_VPCOMUQmi:
350
320
        NewOpc = X86_VPCOMUQmi_alt;
351
320
        break;
352
6.25k
      }
353
354
      // Switch opcode to the one that doesn't get special printing.
355
6.25k
      if (NewOpc != 0) {
356
6.25k
        MCInst_setOpcode(mcInst, NewOpc);
357
6.25k
      }
358
6.25k
    }
359
10.4k
#endif
360
67.8k
  } else if (type == TYPE_IMM5) {
361
14.4k
#ifndef CAPSTONE_X86_REDUCE
362
    // Check for immediates that printAVXCC can't handle.
363
14.4k
    if (immediate >= 32) {
364
11.3k
      unsigned NewOpc = 0;
365
366
11.3k
      switch (MCInst_getOpcode(mcInst)) {
367
3.56k
      default:
368
3.56k
        break; // unexpected opcode
369
3.56k
      case X86_VCMPPDrmi:
370
297
        NewOpc = X86_VCMPPDrmi_alt;
371
297
        break;
372
161
      case X86_VCMPPDrri:
373
161
        NewOpc = X86_VCMPPDrri_alt;
374
161
        break;
375
88
      case X86_VCMPPSrmi:
376
88
        NewOpc = X86_VCMPPSrmi_alt;
377
88
        break;
378
97
      case X86_VCMPPSrri:
379
97
        NewOpc = X86_VCMPPSrri_alt;
380
97
        break;
381
695
      case X86_VCMPSDrm:
382
695
        NewOpc = X86_VCMPSDrm_alt;
383
695
        break;
384
274
      case X86_VCMPSDrr:
385
274
        NewOpc = X86_VCMPSDrr_alt;
386
274
        break;
387
435
      case X86_VCMPSSrm:
388
435
        NewOpc = X86_VCMPSSrm_alt;
389
435
        break;
390
338
      case X86_VCMPSSrr:
391
338
        NewOpc = X86_VCMPSSrr_alt;
392
338
        break;
393
69
      case X86_VCMPPDYrmi:
394
69
        NewOpc = X86_VCMPPDYrmi_alt;
395
69
        break;
396
562
      case X86_VCMPPDYrri:
397
562
        NewOpc = X86_VCMPPDYrri_alt;
398
562
        break;
399
281
      case X86_VCMPPSYrmi:
400
281
        NewOpc = X86_VCMPPSYrmi_alt;
401
281
        break;
402
308
      case X86_VCMPPSYrri:
403
308
        NewOpc = X86_VCMPPSYrri_alt;
404
308
        break;
405
115
      case X86_VCMPPDZrmi:
406
115
        NewOpc = X86_VCMPPDZrmi_alt;
407
115
        break;
408
105
      case X86_VCMPPDZrri:
409
105
        NewOpc = X86_VCMPPDZrri_alt;
410
105
        break;
411
506
      case X86_VCMPPDZrrib:
412
506
        NewOpc = X86_VCMPPDZrrib_alt;
413
506
        break;
414
948
      case X86_VCMPPSZrmi:
415
948
        NewOpc = X86_VCMPPSZrmi_alt;
416
948
        break;
417
171
      case X86_VCMPPSZrri:
418
171
        NewOpc = X86_VCMPPSZrri_alt;
419
171
        break;
420
43
      case X86_VCMPPSZrrib:
421
43
        NewOpc = X86_VCMPPSZrrib_alt;
422
43
        break;
423
94
      case X86_VCMPPDZ128rmi:
424
94
        NewOpc = X86_VCMPPDZ128rmi_alt;
425
94
        break;
426
17
      case X86_VCMPPDZ128rri:
427
17
        NewOpc = X86_VCMPPDZ128rri_alt;
428
17
        break;
429
88
      case X86_VCMPPSZ128rmi:
430
88
        NewOpc = X86_VCMPPSZ128rmi_alt;
431
88
        break;
432
85
      case X86_VCMPPSZ128rri:
433
85
        NewOpc = X86_VCMPPSZ128rri_alt;
434
85
        break;
435
44
      case X86_VCMPPDZ256rmi:
436
44
        NewOpc = X86_VCMPPDZ256rmi_alt;
437
44
        break;
438
176
      case X86_VCMPPDZ256rri:
439
176
        NewOpc = X86_VCMPPDZ256rri_alt;
440
176
        break;
441
444
      case X86_VCMPPSZ256rmi:
442
444
        NewOpc = X86_VCMPPSZ256rmi_alt;
443
444
        break;
444
618
      case X86_VCMPPSZ256rri:
445
618
        NewOpc = X86_VCMPPSZ256rri_alt;
446
618
        break;
447
110
      case X86_VCMPSDZrm_Int:
448
110
        NewOpc = X86_VCMPSDZrmi_alt;
449
110
        break;
450
64
      case X86_VCMPSDZrr_Int:
451
64
        NewOpc = X86_VCMPSDZrri_alt;
452
64
        break;
453
68
      case X86_VCMPSDZrrb_Int:
454
68
        NewOpc = X86_VCMPSDZrrb_alt;
455
68
        break;
456
110
      case X86_VCMPSSZrm_Int:
457
110
        NewOpc = X86_VCMPSSZrmi_alt;
458
110
        break;
459
110
      case X86_VCMPSSZrr_Int:
460
110
        NewOpc = X86_VCMPSSZrri_alt;
461
110
        break;
462
212
      case X86_VCMPSSZrrb_Int:
463
212
        NewOpc = X86_VCMPSSZrrb_alt;
464
212
        break;
465
11.3k
      }
466
467
      // Switch opcode to the one that doesn't get special printing.
468
11.3k
      if (NewOpc != 0) {
469
7.73k
        MCInst_setOpcode(mcInst, NewOpc);
470
7.73k
      }
471
11.3k
    }
472
14.4k
#endif
473
53.4k
  } else if (type == TYPE_AVX512ICC) {
474
9.65k
#ifndef CAPSTONE_X86_REDUCE
475
9.65k
    if (immediate >= 8 || ((immediate & 0x3) == 3)) {
476
7.63k
      unsigned NewOpc = 0;
477
7.63k
      switch (MCInst_getOpcode(mcInst)) {
478
0
      default: // llvm_unreachable("unexpected opcode");
479
126
      case X86_VPCMPBZ128rmi:
480
126
        NewOpc = X86_VPCMPBZ128rmi_alt;
481
126
        break;
482
142
      case X86_VPCMPBZ128rmik:
483
142
        NewOpc = X86_VPCMPBZ128rmik_alt;
484
142
        break;
485
22
      case X86_VPCMPBZ128rri:
486
22
        NewOpc = X86_VPCMPBZ128rri_alt;
487
22
        break;
488
24
      case X86_VPCMPBZ128rrik:
489
24
        NewOpc = X86_VPCMPBZ128rrik_alt;
490
24
        break;
491
36
      case X86_VPCMPBZ256rmi:
492
36
        NewOpc = X86_VPCMPBZ256rmi_alt;
493
36
        break;
494
9
      case X86_VPCMPBZ256rmik:
495
9
        NewOpc = X86_VPCMPBZ256rmik_alt;
496
9
        break;
497
36
      case X86_VPCMPBZ256rri:
498
36
        NewOpc = X86_VPCMPBZ256rri_alt;
499
36
        break;
500
96
      case X86_VPCMPBZ256rrik:
501
96
        NewOpc = X86_VPCMPBZ256rrik_alt;
502
96
        break;
503
326
      case X86_VPCMPBZrmi:
504
326
        NewOpc = X86_VPCMPBZrmi_alt;
505
326
        break;
506
70
      case X86_VPCMPBZrmik:
507
70
        NewOpc = X86_VPCMPBZrmik_alt;
508
70
        break;
509
166
      case X86_VPCMPBZrri:
510
166
        NewOpc = X86_VPCMPBZrri_alt;
511
166
        break;
512
38
      case X86_VPCMPBZrrik:
513
38
        NewOpc = X86_VPCMPBZrrik_alt;
514
38
        break;
515
6
      case X86_VPCMPDZ128rmi:
516
6
        NewOpc = X86_VPCMPDZ128rmi_alt;
517
6
        break;
518
13
      case X86_VPCMPDZ128rmib:
519
13
        NewOpc = X86_VPCMPDZ128rmib_alt;
520
13
        break;
521
18
      case X86_VPCMPDZ128rmibk:
522
18
        NewOpc = X86_VPCMPDZ128rmibk_alt;
523
18
        break;
524
44
      case X86_VPCMPDZ128rmik:
525
44
        NewOpc = X86_VPCMPDZ128rmik_alt;
526
44
        break;
527
7
      case X86_VPCMPDZ128rri:
528
7
        NewOpc = X86_VPCMPDZ128rri_alt;
529
7
        break;
530
10
      case X86_VPCMPDZ128rrik:
531
10
        NewOpc = X86_VPCMPDZ128rrik_alt;
532
10
        break;
533
12
      case X86_VPCMPDZ256rmi:
534
12
        NewOpc = X86_VPCMPDZ256rmi_alt;
535
12
        break;
536
101
      case X86_VPCMPDZ256rmib:
537
101
        NewOpc = X86_VPCMPDZ256rmib_alt;
538
101
        break;
539
17
      case X86_VPCMPDZ256rmibk:
540
17
        NewOpc = X86_VPCMPDZ256rmibk_alt;
541
17
        break;
542
41
      case X86_VPCMPDZ256rmik:
543
41
        NewOpc = X86_VPCMPDZ256rmik_alt;
544
41
        break;
545
66
      case X86_VPCMPDZ256rri:
546
66
        NewOpc = X86_VPCMPDZ256rri_alt;
547
66
        break;
548
331
      case X86_VPCMPDZ256rrik:
549
331
        NewOpc = X86_VPCMPDZ256rrik_alt;
550
331
        break;
551
79
      case X86_VPCMPDZrmi:
552
79
        NewOpc = X86_VPCMPDZrmi_alt;
553
79
        break;
554
80
      case X86_VPCMPDZrmib:
555
80
        NewOpc = X86_VPCMPDZrmib_alt;
556
80
        break;
557
53
      case X86_VPCMPDZrmibk:
558
53
        NewOpc = X86_VPCMPDZrmibk_alt;
559
53
        break;
560
60
      case X86_VPCMPDZrmik:
561
60
        NewOpc = X86_VPCMPDZrmik_alt;
562
60
        break;
563
36
      case X86_VPCMPDZrri:
564
36
        NewOpc = X86_VPCMPDZrri_alt;
565
36
        break;
566
8
      case X86_VPCMPDZrrik:
567
8
        NewOpc = X86_VPCMPDZrrik_alt;
568
8
        break;
569
3
      case X86_VPCMPQZ128rmi:
570
3
        NewOpc = X86_VPCMPQZ128rmi_alt;
571
3
        break;
572
15
      case X86_VPCMPQZ128rmib:
573
15
        NewOpc = X86_VPCMPQZ128rmib_alt;
574
15
        break;
575
61
      case X86_VPCMPQZ128rmibk:
576
61
        NewOpc = X86_VPCMPQZ128rmibk_alt;
577
61
        break;
578
40
      case X86_VPCMPQZ128rmik:
579
40
        NewOpc = X86_VPCMPQZ128rmik_alt;
580
40
        break;
581
14
      case X86_VPCMPQZ128rri:
582
14
        NewOpc = X86_VPCMPQZ128rri_alt;
583
14
        break;
584
16
      case X86_VPCMPQZ128rrik:
585
16
        NewOpc = X86_VPCMPQZ128rrik_alt;
586
16
        break;
587
71
      case X86_VPCMPQZ256rmi:
588
71
        NewOpc = X86_VPCMPQZ256rmi_alt;
589
71
        break;
590
17
      case X86_VPCMPQZ256rmib:
591
17
        NewOpc = X86_VPCMPQZ256rmib_alt;
592
17
        break;
593
53
      case X86_VPCMPQZ256rmibk:
594
53
        NewOpc = X86_VPCMPQZ256rmibk_alt;
595
53
        break;
596
51
      case X86_VPCMPQZ256rmik:
597
51
        NewOpc = X86_VPCMPQZ256rmik_alt;
598
51
        break;
599
8
      case X86_VPCMPQZ256rri:
600
8
        NewOpc = X86_VPCMPQZ256rri_alt;
601
8
        break;
602
14
      case X86_VPCMPQZ256rrik:
603
14
        NewOpc = X86_VPCMPQZ256rrik_alt;
604
14
        break;
605
7
      case X86_VPCMPQZrmi:
606
7
        NewOpc = X86_VPCMPQZrmi_alt;
607
7
        break;
608
15
      case X86_VPCMPQZrmib:
609
15
        NewOpc = X86_VPCMPQZrmib_alt;
610
15
        break;
611
209
      case X86_VPCMPQZrmibk:
612
209
        NewOpc = X86_VPCMPQZrmibk_alt;
613
209
        break;
614
71
      case X86_VPCMPQZrmik:
615
71
        NewOpc = X86_VPCMPQZrmik_alt;
616
71
        break;
617
24
      case X86_VPCMPQZrri:
618
24
        NewOpc = X86_VPCMPQZrri_alt;
619
24
        break;
620
196
      case X86_VPCMPQZrrik:
621
196
        NewOpc = X86_VPCMPQZrrik_alt;
622
196
        break;
623
11
      case X86_VPCMPUBZ128rmi:
624
11
        NewOpc = X86_VPCMPUBZ128rmi_alt;
625
11
        break;
626
5
      case X86_VPCMPUBZ128rmik:
627
5
        NewOpc = X86_VPCMPUBZ128rmik_alt;
628
5
        break;
629
24
      case X86_VPCMPUBZ128rri:
630
24
        NewOpc = X86_VPCMPUBZ128rri_alt;
631
24
        break;
632
30
      case X86_VPCMPUBZ128rrik:
633
30
        NewOpc = X86_VPCMPUBZ128rrik_alt;
634
30
        break;
635
4
      case X86_VPCMPUBZ256rmi:
636
4
        NewOpc = X86_VPCMPUBZ256rmi_alt;
637
4
        break;
638
60
      case X86_VPCMPUBZ256rmik:
639
60
        NewOpc = X86_VPCMPUBZ256rmik_alt;
640
60
        break;
641
45
      case X86_VPCMPUBZ256rri:
642
45
        NewOpc = X86_VPCMPUBZ256rri_alt;
643
45
        break;
644
63
      case X86_VPCMPUBZ256rrik:
645
63
        NewOpc = X86_VPCMPUBZ256rrik_alt;
646
63
        break;
647
41
      case X86_VPCMPUBZrmi:
648
41
        NewOpc = X86_VPCMPUBZrmi_alt;
649
41
        break;
650
34
      case X86_VPCMPUBZrmik:
651
34
        NewOpc = X86_VPCMPUBZrmik_alt;
652
34
        break;
653
61
      case X86_VPCMPUBZrri:
654
61
        NewOpc = X86_VPCMPUBZrri_alt;
655
61
        break;
656
63
      case X86_VPCMPUBZrrik:
657
63
        NewOpc = X86_VPCMPUBZrrik_alt;
658
63
        break;
659
52
      case X86_VPCMPUDZ128rmi:
660
52
        NewOpc = X86_VPCMPUDZ128rmi_alt;
661
52
        break;
662
8
      case X86_VPCMPUDZ128rmib:
663
8
        NewOpc = X86_VPCMPUDZ128rmib_alt;
664
8
        break;
665
26
      case X86_VPCMPUDZ128rmibk:
666
26
        NewOpc = X86_VPCMPUDZ128rmibk_alt;
667
26
        break;
668
40
      case X86_VPCMPUDZ128rmik:
669
40
        NewOpc = X86_VPCMPUDZ128rmik_alt;
670
40
        break;
671
6
      case X86_VPCMPUDZ128rri:
672
6
        NewOpc = X86_VPCMPUDZ128rri_alt;
673
6
        break;
674
1
      case X86_VPCMPUDZ128rrik:
675
1
        NewOpc = X86_VPCMPUDZ128rrik_alt;
676
1
        break;
677
5
      case X86_VPCMPUDZ256rmi:
678
5
        NewOpc = X86_VPCMPUDZ256rmi_alt;
679
5
        break;
680
21
      case X86_VPCMPUDZ256rmib:
681
21
        NewOpc = X86_VPCMPUDZ256rmib_alt;
682
21
        break;
683
31
      case X86_VPCMPUDZ256rmibk:
684
31
        NewOpc = X86_VPCMPUDZ256rmibk_alt;
685
31
        break;
686
54
      case X86_VPCMPUDZ256rmik:
687
54
        NewOpc = X86_VPCMPUDZ256rmik_alt;
688
54
        break;
689
70
      case X86_VPCMPUDZ256rri:
690
70
        NewOpc = X86_VPCMPUDZ256rri_alt;
691
70
        break;
692
90
      case X86_VPCMPUDZ256rrik:
693
90
        NewOpc = X86_VPCMPUDZ256rrik_alt;
694
90
        break;
695
20
      case X86_VPCMPUDZrmi:
696
20
        NewOpc = X86_VPCMPUDZrmi_alt;
697
20
        break;
698
19
      case X86_VPCMPUDZrmib:
699
19
        NewOpc = X86_VPCMPUDZrmib_alt;
700
19
        break;
701
72
      case X86_VPCMPUDZrmibk:
702
72
        NewOpc = X86_VPCMPUDZrmibk_alt;
703
72
        break;
704
8
      case X86_VPCMPUDZrmik:
705
8
        NewOpc = X86_VPCMPUDZrmik_alt;
706
8
        break;
707
53
      case X86_VPCMPUDZrri:
708
53
        NewOpc = X86_VPCMPUDZrri_alt;
709
53
        break;
710
101
      case X86_VPCMPUDZrrik:
711
101
        NewOpc = X86_VPCMPUDZrrik_alt;
712
101
        break;
713
5
      case X86_VPCMPUQZ128rmi:
714
5
        NewOpc = X86_VPCMPUQZ128rmi_alt;
715
5
        break;
716
63
      case X86_VPCMPUQZ128rmib:
717
63
        NewOpc = X86_VPCMPUQZ128rmib_alt;
718
63
        break;
719
198
      case X86_VPCMPUQZ128rmibk:
720
198
        NewOpc = X86_VPCMPUQZ128rmibk_alt;
721
198
        break;
722
17
      case X86_VPCMPUQZ128rmik:
723
17
        NewOpc = X86_VPCMPUQZ128rmik_alt;
724
17
        break;
725
36
      case X86_VPCMPUQZ128rri:
726
36
        NewOpc = X86_VPCMPUQZ128rri_alt;
727
36
        break;
728
9
      case X86_VPCMPUQZ128rrik:
729
9
        NewOpc = X86_VPCMPUQZ128rrik_alt;
730
9
        break;
731
11
      case X86_VPCMPUQZ256rmi:
732
11
        NewOpc = X86_VPCMPUQZ256rmi_alt;
733
11
        break;
734
680
      case X86_VPCMPUQZ256rmib:
735
680
        NewOpc = X86_VPCMPUQZ256rmib_alt;
736
680
        break;
737
290
      case X86_VPCMPUQZ256rmibk:
738
290
        NewOpc = X86_VPCMPUQZ256rmibk_alt;
739
290
        break;
740
39
      case X86_VPCMPUQZ256rmik:
741
39
        NewOpc = X86_VPCMPUQZ256rmik_alt;
742
39
        break;
743
14
      case X86_VPCMPUQZ256rri:
744
14
        NewOpc = X86_VPCMPUQZ256rri_alt;
745
14
        break;
746
30
      case X86_VPCMPUQZ256rrik:
747
30
        NewOpc = X86_VPCMPUQZ256rrik_alt;
748
30
        break;
749
68
      case X86_VPCMPUQZrmi:
750
68
        NewOpc = X86_VPCMPUQZrmi_alt;
751
68
        break;
752
68
      case X86_VPCMPUQZrmib:
753
68
        NewOpc = X86_VPCMPUQZrmib_alt;
754
68
        break;
755
8
      case X86_VPCMPUQZrmibk:
756
8
        NewOpc = X86_VPCMPUQZrmibk_alt;
757
8
        break;
758
35
      case X86_VPCMPUQZrmik:
759
35
        NewOpc = X86_VPCMPUQZrmik_alt;
760
35
        break;
761
55
      case X86_VPCMPUQZrri:
762
55
        NewOpc = X86_VPCMPUQZrri_alt;
763
55
        break;
764
30
      case X86_VPCMPUQZrrik:
765
30
        NewOpc = X86_VPCMPUQZrrik_alt;
766
30
        break;
767
8
      case X86_VPCMPUWZ128rmi:
768
8
        NewOpc = X86_VPCMPUWZ128rmi_alt;
769
8
        break;
770
7
      case X86_VPCMPUWZ128rmik:
771
7
        NewOpc = X86_VPCMPUWZ128rmik_alt;
772
7
        break;
773
18
      case X86_VPCMPUWZ128rri:
774
18
        NewOpc = X86_VPCMPUWZ128rri_alt;
775
18
        break;
776
25
      case X86_VPCMPUWZ128rrik:
777
25
        NewOpc = X86_VPCMPUWZ128rrik_alt;
778
25
        break;
779
2
      case X86_VPCMPUWZ256rmi:
780
2
        NewOpc = X86_VPCMPUWZ256rmi_alt;
781
2
        break;
782
20
      case X86_VPCMPUWZ256rmik:
783
20
        NewOpc = X86_VPCMPUWZ256rmik_alt;
784
20
        break;
785
1
      case X86_VPCMPUWZ256rri:
786
1
        NewOpc = X86_VPCMPUWZ256rri_alt;
787
1
        break;
788
32
      case X86_VPCMPUWZ256rrik:
789
32
        NewOpc = X86_VPCMPUWZ256rrik_alt;
790
32
        break;
791
24
      case X86_VPCMPUWZrmi:
792
24
        NewOpc = X86_VPCMPUWZrmi_alt;
793
24
        break;
794
19
      case X86_VPCMPUWZrmik:
795
19
        NewOpc = X86_VPCMPUWZrmik_alt;
796
19
        break;
797
136
      case X86_VPCMPUWZrri:
798
136
        NewOpc = X86_VPCMPUWZrri_alt;
799
136
        break;
800
56
      case X86_VPCMPUWZrrik:
801
56
        NewOpc = X86_VPCMPUWZrrik_alt;
802
56
        break;
803
15
      case X86_VPCMPWZ128rmi:
804
15
        NewOpc = X86_VPCMPWZ128rmi_alt;
805
15
        break;
806
334
      case X86_VPCMPWZ128rmik:
807
334
        NewOpc = X86_VPCMPWZ128rmik_alt;
808
334
        break;
809
5
      case X86_VPCMPWZ128rri:
810
5
        NewOpc = X86_VPCMPWZ128rri_alt;
811
5
        break;
812
12
      case X86_VPCMPWZ128rrik:
813
12
        NewOpc = X86_VPCMPWZ128rrik_alt;
814
12
        break;
815
29
      case X86_VPCMPWZ256rmi:
816
29
        NewOpc = X86_VPCMPWZ256rmi_alt;
817
29
        break;
818
88
      case X86_VPCMPWZ256rmik:
819
88
        NewOpc = X86_VPCMPWZ256rmik_alt;
820
88
        break;
821
355
      case X86_VPCMPWZ256rri:
822
355
        NewOpc = X86_VPCMPWZ256rri_alt;
823
355
        break;
824
249
      case X86_VPCMPWZ256rrik:
825
249
        NewOpc = X86_VPCMPWZ256rrik_alt;
826
249
        break;
827
9
      case X86_VPCMPWZrmi:
828
9
        NewOpc = X86_VPCMPWZrmi_alt;
829
9
        break;
830
15
      case X86_VPCMPWZrmik:
831
15
        NewOpc = X86_VPCMPWZrmik_alt;
832
15
        break;
833
447
      case X86_VPCMPWZrri:
834
447
        NewOpc = X86_VPCMPWZrri_alt;
835
447
        break;
836
1
      case X86_VPCMPWZrrik:
837
1
        NewOpc = X86_VPCMPWZrrik_alt;
838
1
        break;
839
7.63k
      }
840
841
      // Switch opcode to the one that doesn't get special printing.
842
7.63k
      if (NewOpc != 0) {
843
7.63k
        MCInst_setOpcode(mcInst, NewOpc);
844
7.63k
      }
845
7.63k
    }
846
9.65k
#endif
847
9.65k
  }
848
849
297k
  switch (type) {
850
408
  case TYPE_XMM:
851
408
    MCOperand_CreateReg0(mcInst,
852
408
             X86_XMM0 + ((uint32_t)immediate >> 4));
853
408
    return;
854
785
  case TYPE_YMM:
855
785
    MCOperand_CreateReg0(mcInst,
856
785
             X86_YMM0 + ((uint32_t)immediate >> 4));
857
785
    return;
858
0
  case TYPE_ZMM:
859
0
    MCOperand_CreateReg0(mcInst,
860
0
             X86_ZMM0 + ((uint32_t)immediate >> 4));
861
0
    return;
862
296k
  default:
863
    // operand is 64 bits wide.  Do nothing.
864
296k
    break;
865
297k
  }
866
867
296k
  MCOperand_CreateImm0(mcInst, immediate);
868
869
296k
  if (type == TYPE_MOFFS) {
870
9.94k
    MCOperand_CreateReg0(mcInst,
871
9.94k
             segmentRegnums[insn->segmentOverride]);
872
9.94k
  }
873
296k
}
874
875
/// translateRMRegister - Translates a register stored in the R/M field of the
876
///   ModR/M byte to its LLVM equivalent and appends it to an MCInst.
877
/// @param mcInst       - The MCInst to append to.
878
/// @param insn         - The internal instruction to extract the R/M field
879
///                       from.
880
/// @return             - 0 on success; -1 otherwise
881
static bool translateRMRegister(MCInst *mcInst, InternalInstruction *insn)
882
206k
{
883
206k
  if (insn->eaBase == EA_BASE_sib || insn->eaBase == EA_BASE_sib64) {
884
    //debug("A R/M register operand may not have a SIB byte");
885
0
    return true;
886
0
  }
887
888
206k
  switch (insn->eaBase) {
889
0
  case EA_BASE_NONE:
890
    //debug("EA_BASE_NONE for ModR/M base");
891
0
    return true;
892
0
#define ENTRY(x) case EA_BASE_##x:
893
0
    ALL_EA_BASES
894
0
#undef ENTRY
895
    //debug("A R/M register operand may not have a base; "
896
    //      "the operand must be a register.");
897
0
    return true;
898
0
#define ENTRY(x) \
899
206k
  case EA_REG_##x: \
900
206k
    MCOperand_CreateReg0(mcInst, X86_##x); \
901
206k
    break;
902
0
    ALL_REGS
903
0
#undef ENTRY
904
0
  default:
905
    //debug("Unexpected EA base register");
906
0
    return true;
907
206k
  }
908
909
206k
  return false;
910
206k
}
911
912
/// translateRMMemory - Translates a memory operand stored in the Mod and R/M
913
///   fields of an internal instruction (and possibly its SIB byte) to a memory
914
///   operand in LLVM's format, and appends it to an MCInst.
915
///
916
/// @param mcInst       - The MCInst to append to.
917
/// @param insn         - The instruction to extract Mod, R/M, and SIB fields
918
///                       from.
919
/// @return             - 0 on success; nonzero otherwise
920
static bool translateRMMemory(MCInst *mcInst, InternalInstruction *insn)
921
436k
{
922
  // Addresses in an MCInst are represented as five operands:
923
  //   1. basereg       (register)  The R/M base, or (if there is a SIB) the
924
  //                                SIB base
925
  //   2. scaleamount   (immediate) 1, or (if there is a SIB) the specified
926
  //                                scale amount
927
  //   3. indexreg      (register)  x86_registerNONE, or (if there is a SIB)
928
  //                                the index (which is multiplied by the
929
  //                                scale amount)
930
  //   4. displacement  (immediate) 0, or the displacement if there is one
931
  //   5. segmentreg    (register)  x86_registerNONE for now, but could be set
932
  //                                if we have segment overrides
933
436k
  int scaleAmount, indexReg;
934
935
436k
  if (insn->eaBase == EA_BASE_sib || insn->eaBase == EA_BASE_sib64) {
936
25.7k
    if (insn->sibBase != SIB_BASE_NONE) {
937
24.2k
      switch (insn->sibBase) {
938
0
#define ENTRY(x) \
939
24.2k
  case SIB_BASE_##x: \
940
24.2k
    MCOperand_CreateReg0(mcInst, X86_##x); \
941
24.2k
    break;
942
0
        ALL_SIB_BASES
943
0
#undef ENTRY
944
0
      default:
945
        //debug("Unexpected sibBase");
946
0
        return true;
947
24.2k
      }
948
24.2k
    } else {
949
1.54k
      MCOperand_CreateReg0(mcInst, 0);
950
1.54k
    }
951
952
25.7k
    if (insn->sibIndex != SIB_INDEX_NONE) {
953
20.7k
      switch (insn->sibIndex) {
954
0
      default:
955
        //debug("Unexpected sibIndex");
956
0
        return true;
957
0
#define ENTRY(x) \
958
20.7k
  case SIB_INDEX_##x: \
959
20.7k
    indexReg = X86_##x; \
960
20.7k
    break;
961
0
        EA_BASES_32BIT
962
33
        EA_BASES_64BIT
963
251
        REGS_XMM
964
31
        REGS_YMM
965
20.7k
        REGS_ZMM
966
20.7k
#undef ENTRY
967
20.7k
      }
968
20.7k
    } else {
969
      // Use EIZ/RIZ for a few ambiguous cases where the SIB byte is present,
970
      // but no index is used and modrm alone should have been enough.
971
      // -No base register in 32-bit mode. In 64-bit mode this is used to
972
      //  avoid rip-relative addressing.
973
      // -Any base register used other than ESP/RSP/R12D/R12. Using these as a
974
      //  base always requires a SIB byte.
975
      // -A scale other than 1 is used.
976
4.98k
      if (insn->sibScale != 1 ||
977
2.70k
          (insn->sibBase == SIB_BASE_NONE &&
978
339
           insn->mode != MODE_64BIT) ||
979
2.45k
          (insn->sibBase != SIB_BASE_NONE &&
980
2.36k
           insn->sibBase != SIB_BASE_ESP &&
981
1.97k
           insn->sibBase != SIB_BASE_RSP &&
982
1.59k
           insn->sibBase != SIB_BASE_R12D &&
983
3.32k
           insn->sibBase != SIB_BASE_R12)) {
984
3.32k
        indexReg = insn->addressSize == 4 ? X86_EIZ :
985
3.32k
                    X86_RIZ;
986
3.32k
      } else
987
1.65k
        indexReg = 0;
988
4.98k
    }
989
990
25.7k
    scaleAmount = insn->sibScale;
991
410k
  } else {
992
410k
    switch (insn->eaBase) {
993
9.84k
    case EA_BASE_NONE:
994
9.84k
      if (insn->eaDisplacement == EA_DISP_NONE) {
995
        //debug("EA_BASE_NONE and EA_DISP_NONE for ModR/M base");
996
0
        return true;
997
0
      }
998
9.84k
      if (insn->mode == MODE_64BIT) {
999
2.64k
        if (insn->prefix3 ==
1000
2.64k
            0x67) // address-size prefix overrides RIP relative addressing
1001
205
          MCOperand_CreateReg0(mcInst, X86_EIP);
1002
2.43k
        else
1003
          // Section 2.2.1.6
1004
2.43k
          MCOperand_CreateReg0(
1005
2.43k
            mcInst, insn->addressSize == 4 ?
1006
0
                X86_EIP :
1007
2.43k
                X86_RIP);
1008
7.19k
      } else {
1009
7.19k
        MCOperand_CreateReg0(mcInst, 0);
1010
7.19k
      }
1011
1012
9.84k
      indexReg = 0;
1013
9.84k
      break;
1014
52.8k
    case EA_BASE_BX_SI:
1015
52.8k
      MCOperand_CreateReg0(mcInst, X86_BX);
1016
52.8k
      indexReg = X86_SI;
1017
52.8k
      break;
1018
17.2k
    case EA_BASE_BX_DI:
1019
17.2k
      MCOperand_CreateReg0(mcInst, X86_BX);
1020
17.2k
      indexReg = X86_DI;
1021
17.2k
      break;
1022
13.7k
    case EA_BASE_BP_SI:
1023
13.7k
      MCOperand_CreateReg0(mcInst, X86_BP);
1024
13.7k
      indexReg = X86_SI;
1025
13.7k
      break;
1026
14.6k
    case EA_BASE_BP_DI:
1027
14.6k
      MCOperand_CreateReg0(mcInst, X86_BP);
1028
14.6k
      indexReg = X86_DI;
1029
14.6k
      break;
1030
301k
    default:
1031
301k
      indexReg = 0;
1032
301k
      switch (insn->eaBase) {
1033
0
      default:
1034
        //debug("Unexpected eaBase");
1035
0
        return true;
1036
        // Here, we will use the fill-ins defined above.  However,
1037
        //   BX_SI, BX_DI, BP_SI, and BP_DI are all handled above and
1038
        //   sib and sib64 were handled in the top-level if, so they're only
1039
        //   placeholders to keep the compiler happy.
1040
0
#define ENTRY(x) \
1041
301k
  case EA_BASE_##x: \
1042
301k
    MCOperand_CreateReg0(mcInst, X86_##x); \
1043
301k
    break;
1044
0
        ALL_EA_BASES
1045
0
#undef ENTRY
1046
5.52k
#define ENTRY(x) case EA_REG_##x:
1047
1.84k
        ALL_REGS
1048
0
#undef ENTRY
1049
        //debug("A R/M memory operand may not be a register; "
1050
        //      "the base field must be a base.");
1051
0
        return true;
1052
301k
      }
1053
410k
    }
1054
1055
410k
    scaleAmount = 1;
1056
410k
  }
1057
1058
436k
  MCOperand_CreateImm0(mcInst, scaleAmount);
1059
436k
  MCOperand_CreateReg0(mcInst, indexReg);
1060
436k
  MCOperand_CreateImm0(mcInst, insn->displacement);
1061
1062
436k
  MCOperand_CreateReg0(mcInst, segmentRegnums[insn->segmentOverride]);
1063
1064
436k
  return false;
1065
436k
}
1066
1067
/// translateRM - Translates an operand stored in the R/M (and possibly SIB)
1068
///   byte of an instruction to LLVM form, and appends it to an MCInst.
1069
///
1070
/// @param mcInst       - The MCInst to append to.
1071
/// @param operand      - The operand, as stored in the descriptor table.
1072
/// @param insn         - The instruction to extract Mod, R/M, and SIB fields
1073
///                       from.
1074
/// @return             - 0 on success; nonzero otherwise
1075
static bool translateRM(MCInst *mcInst, const OperandSpecifier *operand,
1076
      InternalInstruction *insn)
1077
643k
{
1078
643k
  switch (operand->type) {
1079
0
  default:
1080
    //debug("Unexpected type for a R/M operand");
1081
0
    return true;
1082
79.3k
  case TYPE_R8:
1083
80.1k
  case TYPE_R16:
1084
81.3k
  case TYPE_R32:
1085
90.6k
  case TYPE_R64:
1086
168k
  case TYPE_Rv:
1087
172k
  case TYPE_MM64:
1088
187k
  case TYPE_XMM:
1089
195k
  case TYPE_YMM:
1090
204k
  case TYPE_ZMM:
1091
206k
  case TYPE_VK:
1092
206k
  case TYPE_DEBUGREG:
1093
206k
  case TYPE_CONTROLREG:
1094
206k
  case TYPE_BNDR:
1095
206k
    return translateRMRegister(mcInst, insn);
1096
431k
  case TYPE_M:
1097
433k
  case TYPE_MVSIBX:
1098
434k
  case TYPE_MVSIBY:
1099
436k
  case TYPE_MVSIBZ:
1100
436k
    return translateRMMemory(mcInst, insn);
1101
643k
  }
1102
643k
}
1103
1104
/// translateFPRegister - Translates a stack position on the FPU stack to its
1105
///   LLVM form, and appends it to an MCInst.
1106
///
1107
/// @param mcInst       - The MCInst to append to.
1108
/// @param stackPos     - The stack position to translate.
1109
static void translateFPRegister(MCInst *mcInst, uint8_t stackPos)
1110
4.87k
{
1111
4.87k
  MCOperand_CreateReg0(mcInst, X86_ST0 + stackPos);
1112
4.87k
}
1113
1114
/// translateMaskRegister - Translates a 3-bit mask register number to
1115
///   LLVM form, and appends it to an MCInst.
1116
///
1117
/// @param mcInst       - The MCInst to append to.
1118
/// @param maskRegNum   - Number of mask register from 0 to 7.
1119
/// @return             - false on success; true otherwise.
1120
static bool translateMaskRegister(MCInst *mcInst, uint8_t maskRegNum)
1121
33.0k
{
1122
33.0k
  if (maskRegNum >= 8) {
1123
    // debug("Invalid mask register number");
1124
0
    return true;
1125
0
  }
1126
1127
33.0k
  MCOperand_CreateReg0(mcInst, X86_K0 + maskRegNum);
1128
1129
33.0k
  return false;
1130
33.0k
}
1131
1132
/// translateOperand - Translates an operand stored in an internal instruction
1133
///   to LLVM's format and appends it to an MCInst.
1134
///
1135
/// @param mcInst       - The MCInst to append to.
1136
/// @param operand      - The operand, as stored in the descriptor table.
1137
/// @param insn         - The internal instruction.
1138
/// @return             - false on success; true otherwise.
1139
static bool translateOperand(MCInst *mcInst, const OperandSpecifier *operand,
1140
           InternalInstruction *insn)
1141
2.09M
{
1142
2.09M
  switch (operand->encoding) {
1143
522k
  case ENCODING_REG:
1144
522k
    translateRegister(mcInst, insn->reg);
1145
522k
    return false;
1146
33.0k
  case ENCODING_WRITEMASK:
1147
33.0k
    return translateMaskRegister(mcInst, insn->writemask);
1148
4.30M
CASE_ENCODING_RM:
1149
4.30M
CASE_ENCODING_VSIB:
1150
643k
    return translateRM(mcInst, operand, insn);
1151
215k
  case ENCODING_IB:
1152
231k
  case ENCODING_IW:
1153
237k
  case ENCODING_ID:
1154
238k
  case ENCODING_IO:
1155
287k
  case ENCODING_Iv:
1156
297k
  case ENCODING_Ia:
1157
297k
    translateImmediate(
1158
297k
      mcInst,
1159
297k
      insn->immediates[insn->numImmediatesTranslated++],
1160
297k
      operand, insn);
1161
297k
    return false;
1162
3.08k
  case ENCODING_IRC:
1163
3.08k
    MCOperand_CreateImm0(mcInst, insn->RC);
1164
3.08k
    return false;
1165
52.0k
  case ENCODING_SI:
1166
52.0k
    return translateSrcIndex(mcInst, insn);
1167
62.1k
  case ENCODING_DI:
1168
62.1k
    return translateDstIndex(mcInst, insn);
1169
17.5k
  case ENCODING_RB:
1170
17.5k
  case ENCODING_RW:
1171
17.5k
  case ENCODING_RD:
1172
38.9k
  case ENCODING_RO:
1173
196k
  case ENCODING_Rv:
1174
196k
    translateRegister(mcInst, insn->opcodeRegister);
1175
196k
    return false;
1176
4.87k
  case ENCODING_FP:
1177
4.87k
    translateFPRegister(mcInst, insn->modRM & 7);
1178
4.87k
    return false;
1179
51.5k
  case ENCODING_VVVV:
1180
51.5k
    translateRegister(mcInst, insn->vvvv);
1181
51.5k
    return false;
1182
232k
  case ENCODING_DUP:
1183
232k
    return translateOperand(
1184
232k
      mcInst, &insn->operands[operand->type - TYPE_DUP0],
1185
232k
      insn);
1186
0
  default:
1187
    //debug("Unhandled operand encoding during translation");
1188
0
    return true;
1189
2.09M
  }
1190
2.09M
}
1191
1192
static bool translateInstruction(MCInst *mcInst, InternalInstruction *insn)
1193
1.10M
{
1194
1.10M
  int index;
1195
1196
1.10M
  if (!insn->spec) {
1197
    //debug("Instruction has no specification");
1198
0
    return true;
1199
0
  }
1200
1201
1.10M
  MCInst_clear(mcInst);
1202
1.10M
  MCInst_setOpcode(mcInst, insn->instructionID);
1203
1204
  // If when reading the prefix bytes we determined the overlapping 0xf2 or 0xf3
1205
  // prefix bytes should be disassembled as xrelease and xacquire then set the
1206
  // opcode to those instead of the rep and repne opcodes.
1207
1.10M
#ifndef CAPSTONE_X86_REDUCE
1208
1.10M
  if (insn->xAcquireRelease) {
1209
2.29k
    if (MCInst_getOpcode(mcInst) == X86_REP_PREFIX)
1210
0
      MCInst_setOpcode(mcInst, X86_XRELEASE_PREFIX);
1211
2.29k
    else if (MCInst_getOpcode(mcInst) == X86_REPNE_PREFIX)
1212
0
      MCInst_setOpcode(mcInst, X86_XACQUIRE_PREFIX);
1213
2.29k
  }
1214
1.10M
#endif
1215
1216
1.10M
  insn->numImmediatesTranslated = 0;
1217
1218
7.75M
  for (index = 0; index < X86_MAX_OPERANDS; ++index) {
1219
6.64M
    if (insn->operands[index].encoding != ENCODING_NONE) {
1220
1.86M
      if (translateOperand(mcInst, &insn->operands[index],
1221
1.86M
               insn)) {
1222
0
        return true;
1223
0
      }
1224
1.86M
    }
1225
6.64M
  }
1226
1227
1.10M
  return false;
1228
1.10M
}
1229
1230
static int reader(const struct reader_info *info, uint8_t *byte,
1231
      uint64_t address)
1232
4.25M
{
1233
4.25M
  if (address - info->offset >= info->size)
1234
    // out of buffer range
1235
3.68k
    return -1;
1236
1237
4.25M
  *byte = info->code[address - info->offset];
1238
1239
4.25M
  return 0;
1240
4.25M
}
1241
1242
// copy x86 detail information from internal structure to public structure
1243
static void update_pub_insn(cs_insn *pub, InternalInstruction *inter)
1244
1.10M
{
1245
1.10M
  if (inter->vectorExtensionType != 0) {
1246
66.3k
    memcpy(pub->detail->x86.opcode, inter->vectorExtensionPrefix,
1247
66.3k
           sizeof(pub->detail->x86.opcode));
1248
1.04M
  } else {
1249
1.04M
    if (inter->twoByteEscape) {
1250
53.7k
      if (inter->threeByteEscape) {
1251
0
        pub->detail->x86.opcode[0] =
1252
0
          inter->twoByteEscape;
1253
0
        pub->detail->x86.opcode[1] =
1254
0
          inter->threeByteEscape;
1255
0
        pub->detail->x86.opcode[2] = inter->opcode;
1256
53.7k
      } else {
1257
53.7k
        pub->detail->x86.opcode[0] =
1258
53.7k
          inter->twoByteEscape;
1259
53.7k
        pub->detail->x86.opcode[1] = inter->opcode;
1260
53.7k
      }
1261
987k
    } else {
1262
987k
      pub->detail->x86.opcode[0] = inter->opcode;
1263
987k
    }
1264
1.04M
  }
1265
1266
1.10M
  pub->detail->x86.rex = inter->rexPrefix;
1267
1268
1.10M
  pub->detail->x86.addr_size = inter->addressSize;
1269
1270
1.10M
  pub->detail->x86.modrm = inter->orgModRM;
1271
1.10M
  pub->detail->x86.encoding.modrm_offset = inter->modRMOffset;
1272
1273
1.10M
  pub->detail->x86.sib = inter->sib;
1274
1.10M
  pub->detail->x86.sib_index = x86_map_sib_index(inter->sibIndex);
1275
1.10M
  pub->detail->x86.sib_scale = inter->sibScale;
1276
1.10M
  pub->detail->x86.sib_base = x86_map_sib_base(inter->sibBase);
1277
1278
1.10M
  pub->detail->x86.disp = inter->displacement;
1279
1.10M
  if (inter->consumedDisplacement) {
1280
158k
    pub->detail->x86.encoding.disp_offset =
1281
158k
      inter->displacementOffset;
1282
158k
    pub->detail->x86.encoding.disp_size = inter->displacementSize;
1283
158k
  }
1284
1285
1.10M
  pub->detail->x86.encoding.imm_offset = inter->immediateOffset;
1286
1.10M
  if (pub->detail->x86.encoding.imm_size == 0 &&
1287
1.10M
      inter->immediateOffset != 0)
1288
279k
    pub->detail->x86.encoding.imm_size = inter->immediateSize;
1289
1.10M
}
1290
1291
void X86_init(MCRegisterInfo *MRI)
1292
9.31k
{
1293
  // InitMCRegisterInfo(), X86GenRegisterInfo.inc
1294
  // RI->InitMCRegisterInfo(X86RegDesc, 277,
1295
  //                        RA, PC,
1296
  //                        X86MCRegisterClasses, 86,
1297
  //                        X86RegUnitRoots, 162, X86RegDiffLists, X86LaneMaskLists, X86RegStrings,
1298
  //                        X86RegClassStrings,
1299
  //                        X86SubRegIdxLists, 9,
1300
  //                        X86SubRegIdxRanges, X86RegEncodingTable);
1301
  /*
1302
     InitMCRegisterInfo(X86RegDesc, 234,
1303
     RA, PC,
1304
     X86MCRegisterClasses, 79,
1305
     X86RegUnitRoots, 119, X86RegDiffLists, X86RegStrings,
1306
     X86SubRegIdxLists, 7,
1307
     X86SubRegIdxRanges, X86RegEncodingTable);
1308
  */
1309
1310
9.31k
  MCRegisterInfo_InitMCRegisterInfo(MRI, X86RegDesc, 277, 0, 0,
1311
9.31k
            X86MCRegisterClasses, 86, 0, 0,
1312
9.31k
            X86RegDiffLists, 0, X86SubRegIdxLists,
1313
9.31k
            9, 0);
1314
9.31k
}
1315
1316
// Public interface for the disassembler
1317
bool X86_getInstruction(csh ud, const uint8_t *code, size_t code_len,
1318
      MCInst *instr, uint16_t *size, uint64_t address,
1319
      void *_info)
1320
1.11M
{
1321
1.11M
  cs_struct *handle = (cs_struct *)(uintptr_t)ud;
1322
1.11M
  InternalInstruction insn = { 0 };
1323
1.11M
  struct reader_info info;
1324
1.11M
  int ret;
1325
1.11M
  bool result;
1326
1327
1.11M
  info.code = code;
1328
1.11M
  info.size = code_len;
1329
1.11M
  info.offset = address;
1330
1331
1.11M
  if (instr->flat_insn->detail) {
1332
    // instr->flat_insn->detail initialization: 3 alternatives
1333
1334
    // 1. The whole structure, this is how it's done in other arch disassemblers
1335
    // Probably overkill since cs_detail is huge because of the 36 operands of ARM
1336
1337
    //memset(instr->flat_insn->detail, 0, sizeof(cs_detail));
1338
1339
    // 2. Only the part relevant to x86
1340
1.11M
    memset(instr->flat_insn->detail, 0,
1341
1.11M
           offsetof(cs_detail, x86) + sizeof(cs_x86));
1342
1343
    // 3. The relevant part except for x86.operands
1344
    // sizeof(cs_x86) is 0x1c0, sizeof(x86.operands) is 0x180
1345
    // marginally faster, should be okay since x86.op_count is set to 0
1346
1347
    //memset(instr->flat_insn->detail, 0, offsetof(cs_detail, x86)+offsetof(cs_x86, operands));
1348
1.11M
  }
1349
1350
1.11M
  if (handle->mode & CS_MODE_16)
1351
368k
    ret = decodeInstruction(&insn, reader, &info, address,
1352
368k
          MODE_16BIT);
1353
745k
  else if (handle->mode & CS_MODE_32)
1354
369k
    ret = decodeInstruction(&insn, reader, &info, address,
1355
369k
          MODE_32BIT);
1356
376k
  else
1357
376k
    ret = decodeInstruction(&insn, reader, &info, address,
1358
376k
          MODE_64BIT);
1359
1360
1.11M
  if (ret) {
1361
    // *size = (uint16_t)(insn.readerCursor - address);
1362
5.80k
    return false;
1363
1.10M
  } else {
1364
1.10M
    *size = (uint16_t)insn.length;
1365
1366
1.10M
    result = (!translateInstruction(instr, &insn)) ? true : false;
1367
1.10M
    if (result) {
1368
1.10M
      unsigned Flags = X86_IP_NO_PREFIX;
1369
1.10M
      instr->imm_size = insn.immSize;
1370
1371
      // copy all prefixes
1372
1.10M
      instr->x86_prefix[0] = insn.prefix0;
1373
1.10M
      instr->x86_prefix[1] = insn.prefix1;
1374
1.10M
      instr->x86_prefix[2] = insn.prefix2;
1375
1.10M
      instr->x86_prefix[3] = insn.prefix3;
1376
1.10M
      instr->xAcquireRelease = insn.xAcquireRelease;
1377
1.10M
      instr->x86Lock = insn.hasLockPrefix;
1378
1379
1.10M
      if (handle->detail_opt) {
1380
1.10M
        update_pub_insn(instr->flat_insn, &insn);
1381
1.10M
      }
1382
1383
1.10M
      if (insn.hasAdSize)
1384
9.08k
        Flags |= X86_IP_HAS_AD_SIZE;
1385
1386
1.10M
      if (insn.hasOpSize)
1387
31.5k
        Flags |= X86_IP_HAS_OP_SIZE;
1388
1389
1.10M
      if (insn.repeatPrefix == 0xf2)
1390
32.8k
        Flags |= X86_IP_HAS_REPEAT_NE;
1391
1.07M
      else if (insn.repeatPrefix == 0xf3 &&
1392
         // It should not be 'pause' f3 90
1393
24.5k
         insn.opcode != 0x90)
1394
23.9k
        Flags |= X86_IP_HAS_REPEAT;
1395
1.10M
      if (insn.hasLockPrefix)
1396
37.9k
        Flags |= X86_IP_HAS_LOCK;
1397
1398
1.10M
      instr->flags = Flags;
1399
1.10M
    }
1400
1401
1.10M
    return result;
1402
1.10M
  }
1403
1.11M
}
1404
1405
#endif