Coverage Report

Created: 2026-03-11 06:06

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