Coverage Report

Created: 2025-08-29 06:29

/src/capstonenext/arch/X86/X86Disassembler.c
Line
Count
Source (jump to first uncovered line)
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
339k
{
140
75.6M
#define ENTRY(x) X86_##x,
141
339k
  static const uint16_t llvmRegnums[] = { ALL_REGS 0 };
142
339k
#undef ENTRY
143
144
339k
  uint16_t llvmRegnum = llvmRegnums[reg];
145
339k
  MCOperand_CreateReg0(mcInst, llvmRegnum);
146
339k
}
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
22.0k
{
159
22.0k
  unsigned baseRegNo;
160
161
22.0k
  if (insn->mode == MODE_64BIT)
162
9.03k
    baseRegNo = insn->hasAdSize ? X86_ESI : X86_RSI;
163
12.9k
  else if (insn->mode == MODE_32BIT)
164
4.69k
    baseRegNo = insn->hasAdSize ? X86_SI : X86_ESI;
165
8.29k
  else {
166
    // assert(insn->mode == MODE_16BIT);
167
8.29k
    baseRegNo = insn->hasAdSize ? X86_ESI : X86_SI;
168
8.29k
  }
169
170
22.0k
  MCOperand_CreateReg0(mcInst, baseRegNo);
171
172
22.0k
  MCOperand_CreateReg0(mcInst, segmentRegnums[insn->segmentOverride]);
173
174
22.0k
  return false;
175
22.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
27.6k
{
183
27.6k
  unsigned baseRegNo;
184
185
27.6k
  if (insn->mode == MODE_64BIT)
186
10.8k
    baseRegNo = insn->hasAdSize ? X86_EDI : X86_RDI;
187
16.7k
  else if (insn->mode == MODE_32BIT)
188
5.94k
    baseRegNo = insn->hasAdSize ? X86_DI : X86_EDI;
189
10.8k
  else {
190
    // assert(insn->mode == MODE_16BIT);
191
10.8k
    baseRegNo = insn->hasAdSize ? X86_EDI : X86_DI;
192
10.8k
  }
193
194
27.6k
  MCOperand_CreateReg0(mcInst, baseRegNo);
195
196
27.6k
  return false;
197
27.6k
}
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
126k
{
209
126k
  OperandType type;
210
211
126k
  type = (OperandType)operand->type;
212
126k
  if (type == TYPE_REL) {
213
    //isBranch = true;
214
    //pcrel = insn->startLocation + insn->immediateOffset + insn->immediateSize;
215
29.8k
    switch (operand->encoding) {
216
0
    default:
217
0
      break;
218
1.80k
    case ENCODING_Iv:
219
1.80k
      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
612
      case 2:
227
612
        if (immediate & 0x8000)
228
368
          immediate |= ~(0xffffull);
229
612
        break;
230
1.18k
      case 4:
231
1.18k
        if (immediate & 0x80000000)
232
523
          immediate |= ~(0xffffffffull);
233
1.18k
        break;
234
0
      case 8:
235
0
        break;
236
1.80k
      }
237
1.80k
      break;
238
25.5k
    case ENCODING_IB:
239
25.5k
      if (immediate & 0x80)
240
8.85k
        immediate |= ~(0xffull);
241
25.5k
      break;
242
1.31k
    case ENCODING_IW:
243
1.31k
      if (immediate & 0x8000)
244
665
        immediate |= ~(0xffffull);
245
1.31k
      break;
246
1.15k
    case ENCODING_ID:
247
1.15k
      if (immediate & 0x80000000)
248
834
        immediate |= ~(0xffffffffull);
249
1.15k
      break;
250
29.8k
    }
251
29.8k
  } // By default sign-extend all X86 immediates based on their encoding.
252
96.2k
  else if (type == TYPE_IMM) {
253
56.3k
    switch (operand->encoding) {
254
16.1k
    default:
255
16.1k
      break;
256
34.2k
    case ENCODING_IB:
257
34.2k
      if (immediate & 0x80)
258
13.1k
        immediate |= ~(0xffull);
259
34.2k
      break;
260
4.74k
    case ENCODING_IW:
261
4.74k
      if (immediate & 0x8000)
262
2.74k
        immediate |= ~(0xffffull);
263
4.74k
      break;
264
1.11k
    case ENCODING_ID:
265
1.11k
      if (immediate & 0x80000000)
266
460
        immediate |= ~(0xffffffffull);
267
1.11k
      break;
268
114
    case ENCODING_IO:
269
114
      break;
270
56.3k
    }
271
56.3k
  } else if (type == TYPE_IMM3) {
272
4.92k
#ifndef CAPSTONE_X86_REDUCE
273
    // Check for immediates that printSSECC can't handle.
274
4.92k
    if (immediate >= 8) {
275
3.12k
      unsigned NewOpc = 0;
276
277
3.12k
      switch (MCInst_getOpcode(mcInst)) {
278
0
      default:
279
0
        break; // never reach
280
15
      case X86_CMPPDrmi:
281
15
        NewOpc = X86_CMPPDrmi_alt;
282
15
        break;
283
55
      case X86_CMPPDrri:
284
55
        NewOpc = X86_CMPPDrri_alt;
285
55
        break;
286
215
      case X86_CMPPSrmi:
287
215
        NewOpc = X86_CMPPSrmi_alt;
288
215
        break;
289
259
      case X86_CMPPSrri:
290
259
        NewOpc = X86_CMPPSrri_alt;
291
259
        break;
292
285
      case X86_CMPSDrm:
293
285
        NewOpc = X86_CMPSDrm_alt;
294
285
        break;
295
207
      case X86_CMPSDrr:
296
207
        NewOpc = X86_CMPSDrr_alt;
297
207
        break;
298
232
      case X86_CMPSSrm:
299
232
        NewOpc = X86_CMPSSrm_alt;
300
232
        break;
301
103
      case X86_CMPSSrr:
302
103
        NewOpc = X86_CMPSSrr_alt;
303
103
        break;
304
196
      case X86_VPCOMBri:
305
196
        NewOpc = X86_VPCOMBri_alt;
306
196
        break;
307
30
      case X86_VPCOMBmi:
308
30
        NewOpc = X86_VPCOMBmi_alt;
309
30
        break;
310
226
      case X86_VPCOMWri:
311
226
        NewOpc = X86_VPCOMWri_alt;
312
226
        break;
313
22
      case X86_VPCOMWmi:
314
22
        NewOpc = X86_VPCOMWmi_alt;
315
22
        break;
316
97
      case X86_VPCOMDri:
317
97
        NewOpc = X86_VPCOMDri_alt;
318
97
        break;
319
105
      case X86_VPCOMDmi:
320
105
        NewOpc = X86_VPCOMDmi_alt;
321
105
        break;
322
26
      case X86_VPCOMQri:
323
26
        NewOpc = X86_VPCOMQri_alt;
324
26
        break;
325
37
      case X86_VPCOMQmi:
326
37
        NewOpc = X86_VPCOMQmi_alt;
327
37
        break;
328
74
      case X86_VPCOMUBri:
329
74
        NewOpc = X86_VPCOMUBri_alt;
330
74
        break;
331
187
      case X86_VPCOMUBmi:
332
187
        NewOpc = X86_VPCOMUBmi_alt;
333
187
        break;
334
31
      case X86_VPCOMUWri:
335
31
        NewOpc = X86_VPCOMUWri_alt;
336
31
        break;
337
42
      case X86_VPCOMUWmi:
338
42
        NewOpc = X86_VPCOMUWmi_alt;
339
42
        break;
340
424
      case X86_VPCOMUDri:
341
424
        NewOpc = X86_VPCOMUDri_alt;
342
424
        break;
343
131
      case X86_VPCOMUDmi:
344
131
        NewOpc = X86_VPCOMUDmi_alt;
345
131
        break;
346
40
      case X86_VPCOMUQri:
347
40
        NewOpc = X86_VPCOMUQri_alt;
348
40
        break;
349
86
      case X86_VPCOMUQmi:
350
86
        NewOpc = X86_VPCOMUQmi_alt;
351
86
        break;
352
3.12k
      }
353
354
      // Switch opcode to the one that doesn't get special printing.
355
3.12k
      if (NewOpc != 0) {
356
3.12k
        MCInst_setOpcode(mcInst, NewOpc);
357
3.12k
      }
358
3.12k
    }
359
4.92k
#endif
360
34.9k
  } else if (type == TYPE_IMM5) {
361
7.81k
#ifndef CAPSTONE_X86_REDUCE
362
    // Check for immediates that printAVXCC can't handle.
363
7.81k
    if (immediate >= 32) {
364
6.34k
      unsigned NewOpc = 0;
365
366
6.34k
      switch (MCInst_getOpcode(mcInst)) {
367
1.92k
      default:
368
1.92k
        break; // unexpected opcode
369
1.92k
      case X86_VCMPPDrmi:
370
47
        NewOpc = X86_VCMPPDrmi_alt;
371
47
        break;
372
40
      case X86_VCMPPDrri:
373
40
        NewOpc = X86_VCMPPDrri_alt;
374
40
        break;
375
81
      case X86_VCMPPSrmi:
376
81
        NewOpc = X86_VCMPPSrmi_alt;
377
81
        break;
378
479
      case X86_VCMPPSrri:
379
479
        NewOpc = X86_VCMPPSrri_alt;
380
479
        break;
381
107
      case X86_VCMPSDrm:
382
107
        NewOpc = X86_VCMPSDrm_alt;
383
107
        break;
384
64
      case X86_VCMPSDrr:
385
64
        NewOpc = X86_VCMPSDrr_alt;
386
64
        break;
387
96
      case X86_VCMPSSrm:
388
96
        NewOpc = X86_VCMPSSrm_alt;
389
96
        break;
390
606
      case X86_VCMPSSrr:
391
606
        NewOpc = X86_VCMPSSrr_alt;
392
606
        break;
393
22
      case X86_VCMPPDYrmi:
394
22
        NewOpc = X86_VCMPPDYrmi_alt;
395
22
        break;
396
46
      case X86_VCMPPDYrri:
397
46
        NewOpc = X86_VCMPPDYrri_alt;
398
46
        break;
399
149
      case X86_VCMPPSYrmi:
400
149
        NewOpc = X86_VCMPPSYrmi_alt;
401
149
        break;
402
350
      case X86_VCMPPSYrri:
403
350
        NewOpc = X86_VCMPPSYrri_alt;
404
350
        break;
405
325
      case X86_VCMPPDZrmi:
406
325
        NewOpc = X86_VCMPPDZrmi_alt;
407
325
        break;
408
386
      case X86_VCMPPDZrri:
409
386
        NewOpc = X86_VCMPPDZrri_alt;
410
386
        break;
411
11
      case X86_VCMPPDZrrib:
412
11
        NewOpc = X86_VCMPPDZrrib_alt;
413
11
        break;
414
99
      case X86_VCMPPSZrmi:
415
99
        NewOpc = X86_VCMPPSZrmi_alt;
416
99
        break;
417
29
      case X86_VCMPPSZrri:
418
29
        NewOpc = X86_VCMPPSZrri_alt;
419
29
        break;
420
88
      case X86_VCMPPSZrrib:
421
88
        NewOpc = X86_VCMPPSZrrib_alt;
422
88
        break;
423
20
      case X86_VCMPPDZ128rmi:
424
20
        NewOpc = X86_VCMPPDZ128rmi_alt;
425
20
        break;
426
16
      case X86_VCMPPDZ128rri:
427
16
        NewOpc = X86_VCMPPDZ128rri_alt;
428
16
        break;
429
52
      case X86_VCMPPSZ128rmi:
430
52
        NewOpc = X86_VCMPPSZ128rmi_alt;
431
52
        break;
432
286
      case X86_VCMPPSZ128rri:
433
286
        NewOpc = X86_VCMPPSZ128rri_alt;
434
286
        break;
435
67
      case X86_VCMPPDZ256rmi:
436
67
        NewOpc = X86_VCMPPDZ256rmi_alt;
437
67
        break;
438
37
      case X86_VCMPPDZ256rri:
439
37
        NewOpc = X86_VCMPPDZ256rri_alt;
440
37
        break;
441
8
      case X86_VCMPPSZ256rmi:
442
8
        NewOpc = X86_VCMPPSZ256rmi_alt;
443
8
        break;
444
246
      case X86_VCMPPSZ256rri:
445
246
        NewOpc = X86_VCMPPSZ256rri_alt;
446
246
        break;
447
26
      case X86_VCMPSDZrm_Int:
448
26
        NewOpc = X86_VCMPSDZrmi_alt;
449
26
        break;
450
23
      case X86_VCMPSDZrr_Int:
451
23
        NewOpc = X86_VCMPSDZrri_alt;
452
23
        break;
453
132
      case X86_VCMPSDZrrb_Int:
454
132
        NewOpc = X86_VCMPSDZrrb_alt;
455
132
        break;
456
156
      case X86_VCMPSSZrm_Int:
457
156
        NewOpc = X86_VCMPSSZrmi_alt;
458
156
        break;
459
104
      case X86_VCMPSSZrr_Int:
460
104
        NewOpc = X86_VCMPSSZrri_alt;
461
104
        break;
462
227
      case X86_VCMPSSZrrb_Int:
463
227
        NewOpc = X86_VCMPSSZrrb_alt;
464
227
        break;
465
6.34k
      }
466
467
      // Switch opcode to the one that doesn't get special printing.
468
6.34k
      if (NewOpc != 0) {
469
4.42k
        MCInst_setOpcode(mcInst, NewOpc);
470
4.42k
      }
471
6.34k
    }
472
7.81k
#endif
473
27.1k
  } else if (type == TYPE_AVX512ICC) {
474
5.22k
#ifndef CAPSTONE_X86_REDUCE
475
5.22k
    if (immediate >= 8 || ((immediate & 0x3) == 3)) {
476
3.23k
      unsigned NewOpc = 0;
477
3.23k
      switch (MCInst_getOpcode(mcInst)) {
478
0
      default: // llvm_unreachable("unexpected opcode");
479
194
      case X86_VPCMPBZ128rmi:
480
194
        NewOpc = X86_VPCMPBZ128rmi_alt;
481
194
        break;
482
9
      case X86_VPCMPBZ128rmik:
483
9
        NewOpc = X86_VPCMPBZ128rmik_alt;
484
9
        break;
485
15
      case X86_VPCMPBZ128rri:
486
15
        NewOpc = X86_VPCMPBZ128rri_alt;
487
15
        break;
488
61
      case X86_VPCMPBZ128rrik:
489
61
        NewOpc = X86_VPCMPBZ128rrik_alt;
490
61
        break;
491
129
      case X86_VPCMPBZ256rmi:
492
129
        NewOpc = X86_VPCMPBZ256rmi_alt;
493
129
        break;
494
7
      case X86_VPCMPBZ256rmik:
495
7
        NewOpc = X86_VPCMPBZ256rmik_alt;
496
7
        break;
497
336
      case X86_VPCMPBZ256rri:
498
336
        NewOpc = X86_VPCMPBZ256rri_alt;
499
336
        break;
500
2
      case X86_VPCMPBZ256rrik:
501
2
        NewOpc = X86_VPCMPBZ256rrik_alt;
502
2
        break;
503
30
      case X86_VPCMPBZrmi:
504
30
        NewOpc = X86_VPCMPBZrmi_alt;
505
30
        break;
506
13
      case X86_VPCMPBZrmik:
507
13
        NewOpc = X86_VPCMPBZrmik_alt;
508
13
        break;
509
4
      case X86_VPCMPBZrri:
510
4
        NewOpc = X86_VPCMPBZrri_alt;
511
4
        break;
512
0
      case X86_VPCMPBZrrik:
513
0
        NewOpc = X86_VPCMPBZrrik_alt;
514
0
        break;
515
0
      case X86_VPCMPDZ128rmi:
516
0
        NewOpc = X86_VPCMPDZ128rmi_alt;
517
0
        break;
518
0
      case X86_VPCMPDZ128rmib:
519
0
        NewOpc = X86_VPCMPDZ128rmib_alt;
520
0
        break;
521
72
      case X86_VPCMPDZ128rmibk:
522
72
        NewOpc = X86_VPCMPDZ128rmibk_alt;
523
72
        break;
524
149
      case X86_VPCMPDZ128rmik:
525
149
        NewOpc = X86_VPCMPDZ128rmik_alt;
526
149
        break;
527
9
      case X86_VPCMPDZ128rri:
528
9
        NewOpc = X86_VPCMPDZ128rri_alt;
529
9
        break;
530
0
      case X86_VPCMPDZ128rrik:
531
0
        NewOpc = X86_VPCMPDZ128rrik_alt;
532
0
        break;
533
11
      case X86_VPCMPDZ256rmi:
534
11
        NewOpc = X86_VPCMPDZ256rmi_alt;
535
11
        break;
536
14
      case X86_VPCMPDZ256rmib:
537
14
        NewOpc = X86_VPCMPDZ256rmib_alt;
538
14
        break;
539
10
      case X86_VPCMPDZ256rmibk:
540
10
        NewOpc = X86_VPCMPDZ256rmibk_alt;
541
10
        break;
542
794
      case X86_VPCMPDZ256rmik:
543
794
        NewOpc = X86_VPCMPDZ256rmik_alt;
544
794
        break;
545
0
      case X86_VPCMPDZ256rri:
546
0
        NewOpc = X86_VPCMPDZ256rri_alt;
547
0
        break;
548
55
      case X86_VPCMPDZ256rrik:
549
55
        NewOpc = X86_VPCMPDZ256rrik_alt;
550
55
        break;
551
3
      case X86_VPCMPDZrmi:
552
3
        NewOpc = X86_VPCMPDZrmi_alt;
553
3
        break;
554
29
      case X86_VPCMPDZrmib:
555
29
        NewOpc = X86_VPCMPDZrmib_alt;
556
29
        break;
557
15
      case X86_VPCMPDZrmibk:
558
15
        NewOpc = X86_VPCMPDZrmibk_alt;
559
15
        break;
560
22
      case X86_VPCMPDZrmik:
561
22
        NewOpc = X86_VPCMPDZrmik_alt;
562
22
        break;
563
0
      case X86_VPCMPDZrri:
564
0
        NewOpc = X86_VPCMPDZrri_alt;
565
0
        break;
566
11
      case X86_VPCMPDZrrik:
567
11
        NewOpc = X86_VPCMPDZrrik_alt;
568
11
        break;
569
0
      case X86_VPCMPQZ128rmi:
570
0
        NewOpc = X86_VPCMPQZ128rmi_alt;
571
0
        break;
572
10
      case X86_VPCMPQZ128rmib:
573
10
        NewOpc = X86_VPCMPQZ128rmib_alt;
574
10
        break;
575
7
      case X86_VPCMPQZ128rmibk:
576
7
        NewOpc = X86_VPCMPQZ128rmibk_alt;
577
7
        break;
578
11
      case X86_VPCMPQZ128rmik:
579
11
        NewOpc = X86_VPCMPQZ128rmik_alt;
580
11
        break;
581
0
      case X86_VPCMPQZ128rri:
582
0
        NewOpc = X86_VPCMPQZ128rri_alt;
583
0
        break;
584
3
      case X86_VPCMPQZ128rrik:
585
3
        NewOpc = X86_VPCMPQZ128rrik_alt;
586
3
        break;
587
3
      case X86_VPCMPQZ256rmi:
588
3
        NewOpc = X86_VPCMPQZ256rmi_alt;
589
3
        break;
590
18
      case X86_VPCMPQZ256rmib:
591
18
        NewOpc = X86_VPCMPQZ256rmib_alt;
592
18
        break;
593
12
      case X86_VPCMPQZ256rmibk:
594
12
        NewOpc = X86_VPCMPQZ256rmibk_alt;
595
12
        break;
596
11
      case X86_VPCMPQZ256rmik:
597
11
        NewOpc = X86_VPCMPQZ256rmik_alt;
598
11
        break;
599
4
      case X86_VPCMPQZ256rri:
600
4
        NewOpc = X86_VPCMPQZ256rri_alt;
601
4
        break;
602
18
      case X86_VPCMPQZ256rrik:
603
18
        NewOpc = X86_VPCMPQZ256rrik_alt;
604
18
        break;
605
1
      case X86_VPCMPQZrmi:
606
1
        NewOpc = X86_VPCMPQZrmi_alt;
607
1
        break;
608
44
      case X86_VPCMPQZrmib:
609
44
        NewOpc = X86_VPCMPQZrmib_alt;
610
44
        break;
611
22
      case X86_VPCMPQZrmibk:
612
22
        NewOpc = X86_VPCMPQZrmibk_alt;
613
22
        break;
614
2
      case X86_VPCMPQZrmik:
615
2
        NewOpc = X86_VPCMPQZrmik_alt;
616
2
        break;
617
0
      case X86_VPCMPQZrri:
618
0
        NewOpc = X86_VPCMPQZrri_alt;
619
0
        break;
620
6
      case X86_VPCMPQZrrik:
621
6
        NewOpc = X86_VPCMPQZrrik_alt;
622
6
        break;
623
4
      case X86_VPCMPUBZ128rmi:
624
4
        NewOpc = X86_VPCMPUBZ128rmi_alt;
625
4
        break;
626
2
      case X86_VPCMPUBZ128rmik:
627
2
        NewOpc = X86_VPCMPUBZ128rmik_alt;
628
2
        break;
629
58
      case X86_VPCMPUBZ128rri:
630
58
        NewOpc = X86_VPCMPUBZ128rri_alt;
631
58
        break;
632
4
      case X86_VPCMPUBZ128rrik:
633
4
        NewOpc = X86_VPCMPUBZ128rrik_alt;
634
4
        break;
635
17
      case X86_VPCMPUBZ256rmi:
636
17
        NewOpc = X86_VPCMPUBZ256rmi_alt;
637
17
        break;
638
9
      case X86_VPCMPUBZ256rmik:
639
9
        NewOpc = X86_VPCMPUBZ256rmik_alt;
640
9
        break;
641
3
      case X86_VPCMPUBZ256rri:
642
3
        NewOpc = X86_VPCMPUBZ256rri_alt;
643
3
        break;
644
1
      case X86_VPCMPUBZ256rrik:
645
1
        NewOpc = X86_VPCMPUBZ256rrik_alt;
646
1
        break;
647
62
      case X86_VPCMPUBZrmi:
648
62
        NewOpc = X86_VPCMPUBZrmi_alt;
649
62
        break;
650
32
      case X86_VPCMPUBZrmik:
651
32
        NewOpc = X86_VPCMPUBZrmik_alt;
652
32
        break;
653
4
      case X86_VPCMPUBZrri:
654
4
        NewOpc = X86_VPCMPUBZrri_alt;
655
4
        break;
656
5
      case X86_VPCMPUBZrrik:
657
5
        NewOpc = X86_VPCMPUBZrrik_alt;
658
5
        break;
659
0
      case X86_VPCMPUDZ128rmi:
660
0
        NewOpc = X86_VPCMPUDZ128rmi_alt;
661
0
        break;
662
1
      case X86_VPCMPUDZ128rmib:
663
1
        NewOpc = X86_VPCMPUDZ128rmib_alt;
664
1
        break;
665
37
      case X86_VPCMPUDZ128rmibk:
666
37
        NewOpc = X86_VPCMPUDZ128rmibk_alt;
667
37
        break;
668
58
      case X86_VPCMPUDZ128rmik:
669
58
        NewOpc = X86_VPCMPUDZ128rmik_alt;
670
58
        break;
671
7
      case X86_VPCMPUDZ128rri:
672
7
        NewOpc = X86_VPCMPUDZ128rri_alt;
673
7
        break;
674
59
      case X86_VPCMPUDZ128rrik:
675
59
        NewOpc = X86_VPCMPUDZ128rrik_alt;
676
59
        break;
677
7
      case X86_VPCMPUDZ256rmi:
678
7
        NewOpc = X86_VPCMPUDZ256rmi_alt;
679
7
        break;
680
9
      case X86_VPCMPUDZ256rmib:
681
9
        NewOpc = X86_VPCMPUDZ256rmib_alt;
682
9
        break;
683
13
      case X86_VPCMPUDZ256rmibk:
684
13
        NewOpc = X86_VPCMPUDZ256rmibk_alt;
685
13
        break;
686
8
      case X86_VPCMPUDZ256rmik:
687
8
        NewOpc = X86_VPCMPUDZ256rmik_alt;
688
8
        break;
689
5
      case X86_VPCMPUDZ256rri:
690
5
        NewOpc = X86_VPCMPUDZ256rri_alt;
691
5
        break;
692
3
      case X86_VPCMPUDZ256rrik:
693
3
        NewOpc = X86_VPCMPUDZ256rrik_alt;
694
3
        break;
695
9
      case X86_VPCMPUDZrmi:
696
9
        NewOpc = X86_VPCMPUDZrmi_alt;
697
9
        break;
698
16
      case X86_VPCMPUDZrmib:
699
16
        NewOpc = X86_VPCMPUDZrmib_alt;
700
16
        break;
701
12
      case X86_VPCMPUDZrmibk:
702
12
        NewOpc = X86_VPCMPUDZrmibk_alt;
703
12
        break;
704
10
      case X86_VPCMPUDZrmik:
705
10
        NewOpc = X86_VPCMPUDZrmik_alt;
706
10
        break;
707
3
      case X86_VPCMPUDZrri:
708
3
        NewOpc = X86_VPCMPUDZrri_alt;
709
3
        break;
710
8
      case X86_VPCMPUDZrrik:
711
8
        NewOpc = X86_VPCMPUDZrrik_alt;
712
8
        break;
713
5
      case X86_VPCMPUQZ128rmi:
714
5
        NewOpc = X86_VPCMPUQZ128rmi_alt;
715
5
        break;
716
96
      case X86_VPCMPUQZ128rmib:
717
96
        NewOpc = X86_VPCMPUQZ128rmib_alt;
718
96
        break;
719
30
      case X86_VPCMPUQZ128rmibk:
720
30
        NewOpc = X86_VPCMPUQZ128rmibk_alt;
721
30
        break;
722
0
      case X86_VPCMPUQZ128rmik:
723
0
        NewOpc = X86_VPCMPUQZ128rmik_alt;
724
0
        break;
725
42
      case X86_VPCMPUQZ128rri:
726
42
        NewOpc = X86_VPCMPUQZ128rri_alt;
727
42
        break;
728
4
      case X86_VPCMPUQZ128rrik:
729
4
        NewOpc = X86_VPCMPUQZ128rrik_alt;
730
4
        break;
731
29
      case X86_VPCMPUQZ256rmi:
732
29
        NewOpc = X86_VPCMPUQZ256rmi_alt;
733
29
        break;
734
74
      case X86_VPCMPUQZ256rmib:
735
74
        NewOpc = X86_VPCMPUQZ256rmib_alt;
736
74
        break;
737
6
      case X86_VPCMPUQZ256rmibk:
738
6
        NewOpc = X86_VPCMPUQZ256rmibk_alt;
739
6
        break;
740
6
      case X86_VPCMPUQZ256rmik:
741
6
        NewOpc = X86_VPCMPUQZ256rmik_alt;
742
6
        break;
743
5
      case X86_VPCMPUQZ256rri:
744
5
        NewOpc = X86_VPCMPUQZ256rri_alt;
745
5
        break;
746
4
      case X86_VPCMPUQZ256rrik:
747
4
        NewOpc = X86_VPCMPUQZ256rrik_alt;
748
4
        break;
749
8
      case X86_VPCMPUQZrmi:
750
8
        NewOpc = X86_VPCMPUQZrmi_alt;
751
8
        break;
752
0
      case X86_VPCMPUQZrmib:
753
0
        NewOpc = X86_VPCMPUQZrmib_alt;
754
0
        break;
755
93
      case X86_VPCMPUQZrmibk:
756
93
        NewOpc = X86_VPCMPUQZrmibk_alt;
757
93
        break;
758
6
      case X86_VPCMPUQZrmik:
759
6
        NewOpc = X86_VPCMPUQZrmik_alt;
760
6
        break;
761
5
      case X86_VPCMPUQZrri:
762
5
        NewOpc = X86_VPCMPUQZrri_alt;
763
5
        break;
764
2
      case X86_VPCMPUQZrrik:
765
2
        NewOpc = X86_VPCMPUQZrrik_alt;
766
2
        break;
767
0
      case X86_VPCMPUWZ128rmi:
768
0
        NewOpc = X86_VPCMPUWZ128rmi_alt;
769
0
        break;
770
5
      case X86_VPCMPUWZ128rmik:
771
5
        NewOpc = X86_VPCMPUWZ128rmik_alt;
772
5
        break;
773
9
      case X86_VPCMPUWZ128rri:
774
9
        NewOpc = X86_VPCMPUWZ128rri_alt;
775
9
        break;
776
4
      case X86_VPCMPUWZ128rrik:
777
4
        NewOpc = X86_VPCMPUWZ128rrik_alt;
778
4
        break;
779
4
      case X86_VPCMPUWZ256rmi:
780
4
        NewOpc = X86_VPCMPUWZ256rmi_alt;
781
4
        break;
782
4
      case X86_VPCMPUWZ256rmik:
783
4
        NewOpc = X86_VPCMPUWZ256rmik_alt;
784
4
        break;
785
5
      case X86_VPCMPUWZ256rri:
786
5
        NewOpc = X86_VPCMPUWZ256rri_alt;
787
5
        break;
788
7
      case X86_VPCMPUWZ256rrik:
789
7
        NewOpc = X86_VPCMPUWZ256rrik_alt;
790
7
        break;
791
5
      case X86_VPCMPUWZrmi:
792
5
        NewOpc = X86_VPCMPUWZrmi_alt;
793
5
        break;
794
37
      case X86_VPCMPUWZrmik:
795
37
        NewOpc = X86_VPCMPUWZrmik_alt;
796
37
        break;
797
2
      case X86_VPCMPUWZrri:
798
2
        NewOpc = X86_VPCMPUWZrri_alt;
799
2
        break;
800
4
      case X86_VPCMPUWZrrik:
801
4
        NewOpc = X86_VPCMPUWZrrik_alt;
802
4
        break;
803
11
      case X86_VPCMPWZ128rmi:
804
11
        NewOpc = X86_VPCMPWZ128rmi_alt;
805
11
        break;
806
9
      case X86_VPCMPWZ128rmik:
807
9
        NewOpc = X86_VPCMPWZ128rmik_alt;
808
9
        break;
809
3
      case X86_VPCMPWZ128rri:
810
3
        NewOpc = X86_VPCMPWZ128rri_alt;
811
3
        break;
812
2
      case X86_VPCMPWZ128rrik:
813
2
        NewOpc = X86_VPCMPWZ128rrik_alt;
814
2
        break;
815
29
      case X86_VPCMPWZ256rmi:
816
29
        NewOpc = X86_VPCMPWZ256rmi_alt;
817
29
        break;
818
8
      case X86_VPCMPWZ256rmik:
819
8
        NewOpc = X86_VPCMPWZ256rmik_alt;
820
8
        break;
821
15
      case X86_VPCMPWZ256rri:
822
15
        NewOpc = X86_VPCMPWZ256rri_alt;
823
15
        break;
824
4
      case X86_VPCMPWZ256rrik:
825
4
        NewOpc = X86_VPCMPWZ256rrik_alt;
826
4
        break;
827
3
      case X86_VPCMPWZrmi:
828
3
        NewOpc = X86_VPCMPWZrmi_alt;
829
3
        break;
830
8
      case X86_VPCMPWZrmik:
831
8
        NewOpc = X86_VPCMPWZrmik_alt;
832
8
        break;
833
3
      case X86_VPCMPWZrri:
834
3
        NewOpc = X86_VPCMPWZrri_alt;
835
3
        break;
836
2
      case X86_VPCMPWZrrik:
837
2
        NewOpc = X86_VPCMPWZrrik_alt;
838
2
        break;
839
3.23k
      }
840
841
      // Switch opcode to the one that doesn't get special printing.
842
3.23k
      if (NewOpc != 0) {
843
3.23k
        MCInst_setOpcode(mcInst, NewOpc);
844
3.23k
      }
845
3.23k
    }
846
5.22k
#endif
847
5.22k
  }
848
849
126k
  switch (type) {
850
918
  case TYPE_XMM:
851
918
    MCOperand_CreateReg0(mcInst,
852
918
             X86_XMM0 + ((uint32_t)immediate >> 4));
853
918
    return;
854
516
  case TYPE_YMM:
855
516
    MCOperand_CreateReg0(mcInst,
856
516
             X86_YMM0 + ((uint32_t)immediate >> 4));
857
516
    return;
858
0
  case TYPE_ZMM:
859
0
    MCOperand_CreateReg0(mcInst,
860
0
             X86_ZMM0 + ((uint32_t)immediate >> 4));
861
0
    return;
862
124k
  default:
863
    // operand is 64 bits wide.  Do nothing.
864
124k
    break;
865
126k
  }
866
867
124k
  MCOperand_CreateImm0(mcInst, immediate);
868
869
124k
  if (type == TYPE_MOFFS) {
870
5.12k
    MCOperand_CreateReg0(mcInst,
871
5.12k
             segmentRegnums[insn->segmentOverride]);
872
5.12k
  }
873
124k
}
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
91.0k
{
883
91.0k
  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
91.0k
  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
91.0k
  case EA_REG_##x: \
900
91.0k
    MCOperand_CreateReg0(mcInst, X86_##x); \
901
91.0k
    break;
902
0
    ALL_REGS
903
0
#undef ENTRY
904
0
  default:
905
    //debug("Unexpected EA base register");
906
0
    return true;
907
91.0k
  }
908
909
91.0k
  return false;
910
91.0k
}
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
183k
{
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
183k
  int scaleAmount, indexReg;
934
935
183k
  if (insn->eaBase == EA_BASE_sib || insn->eaBase == EA_BASE_sib64) {
936
11.9k
    if (insn->sibBase != SIB_BASE_NONE) {
937
11.3k
      switch (insn->sibBase) {
938
0
#define ENTRY(x) \
939
11.3k
  case SIB_BASE_##x: \
940
11.3k
    MCOperand_CreateReg0(mcInst, X86_##x); \
941
11.3k
    break;
942
0
        ALL_SIB_BASES
943
0
#undef ENTRY
944
0
      default:
945
        //debug("Unexpected sibBase");
946
0
        return true;
947
11.3k
      }
948
11.3k
    } else {
949
646
      MCOperand_CreateReg0(mcInst, 0);
950
646
    }
951
952
11.9k
    if (insn->sibIndex != SIB_INDEX_NONE) {
953
9.91k
      switch (insn->sibIndex) {
954
0
      default:
955
        //debug("Unexpected sibIndex");
956
0
        return true;
957
0
#define ENTRY(x) \
958
9.91k
  case SIB_INDEX_##x: \
959
9.91k
    indexReg = X86_##x; \
960
9.91k
    break;
961
0
        EA_BASES_32BIT
962
72
        EA_BASES_64BIT
963
42
        REGS_XMM
964
33
        REGS_YMM
965
9.91k
        REGS_ZMM
966
9.91k
#undef ENTRY
967
9.91k
      }
968
9.91k
    } 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
2.08k
      if (insn->sibScale != 1 ||
977
2.08k
          (insn->sibBase == SIB_BASE_NONE &&
978
1.15k
           insn->mode != MODE_64BIT) ||
979
2.08k
          (insn->sibBase != SIB_BASE_NONE &&
980
1.12k
           insn->sibBase != SIB_BASE_ESP &&
981
1.12k
           insn->sibBase != SIB_BASE_RSP &&
982
1.12k
           insn->sibBase != SIB_BASE_R12D &&
983
1.41k
           insn->sibBase != SIB_BASE_R12)) {
984
1.41k
        indexReg = insn->addressSize == 4 ? X86_EIZ :
985
1.41k
                    X86_RIZ;
986
1.41k
      } else
987
674
        indexReg = 0;
988
2.08k
    }
989
990
11.9k
    scaleAmount = insn->sibScale;
991
171k
  } else {
992
171k
    switch (insn->eaBase) {
993
4.65k
    case EA_BASE_NONE:
994
4.65k
      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
4.65k
      if (insn->mode == MODE_64BIT) {
999
1.47k
        if (insn->prefix3 ==
1000
1.47k
            0x67) // address-size prefix overrides RIP relative addressing
1001
241
          MCOperand_CreateReg0(mcInst, X86_EIP);
1002
1.23k
        else
1003
          // Section 2.2.1.6
1004
1.23k
          MCOperand_CreateReg0(
1005
1.23k
            mcInst, insn->addressSize == 4 ?
1006
0
                X86_EIP :
1007
1.23k
                X86_RIP);
1008
3.17k
      } else {
1009
3.17k
        MCOperand_CreateReg0(mcInst, 0);
1010
3.17k
      }
1011
1012
4.65k
      indexReg = 0;
1013
4.65k
      break;
1014
22.2k
    case EA_BASE_BX_SI:
1015
22.2k
      MCOperand_CreateReg0(mcInst, X86_BX);
1016
22.2k
      indexReg = X86_SI;
1017
22.2k
      break;
1018
9.25k
    case EA_BASE_BX_DI:
1019
9.25k
      MCOperand_CreateReg0(mcInst, X86_BX);
1020
9.25k
      indexReg = X86_DI;
1021
9.25k
      break;
1022
6.45k
    case EA_BASE_BP_SI:
1023
6.45k
      MCOperand_CreateReg0(mcInst, X86_BP);
1024
6.45k
      indexReg = X86_SI;
1025
6.45k
      break;
1026
4.63k
    case EA_BASE_BP_DI:
1027
4.63k
      MCOperand_CreateReg0(mcInst, X86_BP);
1028
4.63k
      indexReg = X86_DI;
1029
4.63k
      break;
1030
123k
    default:
1031
123k
      indexReg = 0;
1032
123k
      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
123k
  case EA_BASE_##x: \
1042
123k
    MCOperand_CreateReg0(mcInst, X86_##x); \
1043
123k
    break;
1044
0
        ALL_EA_BASES
1045
0
#undef ENTRY
1046
0
#define ENTRY(x) case EA_REG_##x:
1047
667
        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
123k
      }
1053
171k
    }
1054
1055
171k
    scaleAmount = 1;
1056
171k
  }
1057
1058
183k
  MCOperand_CreateImm0(mcInst, scaleAmount);
1059
183k
  MCOperand_CreateReg0(mcInst, indexReg);
1060
183k
  MCOperand_CreateImm0(mcInst, insn->displacement);
1061
1062
183k
  MCOperand_CreateReg0(mcInst, segmentRegnums[insn->segmentOverride]);
1063
1064
183k
  return false;
1065
183k
}
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
274k
{
1078
274k
  switch (operand->type) {
1079
0
  default:
1080
    //debug("Unexpected type for a R/M operand");
1081
0
    return true;
1082
30.4k
  case TYPE_R8:
1083
30.7k
  case TYPE_R16:
1084
31.5k
  case TYPE_R32:
1085
38.6k
  case TYPE_R64:
1086
67.8k
  case TYPE_Rv:
1087
69.1k
  case TYPE_MM64:
1088
80.3k
  case TYPE_XMM:
1089
84.4k
  case TYPE_YMM:
1090
89.8k
  case TYPE_ZMM:
1091
90.7k
  case TYPE_VK:
1092
90.7k
  case TYPE_DEBUGREG:
1093
90.7k
  case TYPE_CONTROLREG:
1094
91.0k
  case TYPE_BNDR:
1095
91.0k
    return translateRMRegister(mcInst, insn);
1096
180k
  case TYPE_M:
1097
181k
  case TYPE_MVSIBX:
1098
182k
  case TYPE_MVSIBY:
1099
183k
  case TYPE_MVSIBZ:
1100
183k
    return translateRMMemory(mcInst, insn);
1101
274k
  }
1102
274k
}
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
2.21k
{
1111
2.21k
  MCOperand_CreateReg0(mcInst, X86_ST0 + stackPos);
1112
2.21k
}
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
23.0k
{
1122
23.0k
  if (maskRegNum >= 8) {
1123
    // debug("Invalid mask register number");
1124
0
    return true;
1125
0
  }
1126
1127
23.0k
  MCOperand_CreateReg0(mcInst, X86_K0 + maskRegNum);
1128
1129
23.0k
  return false;
1130
23.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
917k
{
1142
917k
  switch (operand->encoding) {
1143
229k
  case ENCODING_REG:
1144
229k
    translateRegister(mcInst, insn->reg);
1145
229k
    return false;
1146
23.0k
  case ENCODING_WRITEMASK:
1147
23.0k
    return translateMaskRegister(mcInst, insn->writemask);
1148
1.78M
CASE_ENCODING_RM:
1149
1.78M
CASE_ENCODING_VSIB:
1150
274k
    return translateRM(mcInst, operand, insn);
1151
94.6k
  case ENCODING_IB:
1152
100k
  case ENCODING_IW:
1153
102k
  case ENCODING_ID:
1154
103k
  case ENCODING_IO:
1155
120k
  case ENCODING_Iv:
1156
126k
  case ENCODING_Ia:
1157
126k
    translateImmediate(
1158
126k
      mcInst,
1159
126k
      insn->immediates[insn->numImmediatesTranslated++],
1160
126k
      operand, insn);
1161
126k
    return false;
1162
844
  case ENCODING_IRC:
1163
844
    MCOperand_CreateImm0(mcInst, insn->RC);
1164
844
    return false;
1165
22.0k
  case ENCODING_SI:
1166
22.0k
    return translateSrcIndex(mcInst, insn);
1167
27.6k
  case ENCODING_DI:
1168
27.6k
    return translateDstIndex(mcInst, insn);
1169
7.09k
  case ENCODING_RB:
1170
7.09k
  case ENCODING_RW:
1171
7.09k
  case ENCODING_RD:
1172
17.2k
  case ENCODING_RO:
1173
79.6k
  case ENCODING_Rv:
1174
79.6k
    translateRegister(mcInst, insn->opcodeRegister);
1175
79.6k
    return false;
1176
2.21k
  case ENCODING_FP:
1177
2.21k
    translateFPRegister(mcInst, insn->modRM & 7);
1178
2.21k
    return false;
1179
29.5k
  case ENCODING_VVVV:
1180
29.5k
    translateRegister(mcInst, insn->vvvv);
1181
29.5k
    return false;
1182
102k
  case ENCODING_DUP:
1183
102k
    return translateOperand(
1184
102k
      mcInst, &insn->operands[operand->type - TYPE_DUP0],
1185
102k
      insn);
1186
0
  default:
1187
    //debug("Unhandled operand encoding during translation");
1188
0
    return true;
1189
917k
  }
1190
917k
}
1191
1192
static bool translateInstruction(MCInst *mcInst, InternalInstruction *insn)
1193
467k
{
1194
467k
  int index;
1195
1196
467k
  if (!insn->spec) {
1197
    //debug("Instruction has no specification");
1198
0
    return true;
1199
0
  }
1200
1201
467k
  MCInst_clear(mcInst);
1202
467k
  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
467k
#ifndef CAPSTONE_X86_REDUCE
1208
467k
  if (insn->xAcquireRelease) {
1209
1.91k
    if (MCInst_getOpcode(mcInst) == X86_REP_PREFIX)
1210
0
      MCInst_setOpcode(mcInst, X86_XRELEASE_PREFIX);
1211
1.91k
    else if (MCInst_getOpcode(mcInst) == X86_REPNE_PREFIX)
1212
0
      MCInst_setOpcode(mcInst, X86_XACQUIRE_PREFIX);
1213
1.91k
  }
1214
467k
#endif
1215
1216
467k
  insn->numImmediatesTranslated = 0;
1217
1218
3.27M
  for (index = 0; index < X86_MAX_OPERANDS; ++index) {
1219
2.80M
    if (insn->operands[index].encoding != ENCODING_NONE) {
1220
815k
      if (translateOperand(mcInst, &insn->operands[index],
1221
815k
               insn)) {
1222
0
        return true;
1223
0
      }
1224
815k
    }
1225
2.80M
  }
1226
1227
467k
  return false;
1228
467k
}
1229
1230
static int reader(const struct reader_info *info, uint8_t *byte,
1231
      uint64_t address)
1232
2.12M
{
1233
2.12M
  if (address - info->offset >= info->size)
1234
    // out of buffer range
1235
2.30k
    return -1;
1236
1237
2.12M
  *byte = info->code[address - info->offset];
1238
1239
2.12M
  return 0;
1240
2.12M
}
1241
1242
// copy x86 detail information from internal structure to public structure
1243
static void update_pub_insn(cs_insn *pub, InternalInstruction *inter)
1244
467k
{
1245
467k
  if (inter->vectorExtensionType != 0) {
1246
39.4k
    memcpy(pub->detail->x86.opcode, inter->vectorExtensionPrefix,
1247
39.4k
           sizeof(pub->detail->x86.opcode));
1248
428k
  } else {
1249
428k
    if (inter->twoByteEscape) {
1250
23.1k
      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
23.1k
      } else {
1257
23.1k
        pub->detail->x86.opcode[0] =
1258
23.1k
          inter->twoByteEscape;
1259
23.1k
        pub->detail->x86.opcode[1] = inter->opcode;
1260
23.1k
      }
1261
405k
    } else {
1262
405k
      pub->detail->x86.opcode[0] = inter->opcode;
1263
405k
    }
1264
428k
  }
1265
1266
467k
  pub->detail->x86.rex = inter->rexPrefix;
1267
1268
467k
  pub->detail->x86.addr_size = inter->addressSize;
1269
1270
467k
  pub->detail->x86.modrm = inter->orgModRM;
1271
467k
  pub->detail->x86.encoding.modrm_offset = inter->modRMOffset;
1272
1273
467k
  pub->detail->x86.sib = inter->sib;
1274
467k
  pub->detail->x86.sib_index = x86_map_sib_index(inter->sibIndex);
1275
467k
  pub->detail->x86.sib_scale = inter->sibScale;
1276
467k
  pub->detail->x86.sib_base = x86_map_sib_base(inter->sibBase);
1277
1278
467k
  pub->detail->x86.disp = inter->displacement;
1279
467k
  if (inter->consumedDisplacement) {
1280
66.3k
    pub->detail->x86.encoding.disp_offset =
1281
66.3k
      inter->displacementOffset;
1282
66.3k
    pub->detail->x86.encoding.disp_size = inter->displacementSize;
1283
66.3k
  }
1284
1285
467k
  pub->detail->x86.encoding.imm_offset = inter->immediateOffset;
1286
467k
  if (pub->detail->x86.encoding.imm_size == 0 &&
1287
467k
      inter->immediateOffset != 0)
1288
117k
    pub->detail->x86.encoding.imm_size = inter->immediateSize;
1289
467k
}
1290
1291
void X86_init(MCRegisterInfo *MRI)
1292
6.66k
{
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
6.66k
  MCRegisterInfo_InitMCRegisterInfo(MRI, X86RegDesc, 277, 0, 0,
1311
6.66k
            X86MCRegisterClasses, 86, 0, 0,
1312
6.66k
            X86RegDiffLists, 0, X86SubRegIdxLists,
1313
6.66k
            9, 0);
1314
6.66k
}
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
470k
{
1321
470k
  cs_struct *handle = (cs_struct *)(uintptr_t)ud;
1322
470k
  InternalInstruction insn = { 0 };
1323
470k
  struct reader_info info;
1324
470k
  int ret;
1325
470k
  bool result;
1326
1327
470k
  info.code = code;
1328
470k
  info.size = code_len;
1329
470k
  info.offset = address;
1330
1331
470k
  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
470k
    memset(instr->flat_insn->detail, 0,
1341
470k
           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
470k
  }
1349
1350
470k
  if (handle->mode & CS_MODE_16)
1351
167k
    ret = decodeInstruction(&insn, reader, &info, address,
1352
167k
          MODE_16BIT);
1353
303k
  else if (handle->mode & CS_MODE_32)
1354
127k
    ret = decodeInstruction(&insn, reader, &info, address,
1355
127k
          MODE_32BIT);
1356
176k
  else
1357
176k
    ret = decodeInstruction(&insn, reader, &info, address,
1358
176k
          MODE_64BIT);
1359
1360
470k
  if (ret) {
1361
    // *size = (uint16_t)(insn.readerCursor - address);
1362
3.26k
    return false;
1363
467k
  } else {
1364
467k
    *size = (uint16_t)insn.length;
1365
1366
467k
    result = (!translateInstruction(instr, &insn)) ? true : false;
1367
467k
    if (result) {
1368
467k
      unsigned Flags = X86_IP_NO_PREFIX;
1369
467k
      instr->imm_size = insn.immSize;
1370
1371
      // copy all prefixes
1372
467k
      instr->x86_prefix[0] = insn.prefix0;
1373
467k
      instr->x86_prefix[1] = insn.prefix1;
1374
467k
      instr->x86_prefix[2] = insn.prefix2;
1375
467k
      instr->x86_prefix[3] = insn.prefix3;
1376
467k
      instr->xAcquireRelease = insn.xAcquireRelease;
1377
1378
467k
      if (handle->detail_opt) {
1379
467k
        update_pub_insn(instr->flat_insn, &insn);
1380
467k
      }
1381
1382
467k
      if (insn.hasAdSize)
1383
3.26k
        Flags |= X86_IP_HAS_AD_SIZE;
1384
1385
467k
      if (!insn.mandatoryPrefix) {
1386
460k
        if (insn.hasOpSize)
1387
7.26k
          Flags |= X86_IP_HAS_OP_SIZE;
1388
1389
460k
        if (insn.repeatPrefix == 0xf2)
1390
13.5k
          Flags |= X86_IP_HAS_REPEAT_NE;
1391
446k
        else if (insn.repeatPrefix == 0xf3 &&
1392
           // It should not be 'pause' f3 90
1393
446k
           insn.opcode != 0x90)
1394
11.3k
          Flags |= X86_IP_HAS_REPEAT;
1395
460k
        if (insn.hasLockPrefix)
1396
17.5k
          Flags |= X86_IP_HAS_LOCK;
1397
460k
      }
1398
1399
467k
      instr->flags = Flags;
1400
467k
    }
1401
1402
467k
    return result;
1403
467k
  }
1404
470k
}
1405
1406
#endif