/src/capstonenext/arch/X86/X86ATTInstPrinter.c

Source
//===-- X86ATTInstPrinter.cpp - AT&T assembly instruction printing --------===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file includes code for rendering MCInst instances as AT&T-style
// assembly.
//
//===----------------------------------------------------------------------===//

/* Capstone Disassembly Engine */
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2019 */

// this code is only relevant when DIET mode is disable
#if defined(CAPSTONE_HAS_X86) && !defined(CAPSTONE_DIET) && \
  !defined(CAPSTONE_X86_ATT_DISABLE)

#ifdef _MSC_VER
// disable MSVC's warning on strncpy()
#pragma warning(disable : 4996)
// disable MSVC's warning on strncpy()
#pragma warning(disable : 28719)
#endif

#if !defined(CAPSTONE_HAS_OSXKERNEL)
#include <ctype.h>
#endif
#include <capstone/platform.h>

#if defined(CAPSTONE_HAS_OSXKERNEL)
#include <Availability.h>
#include <libkern/libkern.h>
#else
#include <stdio.h>
#include <stdlib.h>
#endif

#include <string.h>

#include "../../utils.h"
#include "../../MCInst.h"
#include "../../SStream.h"
#include "../../MCRegisterInfo.h"
#include "X86Mapping.h"
#include "X86BaseInfo.h"
#include "X86InstPrinterCommon.h"

#define GET_INSTRINFO_ENUM
#ifdef CAPSTONE_X86_REDUCE
#include "X86GenInstrInfo_reduce.inc"
#else
#include "X86GenInstrInfo.inc"
#endif

#define GET_REGINFO_ENUM
#include "X86GenRegisterInfo.inc"

static void printMemReference(MCInst *MI, unsigned Op, SStream *O);
static void printOperand(MCInst *MI, unsigned OpNo, SStream *O);

static void set_mem_access(MCInst *MI, bool status)
{
  if (MI->csh->detail_opt != CS_OPT_ON)
    return;

  MI->csh->doing_mem = status;
  if (!status)
    // done, create the next operand slot
    MI->flat_insn->detail->x86.op_count++;
}

static void printopaquemem(MCInst *MI, unsigned OpNo, SStream *O)
{
  switch (MI->csh->mode) {
  case CS_MODE_16:
    switch (MI->flat_insn->id) {
    default:
      MI->x86opsize = 2;
      break;
    case X86_INS_LJMP:
    case X86_INS_LCALL:
      MI->x86opsize = 4;
      break;
    case X86_INS_SGDT:
    case X86_INS_SIDT:
    case X86_INS_LGDT:
    case X86_INS_LIDT:
      MI->x86opsize = 6;
      break;
    }
    break;
  case CS_MODE_32:
    switch (MI->flat_insn->id) {
    default:
      MI->x86opsize = 4;
      break;
    case X86_INS_LJMP:
    case X86_INS_JMP:
    case X86_INS_LCALL:
    case X86_INS_SGDT:
    case X86_INS_SIDT:
    case X86_INS_LGDT:
    case X86_INS_LIDT:
      MI->x86opsize = 6;
      break;
    }
    break;
  case CS_MODE_64:
    switch (MI->flat_insn->id) {
    default:
      MI->x86opsize = 8;
      break;
    case X86_INS_LJMP:
    case X86_INS_LCALL:
    case X86_INS_SGDT:
    case X86_INS_SIDT:
    case X86_INS_LGDT:
    case X86_INS_LIDT:
      MI->x86opsize = 10;
      break;
    }
    break;
  default: // never reach
    break;
  }

  printMemReference(MI, OpNo, O);
}

static void printi8mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 1;
  printMemReference(MI, OpNo, O);
}

static void printi16mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 2;

  printMemReference(MI, OpNo, O);
}

static void printi32mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 4;

  printMemReference(MI, OpNo, O);
}

static void printi64mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 8;
  printMemReference(MI, OpNo, O);
}

static void printi128mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 16;
  printMemReference(MI, OpNo, O);
}

static void printi512mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 64;
  printMemReference(MI, OpNo, O);
}

#ifndef CAPSTONE_X86_REDUCE
static void printi256mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 32;
  printMemReference(MI, OpNo, O);
}

static void printf32mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  switch (MCInst_getOpcode(MI)) {
  default:
    MI->x86opsize = 4;
    break;
  case X86_FSTENVm:
  case X86_FLDENVm:
    // TODO: fix this in tablegen instead
    switch (MI->csh->mode) {
    default: // never reach
      break;
    case CS_MODE_16:
      MI->x86opsize = 14;
      break;
    case CS_MODE_32:
    case CS_MODE_64:
      MI->x86opsize = 28;
      break;
    }
    break;
  }

  printMemReference(MI, OpNo, O);
}

static void printf64mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 8;
  printMemReference(MI, OpNo, O);
}

static void printf80mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 10;
  printMemReference(MI, OpNo, O);
}

static void printf128mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 16;
  printMemReference(MI, OpNo, O);
}

static void printf256mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 32;
  printMemReference(MI, OpNo, O);
}

static void printf512mem(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 64;
  printMemReference(MI, OpNo, O);
}

#endif

static void printRegName(SStream *OS, unsigned RegNo);

// local printOperand, without updating public operands
static void _printOperand(MCInst *MI, unsigned OpNo, SStream *O)
{
  MCOperand *Op = MCInst_getOperand(MI, OpNo);
  if (MCOperand_isReg(Op)) {
    printRegName(O, MCOperand_getReg(Op));
  } else if (MCOperand_isImm(Op)) {
    uint8_t encsize;
    uint8_t opsize =
      X86_immediate_size(MCInst_getOpcode(MI), &encsize);

    // Print X86 immediates as signed values.
    int64_t imm = MCOperand_getImm(Op);
    if (imm < 0) {
      if (MI->csh->imm_unsigned) {
        if (opsize) {
          switch (opsize) {
          default:
            break;
          case 1:
            imm &= 0xff;
            break;
          case 2:
            imm &= 0xffff;
            break;
          case 4:
            imm &= 0xffffffff;
            break;
          }
        }

        SStream_concat(O, "$0x%" PRIx64, imm);
      } else {
        if (imm < -HEX_THRESHOLD)
          SStream_concat(O, "$-0x%" PRIx64, -imm);
        else
          SStream_concat(O, "$-%" PRIu64, -imm);
      }
    } else {
      if (imm > HEX_THRESHOLD)
        SStream_concat(O, "$0x%" PRIx64, imm);
      else
        SStream_concat(O, "$%" PRIu64, imm);
    }
  }
}

// convert Intel access info to AT&T access info
static void get_op_access(cs_struct *h, unsigned int id, uint8_t *access,
        uint64_t *eflags)
{
  uint8_t count, i;
  const uint8_t *arr = X86_get_op_access(h, id, eflags);

  // initialize access
  memset(access, 0, CS_X86_MAXIMUM_OPERAND_SIZE * sizeof(access[0]));
  if (!arr) {
    return;
  }

  // find the non-zero last entry
  for (count = 0; arr[count]; count++)
    ;

  if (count == 0)
    return;

  // copy in reverse order this access array from Intel syntax -> AT&T syntax
  count--;
  for (i = 0; i <= count && ((count - i) < CS_X86_MAXIMUM_OPERAND_SIZE) &&
        i < CS_X86_MAXIMUM_OPERAND_SIZE;
       i++) {
    if (arr[count - i] != CS_AC_IGNORE)
      access[i] = arr[count - i];
    else
      access[i] = 0;
  }
}

static void printSrcIdx(MCInst *MI, unsigned Op, SStream *O)
{
  MCOperand *SegReg;
  int reg;

  if (MI->csh->detail_opt) {
    uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE];

    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .type = X86_OP_MEM;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .size = MI->x86opsize;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.segment = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.base = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.index = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.scale = 1;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.disp = 0;

    get_op_access(MI->csh, MCInst_getOpcode(MI), access,
            &MI->flat_insn->detail->x86.eflags);
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .access = access[MI->flat_insn->detail->x86.op_count];
  }

  SegReg = MCInst_getOperand(MI, Op + 1);
  reg = MCOperand_getReg(SegReg);
  // If this has a segment register, print it.
  if (reg) {
    _printOperand(MI, Op + 1, O);
    SStream_concat0(O, ":");

    if (MI->csh->detail_opt) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.segment = X86_register_map(reg);
    }
  }

  SStream_concat0(O, "(");
  set_mem_access(MI, true);

  printOperand(MI, Op, O);

  SStream_concat0(O, ")");
  set_mem_access(MI, false);
}

static void printDstIdx(MCInst *MI, unsigned Op, SStream *O)
{
  if (MI->csh->detail_opt) {
    uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE];

    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .type = X86_OP_MEM;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .size = MI->x86opsize;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.segment = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.base = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.index = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.scale = 1;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.disp = 0;

    get_op_access(MI->csh, MCInst_getOpcode(MI), access,
            &MI->flat_insn->detail->x86.eflags);
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .access = access[MI->flat_insn->detail->x86.op_count];
  }

  // DI accesses are always ES-based on non-64bit mode
  if (MI->csh->mode != CS_MODE_64) {
    SStream_concat0(O, "%es:(");
    if (MI->csh->detail_opt) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.segment = X86_REG_ES;
    }
  } else
    SStream_concat0(O, "(");

  set_mem_access(MI, true);

  printOperand(MI, Op, O);

  SStream_concat0(O, ")");
  set_mem_access(MI, false);
}

static void printSrcIdx8(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 1;
  printSrcIdx(MI, OpNo, O);
}

static void printSrcIdx16(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 2;
  printSrcIdx(MI, OpNo, O);
}

static void printSrcIdx32(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 4;
  printSrcIdx(MI, OpNo, O);
}

static void printSrcIdx64(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 8;
  printSrcIdx(MI, OpNo, O);
}

static void printDstIdx8(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 1;
  printDstIdx(MI, OpNo, O);
}

static void printDstIdx16(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 2;
  printDstIdx(MI, OpNo, O);
}

static void printDstIdx32(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 4;
  printDstIdx(MI, OpNo, O);
}

static void printDstIdx64(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 8;
  printDstIdx(MI, OpNo, O);
}

static void printMemOffset(MCInst *MI, unsigned Op, SStream *O)
{
  MCOperand *DispSpec = MCInst_getOperand(MI, Op);
  MCOperand *SegReg = MCInst_getOperand(MI, Op + 1);
  int reg;

  if (MI->csh->detail_opt) {
    uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE];

    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .type = X86_OP_MEM;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .size = MI->x86opsize;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.segment = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.base = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.index = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.scale = 1;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.disp = 0;

    get_op_access(MI->csh, MCInst_getOpcode(MI), access,
            &MI->flat_insn->detail->x86.eflags);
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .access = access[MI->flat_insn->detail->x86.op_count];
  }

  // If this has a segment register, print it.
  reg = MCOperand_getReg(SegReg);
  if (reg) {
    _printOperand(MI, Op + 1, O);
    SStream_concat0(O, ":");

    if (MI->csh->detail_opt) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.segment = X86_register_map(reg);
    }
  }

  if (MCOperand_isImm(DispSpec)) {
    int64_t imm = MCOperand_getImm(DispSpec);
    if (MI->csh->detail_opt)
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.disp = imm;
    if (imm < 0) {
      SStream_concat(O, "0x%" PRIx64,
               arch_masks[MI->csh->mode] & imm);
    } else {
      if (imm > HEX_THRESHOLD)
        SStream_concat(O, "0x%" PRIx64, imm);
      else
        SStream_concat(O, "%" PRIu64, imm);
    }
  }

  if (MI->csh->detail_opt)
    MI->flat_insn->detail->x86.op_count++;
}

static void printU8Imm(MCInst *MI, unsigned Op, SStream *O)
{
  uint8_t val = MCOperand_getImm(MCInst_getOperand(MI, Op)) & 0xff;

  if (val > HEX_THRESHOLD)
    SStream_concat(O, "$0x%x", val);
  else
    SStream_concat(O, "$%" PRIu8, val);

  if (MI->csh->detail_opt) {
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .type = X86_OP_IMM;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .imm = val;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .size = 1;
    MI->flat_insn->detail->x86.op_count++;
  }
}

static void printMemOffs8(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 1;
  printMemOffset(MI, OpNo, O);
}

static void printMemOffs16(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 2;
  printMemOffset(MI, OpNo, O);
}

static void printMemOffs32(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 4;
  printMemOffset(MI, OpNo, O);
}

static void printMemOffs64(MCInst *MI, unsigned OpNo, SStream *O)
{
  MI->x86opsize = 8;
  printMemOffset(MI, OpNo, O);
}

/// printPCRelImm - This is used to print an immediate value that ends up
/// being encoded as a pc-relative value (e.g. for jumps and calls).  These
/// print slightly differently than normal immediates.  For example, a $ is not
/// emitted.
static void printPCRelImm(MCInst *MI, unsigned OpNo, SStream *O)
{
  MCOperand *Op = MCInst_getOperand(MI, OpNo);
  if (MCOperand_isImm(Op)) {
    int64_t imm = MCOperand_getImm(Op) + MI->flat_insn->size +
            MI->address;

    // truncate imm for non-64bit
    if (MI->csh->mode != CS_MODE_64) {
      imm = imm & 0xffffffff;
    }

    if (imm < 0) {
      SStream_concat(O, "0x%" PRIx64, imm);
    } else {
      if (imm > HEX_THRESHOLD)
        SStream_concat(O, "0x%" PRIx64, imm);
      else
        SStream_concat(O, "%" PRIu64, imm);
    }
    if (MI->csh->detail_opt) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .type = X86_OP_IMM;
      MI->has_imm = true;
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .imm = imm;
      MI->flat_insn->detail->x86.op_count++;
    }
  }
}

static void printOperand(MCInst *MI, unsigned OpNo, SStream *O)
{
  MCOperand *Op = MCInst_getOperand(MI, OpNo);
  if (MCOperand_isReg(Op)) {
    unsigned int reg = MCOperand_getReg(Op);
    printRegName(O, reg);
    if (MI->csh->detail_opt) {
      if (MI->csh->doing_mem) {
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .mem.base = X86_register_map(reg);
      } else {
        uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE];

        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .type = X86_OP_REG;
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .reg = X86_register_map(reg);
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .size =
          MI->csh->regsize_map[X86_register_map(
            reg)];

        get_op_access(
          MI->csh, MCInst_getOpcode(MI), access,
          &MI->flat_insn->detail->x86.eflags);
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .access =
          access[MI->flat_insn->detail->x86
                   .op_count];

        MI->flat_insn->detail->x86.op_count++;
      }
    }
  } else if (MCOperand_isImm(Op)) {
    // Print X86 immediates as signed values.
    uint8_t encsize;
    int64_t imm = MCOperand_getImm(Op);
    uint8_t opsize =
      X86_immediate_size(MCInst_getOpcode(MI), &encsize);

    if (opsize == 1) { // print 1 byte immediate in positive form
      imm = imm & 0xff;
    }

    switch (MI->flat_insn->id) {
    default:
      if (imm >= 0) {
        if (imm > HEX_THRESHOLD)
          SStream_concat(O, "$0x%" PRIx64, imm);
        else
          SStream_concat(O, "$%" PRIu64, imm);
      } else {
        if (MI->csh->imm_unsigned) {
          if (opsize) {
            switch (opsize) {
            default:
              break;
            // case 1 cannot occur because above imm was ANDed with 0xff,
            // making it effectively always positive.
            // So this switch is never reached.
            case 2:
              imm &= 0xffff;
              break;
            case 4:
              imm &= 0xffffffff;
              break;
            }
          }

          SStream_concat(O, "$0x%" PRIx64, imm);
        } else {
          if (imm ==
              0x8000000000000000LL) // imm == -imm
            SStream_concat0(
              O,
              "$0x8000000000000000");
          else if (imm < -HEX_THRESHOLD)
            SStream_concat(O,
                     "$-0x%" PRIx64,
                     -imm);
          else
            SStream_concat(O, "$-%" PRIu64,
                     -imm);
        }
      }
      break;

    case X86_INS_MOVABS:
    case X86_INS_MOV:
      // do not print number in negative form
      // Use unsigned comparison to handle values >= 2^63 correctly
      if ((uint64_t)imm > HEX_THRESHOLD)
        SStream_concat(O, "$0x%" PRIx64, imm);
      else
        SStream_concat(O, "$%" PRIu64, imm);
      break;

    case X86_INS_IN:
    case X86_INS_OUT:
    case X86_INS_INT:
      // do not print number in negative form
      imm = imm & 0xff;
      if (imm >= 0 && imm <= HEX_THRESHOLD)
        SStream_concat(O, "$%" PRIu64, imm);
      else {
        SStream_concat(O, "$0x%x", imm);
      }
      break;

    case X86_INS_LCALL:
    case X86_INS_LJMP:
    case X86_INS_JMP:
      // always print address in positive form
      if (OpNo == 1) { // selector is ptr16
        imm = imm & 0xffff;
        opsize = 2;
      } else
        opsize = 4;
      SStream_concat(O, "$0x%" PRIx64, imm);
      break;

    case X86_INS_AND:
    case X86_INS_OR:
    case X86_INS_XOR:
      // do not print number in negative form
      if (imm >= 0 && imm <= HEX_THRESHOLD)
        SStream_concat(O, "$%" PRIu64, imm);
      else {
        imm = arch_masks[opsize ? opsize : MI->imm_size] &
              imm;
        SStream_concat(O, "$0x%" PRIx64, imm);
      }
      break;

    case X86_INS_RET:
    case X86_INS_RETF:
      // RET imm16
      if (imm >= 0 && imm <= HEX_THRESHOLD)
        SStream_concat(O, "$%" PRIu64, imm);
      else {
        imm = 0xffff & imm;
        SStream_concat(O, "$0x%x", imm);
      }
      break;
    }

    if (MI->csh->detail_opt) {
      if (MI->csh->doing_mem) {
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .type = X86_OP_MEM;
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .mem.disp = imm;
      } else {
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .type = X86_OP_IMM;
        MI->has_imm = true;
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .imm = imm;

        if (opsize > 0) {
          MI->flat_insn->detail->x86
            .operands[MI->flat_insn->detail
                  ->x86.op_count]
            .size = opsize;
          MI->flat_insn->detail->x86.encoding
            .imm_size = encsize;
        } else if (MI->op1_size > 0)
          MI->flat_insn->detail->x86
            .operands[MI->flat_insn->detail
                  ->x86.op_count]
            .size = MI->op1_size;
        else
          MI->flat_insn->detail->x86
            .operands[MI->flat_insn->detail
                  ->x86.op_count]
            .size = MI->imm_size;

        MI->flat_insn->detail->x86.op_count++;
      }
    }
  }
}

static void printMemReference(MCInst *MI, unsigned Op, SStream *O)
{
  MCOperand *BaseReg = MCInst_getOperand(MI, Op + X86_AddrBaseReg);
  MCOperand *IndexReg = MCInst_getOperand(MI, Op + X86_AddrIndexReg);
  MCOperand *DispSpec = MCInst_getOperand(MI, Op + X86_AddrDisp);
  MCOperand *SegReg = MCInst_getOperand(MI, Op + X86_AddrSegmentReg);
  uint64_t ScaleVal;
  int segreg;
  int64_t DispVal = 1;

  if (MI->csh->detail_opt) {
    uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE];

    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .type = X86_OP_MEM;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .size = MI->x86opsize;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.segment = X86_REG_INVALID;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.base = X86_register_map(MCOperand_getReg(BaseReg));
    if (MCOperand_getReg(IndexReg) != X86_EIZ) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.index =
        X86_register_map(MCOperand_getReg(IndexReg));
    }
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.scale = 1;
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .mem.disp = 0;

    get_op_access(MI->csh, MCInst_getOpcode(MI), access,
            &MI->flat_insn->detail->x86.eflags);
    MI->flat_insn->detail->x86
      .operands[MI->flat_insn->detail->x86.op_count]
      .access = access[MI->flat_insn->detail->x86.op_count];
  }

  // If this has a segment register, print it.
  segreg = MCOperand_getReg(SegReg);
  if (segreg) {
    _printOperand(MI, Op + X86_AddrSegmentReg, O);
    SStream_concat0(O, ":");

    if (MI->csh->detail_opt) {
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.segment = X86_register_map(segreg);
    }
  }

  if (MCOperand_isImm(DispSpec)) {
    DispVal = MCOperand_getImm(DispSpec);
    if (MI->csh->detail_opt)
      MI->flat_insn->detail->x86
        .operands[MI->flat_insn->detail->x86.op_count]
        .mem.disp = DispVal;
    if (DispVal) {
      if (MCOperand_getReg(IndexReg) ||
          MCOperand_getReg(BaseReg)) {
        printInt64(O, DispVal);
      } else {
        // only immediate as address of memory
        if (DispVal < 0) {
          SStream_concat(
            O, "0x%" PRIx64,
            arch_masks[MI->csh->mode] &
              DispVal);
        } else {
          if (DispVal > HEX_THRESHOLD)
            SStream_concat(O, "0x%" PRIx64,
                     DispVal);
          else
            SStream_concat(O, "%" PRIu64,
                     DispVal);
        }
      }
    }
  }

  if (MCOperand_getReg(IndexReg) || MCOperand_getReg(BaseReg)) {
    SStream_concat0(O, "(");

    if (MCOperand_getReg(BaseReg))
      _printOperand(MI, Op + X86_AddrBaseReg, O);

    if (MCOperand_getReg(IndexReg) &&
        MCOperand_getReg(IndexReg) != X86_EIZ) {
      SStream_concat0(O, ", ");
      _printOperand(MI, Op + X86_AddrIndexReg, O);
      ScaleVal = MCOperand_getImm(
        MCInst_getOperand(MI, Op + X86_AddrScaleAmt));
      if (MI->csh->detail_opt)
        MI->flat_insn->detail->x86
          .operands[MI->flat_insn->detail->x86
                .op_count]
          .mem.scale = (int)ScaleVal;
      if (ScaleVal != 1) {
        SStream_concat(O, ", %" PRIu64, ScaleVal);
      }
    }

    SStream_concat0(O, ")");
  } else {
    if (!DispVal)
      SStream_concat0(O, "0");
  }

  if (MI->csh->detail_opt)
    MI->flat_insn->detail->x86.op_count++;
}

static void printanymem(MCInst *MI, unsigned OpNo, SStream *O)
{
  switch (MI->Opcode) {
  default:
    break;
  case X86_LEA16r:
    MI->x86opsize = 2;
    break;
  case X86_LEA32r:
  case X86_LEA64_32r:
    MI->x86opsize = 4;
    break;
  case X86_LEA64r:
    MI->x86opsize = 8;
    break;
#ifndef CAPSTONE_X86_REDUCE
  case X86_BNDCL32rm:
  case X86_BNDCN32rm:
  case X86_BNDCU32rm:
  case X86_BNDSTXmr:
  case X86_BNDLDXrm:
  case X86_BNDCL64rm:
  case X86_BNDCN64rm:
  case X86_BNDCU64rm:
    MI->x86opsize = 16;
    break;
#endif
  }

  printMemReference(MI, OpNo, O);
}

#include "X86InstPrinter.h"

// Include the auto-generated portion of the assembly writer.
#ifdef CAPSTONE_X86_REDUCE
#include "X86GenAsmWriter_reduce.inc"
#else
#include "X86GenAsmWriter.inc"
#endif

#include "X86GenRegisterName.inc"

static void printRegName(SStream *OS, unsigned RegNo)
{
  SStream_concat(OS, "%%%s", getRegisterName(RegNo));
}

void X86_ATT_printInst(MCInst *MI, SStream *OS, void *info)
{
  x86_reg reg, reg2;
  enum cs_ac_type access1, access2;
  int i;

  // perhaps this instruction does not need printer
  if (MI->assembly[0]) {
    strncpy(OS->buffer, MI->assembly, sizeof(OS->buffer));
    return;
  }

  // Output CALLpcrel32 as "callq" in 64-bit mode.
  // In Intel annotation it's always emitted as "call".
  //
  // TODO: Probably this hack should be redesigned via InstAlias in
  // InstrInfo.td as soon as Requires clause is supported properly
  // for InstAlias.
  if (MI->csh->mode == CS_MODE_64 &&
      MCInst_getOpcode(MI) == X86_CALLpcrel32) {
    SStream_concat0(OS, "callq\t");
    MCInst_setOpcodePub(MI, X86_INS_CALL);
    printPCRelImm(MI, 0, OS);
    return;
  }

  X86_lockrep(MI, OS);
  printInstruction(MI, OS);

  if (MI->has_imm) {
    // if op_count > 1, then this operand's size is taken from the destination op
    if (MI->flat_insn->detail->x86.op_count > 1) {
      if (MI->flat_insn->id != X86_INS_LCALL &&
          MI->flat_insn->id != X86_INS_LJMP &&
          MI->flat_insn->id != X86_INS_JMP) {
        for (i = 0;
             i < MI->flat_insn->detail->x86.op_count;
             i++) {
          if (MI->flat_insn->detail->x86
                .operands[i]
                .type == X86_OP_IMM)
            MI->flat_insn->detail->x86
              .operands[i]
              .size =
              MI->flat_insn->detail
                ->x86
                .operands
                  [MI->flat_insn
                     ->detail
                     ->x86
                     .op_count -
                   1]
                .size;
        }
      }
    } else
      MI->flat_insn->detail->x86.operands[0].size =
        MI->imm_size;
  }

  if (MI->csh->detail_opt) {
    uint8_t access[CS_X86_MAXIMUM_OPERAND_SIZE] = { 0 };

    // some instructions need to supply immediate 1 in the first op
    switch (MCInst_getOpcode(MI)) {
    default:
      break;
    case X86_SHL8r1:
    case X86_SHL16r1:
    case X86_SHL32r1:
    case X86_SHL64r1:
    case X86_SAL8r1:
    case X86_SAL16r1:
    case X86_SAL32r1:
    case X86_SAL64r1:
    case X86_SHR8r1:
    case X86_SHR16r1:
    case X86_SHR32r1:
    case X86_SHR64r1:
    case X86_SAR8r1:
    case X86_SAR16r1:
    case X86_SAR32r1:
    case X86_SAR64r1:
    case X86_RCL8r1:
    case X86_RCL16r1:
    case X86_RCL32r1:
    case X86_RCL64r1:
    case X86_RCR8r1:
    case X86_RCR16r1:
    case X86_RCR32r1:
    case X86_RCR64r1:
    case X86_ROL8r1:
    case X86_ROL16r1:
    case X86_ROL32r1:
    case X86_ROL64r1:
    case X86_ROR8r1:
    case X86_ROR16r1:
    case X86_ROR32r1:
    case X86_ROR64r1:
    case X86_SHL8m1:
    case X86_SHL16m1:
    case X86_SHL32m1:
    case X86_SHL64m1:
    case X86_SAL8m1:
    case X86_SAL16m1:
    case X86_SAL32m1:
    case X86_SAL64m1:
    case X86_SHR8m1:
    case X86_SHR16m1:
    case X86_SHR32m1:
    case X86_SHR64m1:
    case X86_SAR8m1:
    case X86_SAR16m1:
    case X86_SAR32m1:
    case X86_SAR64m1:
    case X86_RCL8m1:
    case X86_RCL16m1:
    case X86_RCL32m1:
    case X86_RCL64m1:
    case X86_RCR8m1:
    case X86_RCR16m1:
    case X86_RCR32m1:
    case X86_RCR64m1:
    case X86_ROL8m1:
    case X86_ROL16m1:
    case X86_ROL32m1:
    case X86_ROL64m1:
    case X86_ROR8m1:
    case X86_ROR16m1:
    case X86_ROR32m1:
    case X86_ROR64m1:
      // shift all the ops right to leave 1st slot for this new register op
      memmove(&(MI->flat_insn->detail->x86.operands[1]),
        &(MI->flat_insn->detail->x86.operands[0]),
        sizeof(MI->flat_insn->detail->x86.operands[0]) *
          (ARR_SIZE(MI->flat_insn->detail->x86
                .operands) -
           1));
      MI->flat_insn->detail->x86.operands[0].type =
        X86_OP_IMM;
      MI->flat_insn->detail->x86.operands[0].imm = 1;
      MI->flat_insn->detail->x86.operands[0].size = 1;
      MI->flat_insn->detail->x86.op_count++;
    }

    // special instruction needs to supply register op
    // first op can be embedded in the asm by llvm.
    // so we have to add the missing register as the first operand

    //printf(">>> opcode = %u\n", MCInst_getOpcode(MI));

    reg = X86_insn_reg_att(MCInst_getOpcode(MI), &access1);
    if (reg) {
      // shift all the ops right to leave 1st slot for this new register op
      memmove(&(MI->flat_insn->detail->x86.operands[1]),
        &(MI->flat_insn->detail->x86.operands[0]),
        sizeof(MI->flat_insn->detail->x86.operands[0]) *
          (ARR_SIZE(MI->flat_insn->detail->x86
                .operands) -
           1));
      MI->flat_insn->detail->x86.operands[0].type =
        X86_OP_REG;
      MI->flat_insn->detail->x86.operands[0].reg = reg;
      MI->flat_insn->detail->x86.operands[0].size =
        MI->csh->regsize_map[reg];
      MI->flat_insn->detail->x86.operands[0].access = access1;

      MI->flat_insn->detail->x86.op_count++;
    } else {
      if (X86_insn_reg_att2(MCInst_getOpcode(MI), &reg,
                &access1, &reg2, &access2)) {
        MI->flat_insn->detail->x86.operands[0].type =
          X86_OP_REG;
        MI->flat_insn->detail->x86.operands[0].reg =
          reg;
        MI->flat_insn->detail->x86.operands[0].size =
          MI->csh->regsize_map[reg];
        MI->flat_insn->detail->x86.operands[0].access =
          access1;
        MI->flat_insn->detail->x86.operands[1].type =
          X86_OP_REG;
        MI->flat_insn->detail->x86.operands[1].reg =
          reg2;
        MI->flat_insn->detail->x86.operands[1].size =
          MI->csh->regsize_map[reg2];
        MI->flat_insn->detail->x86.operands[1].access =
          access2;
        MI->flat_insn->detail->x86.op_count = 2;
      }
    }

#ifndef CAPSTONE_DIET
    get_op_access(MI->csh, MCInst_getOpcode(MI), access,
            &MI->flat_insn->detail->x86.eflags);
    MI->flat_insn->detail->x86.operands[0].access = access[0];
    MI->flat_insn->detail->x86.operands[1].access = access[1];
#endif
  }
}

#endif

Coverage Report

Created: 2026-03-03 06:15