Coverage Report

Created: 2025-12-05 06:11

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