Coverage Report

Created: 2026-08-31 06:58

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonenext/arch/Xtensa/XtensaMapping.c
Line
Count
Source
1
/* Capstone Disassembly Engine */
2
/* By billow <billow.fun@gmail.com>, 2024 */
3
4
#include <capstone/xtensa.h>
5
6
#include "../../MCRegisterInfo.h"
7
#include "../../MCInst.h"
8
#include "../../SStream.h"
9
#include "../../Mapping.h"
10
#include "../../utils.h"
11
#include "../../cs_simple_types.h"
12
#include "XtensaDisassembler.h"
13
#include "XtensaInstPrinter.h"
14
#include "priv.h"
15
#include "XtensaMapping.h"
16
17
#ifndef CAPSTONE_DIET
18
19
static const char *const insn_name_maps[] = {
20
#include "XtensaGenCSMappingInsnName.inc"
21
};
22
23
static const name_map group_name_maps[] = {
24
#include "XtensaGenCSFeatureName.inc"
25
};
26
27
static const insn_map mapping_insns[] = {
28
#include "XtensaGenCSMappingInsn.inc"
29
};
30
31
static const map_insn_ops insn_operands[] = {
32
#include "XtensaGenCSMappingInsnOp.inc"
33
};
34
35
#endif
36
37
#define GET_REGINFO_MC_DESC
38
#include "XtensaGenRegisterInfo.inc"
39
#include "../../MathExtras.h"
40
41
void Xtensa_init_mri(MCRegisterInfo *mri)
42
1.27k
{
43
1.27k
  MCRegisterInfo_InitMCRegisterInfo(
44
1.27k
    mri, XtensaRegDesc, ARR_SIZE(XtensaRegDesc), 0, 0,
45
1.27k
    XtensaMCRegisterClasses, ARR_SIZE(XtensaMCRegisterClasses), 0,
46
1.27k
    0, XtensaRegDiffLists, NULL, XtensaSubRegIdxLists,
47
1.27k
    ARR_SIZE(XtensaSubRegIdxLists), XtensaRegEncodingTable);
48
1.27k
}
49
50
void Xtensa_printer(MCInst *MI, SStream *OS, void *info)
51
64.4k
{
52
64.4k
  Xtensa_LLVM_printInstruction(MI, MI->address, OS);
53
64.4k
}
54
55
static void set_instr_map_data(MCInst *MI)
56
64.4k
{
57
64.4k
#ifndef CAPSTONE_DIET
58
64.4k
  map_cs_id(MI, mapping_insns, ARR_SIZE(mapping_insns));
59
64.4k
  map_implicit_reads(MI, mapping_insns);
60
64.4k
  map_implicit_writes(MI, mapping_insns);
61
64.4k
  map_groups(MI, mapping_insns);
62
63
64.4k
  const xtensa_suppl_info *suppl_info =
64
64.4k
    map_get_suppl_info(MI, mapping_insns);
65
64.4k
  if (suppl_info) {
66
64.4k
    Xtensa_get_detail(MI)->format = suppl_info->form;
67
64.4k
  }
68
64.4k
#endif
69
64.4k
}
70
71
void Xtensa_init_cs_detail(MCInst *MI)
72
65.2k
{
73
65.2k
  if (detail_is_set(MI)) {
74
65.2k
    memset(get_detail(MI), 0,
75
65.2k
           offsetof(cs_detail, xtensa) + sizeof(cs_xtensa));
76
65.2k
  }
77
65.2k
}
78
79
bool Xtensa_disasm(csh handle, const uint8_t *code, size_t code_len,
80
       MCInst *instr, uint16_t *size, uint64_t address, void *info)
81
65.2k
{
82
65.2k
  if (detail_is_set(instr)) {
83
65.2k
    Xtensa_init_cs_detail(instr);
84
65.2k
  }
85
65.2k
  DecodeStatus res = Xtensa_LLVM_getInstruction(instr, size, code,
86
65.2k
                  code_len, address);
87
65.2k
  if (res != MCDisassembler_Fail) {
88
64.4k
    set_instr_map_data(instr);
89
64.4k
  }
90
65.2k
  if (res == MCDisassembler_SoftFail) {
91
0
    MCInst_setSoftFail(instr);
92
0
  }
93
65.2k
  return res != MCDisassembler_Fail;
94
65.2k
}
95
96
const char *Xtensa_reg_name(csh handle, unsigned int id)
97
14.7k
{
98
14.7k
  return Xtensa_LLVM_getRegisterName(id);
99
14.7k
}
100
101
void Xtensa_insn_id(cs_struct *h, cs_insn *insn, unsigned int id)
102
64.4k
{
103
  // Done in Xtensa_disasm
104
64.4k
}
105
106
const char *Xtensa_insn_name(csh handle, unsigned int id)
107
64.4k
{
108
64.4k
#ifndef CAPSTONE_DIET
109
64.4k
  if (id >= ARR_SIZE(insn_name_maps)) {
110
0
    return NULL;
111
0
  }
112
64.4k
  return insn_name_maps[id];
113
#else
114
  return NULL;
115
#endif
116
64.4k
}
117
118
const char *Xtensa_group_name(csh handle, unsigned int id)
119
48.8k
{
120
48.8k
#ifndef CAPSTONE_DIET
121
48.8k
  return id2name(group_name_maps, ARR_SIZE(group_name_maps), id);
122
#else
123
  return NULL;
124
#endif
125
48.8k
}
126
127
#ifndef CAPSTONE_DIET
128
void Xtensa_reg_access(const cs_insn *insn, cs_regs regs_read,
129
           uint8_t *regs_read_count, cs_regs regs_write,
130
           uint8_t *regs_write_count)
131
0
{
132
0
  uint8_t i;
133
0
  uint8_t read_count, write_count;
134
0
  cs_xtensa *detail = &(insn->detail->xtensa);
135
136
0
  read_count = insn->detail->regs_read_count;
137
0
  write_count = insn->detail->regs_write_count;
138
139
  // implicit registers
140
0
  memcpy(regs_read, insn->detail->regs_read,
141
0
         read_count * sizeof(insn->detail->regs_read[0]));
142
0
  memcpy(regs_write, insn->detail->regs_write,
143
0
         write_count * sizeof(insn->detail->regs_write[0]));
144
145
  // explicit registers
146
0
  for (i = 0; i < detail->op_count; i++) {
147
0
    cs_xtensa_op *op = &(detail->operands[i]);
148
0
    switch (op->type) {
149
0
    case XTENSA_OP_REG:
150
0
      if ((op->access & CS_AC_READ) &&
151
0
          !arr_exist(regs_read, read_count, op->reg)) {
152
0
        regs_read[read_count] = (uint16_t)op->reg;
153
0
        read_count++;
154
0
      }
155
0
      if ((op->access & CS_AC_WRITE) &&
156
0
          !arr_exist(regs_write, write_count, op->reg)) {
157
0
        regs_write[write_count] = (uint16_t)op->reg;
158
0
        write_count++;
159
0
      }
160
0
      break;
161
0
    case XTENSA_OP_MEM:
162
      // registers appeared in memory references always being read
163
0
      if ((op->mem.base != XTENSA_REG_INVALID) &&
164
0
          !arr_exist(regs_read, read_count, op->mem.base)) {
165
0
        regs_read[read_count] = (uint16_t)op->mem.base;
166
0
        read_count++;
167
0
      }
168
0
      if ((insn->detail->writeback) &&
169
0
          (op->mem.base != XTENSA_REG_INVALID) &&
170
0
          !arr_exist(regs_write, write_count, op->mem.base)) {
171
0
        regs_write[write_count] =
172
0
          (uint16_t)op->mem.base;
173
0
        write_count++;
174
0
      }
175
0
    default:
176
0
      break;
177
0
    }
178
0
  }
179
180
0
  *regs_read_count = read_count;
181
0
  *regs_write_count = write_count;
182
0
}
183
#endif
184
185
int64_t Xtensa_L32R_Value(MCInst *MI, int op_num)
186
7.43k
{
187
7.43k
  int64_t InstrOff = MCOperand_getImm(MCInst_getOperand(MI, (op_num)));
188
7.43k
  CS_ASSERT((InstrOff >= -262144 && InstrOff <= -4) &&
189
7.43k
      "Invalid argument, value must be in ranges [-262144,-4]");
190
7.43k
  int64_t Value = 0;
191
7.43k
  if (MI->csh->LITBASE & 0x1) {
192
0
    Value = (MI->csh->LITBASE & 0xfffff000) + InstrOff;
193
7.43k
  } else {
194
7.43k
    Value = (((int64_t)MI->address + 3) & ~0x3) + InstrOff;
195
7.43k
  }
196
7.43k
  return Value;
197
7.43k
}
198
199
void Xtensa_add_cs_detail_0(MCInst *MI, xtensa_op_group op_group, int op_num)
200
152k
{
201
152k
  if (!detail_is_set(MI)) {
202
0
    return;
203
0
  }
204
205
152k
  cs_xtensa_op *xop = Xtensa_get_detail_op(MI, 0);
206
152k
  if (!xop) {
207
0
    return;
208
0
  }
209
210
152k
  switch (op_group) {
211
101k
  case Xtensa_OP_GROUP_Operand: {
212
101k
    const MCOperand *MC = MCInst_getOperand(MI, op_num);
213
101k
    if (MCOperand_isReg(MC)) {
214
101k
      xop->type = XTENSA_OP_REG;
215
101k
      xop->reg = MC->RegVal;
216
101k
    } else if (MCOperand_isImm(MC)) {
217
0
      xop->type = XTENSA_OP_IMM;
218
0
      xop->imm = MC->ImmVal;
219
0
    }
220
101k
  } break;
221
777
  case Xtensa_OP_GROUP_Imm1_16_AsmOperand:
222
5.33k
  case Xtensa_OP_GROUP_Imm1n_15_AsmOperand:
223
5.49k
  case Xtensa_OP_GROUP_Imm7_22_AsmOperand:
224
5.83k
  case Xtensa_OP_GROUP_Imm8_AsmOperand:
225
6.09k
  case Xtensa_OP_GROUP_Imm8_sh8_AsmOperand:
226
6.22k
  case Xtensa_OP_GROUP_Imm8n_7_AsmOperand:
227
6.22k
  case Xtensa_OP_GROUP_Imm12_AsmOperand:
228
6.60k
  case Xtensa_OP_GROUP_Imm12m_AsmOperand:
229
8.47k
  case Xtensa_OP_GROUP_Imm32n_95_AsmOperand:
230
8.58k
  case Xtensa_OP_GROUP_Imm64n_4n_AsmOperand:
231
8.58k
  case Xtensa_OP_GROUP_ImmOperand_minus32_28_4:
232
11.0k
  case Xtensa_OP_GROUP_Uimm5_AsmOperand:
233
14.1k
  case Xtensa_OP_GROUP_Uimm4_AsmOperand:
234
14.8k
  case Xtensa_OP_GROUP_Shimm0_31_AsmOperand:
235
14.8k
  case Xtensa_OP_GROUP_Shimm1_31_AsmOperand:
236
18.2k
  case Xtensa_OP_GROUP_B4const_AsmOperand:
237
22.0k
  case Xtensa_OP_GROUP_B4constu_AsmOperand:
238
22.0k
  case Xtensa_OP_GROUP_ImmOperand_minus16_14_2:
239
22.0k
  case Xtensa_OP_GROUP_ImmOperand_minus64_56_8:
240
22.0k
  case Xtensa_OP_GROUP_ImmOperand_0_56_8:
241
22.0k
  case Xtensa_OP_GROUP_ImmOperand_minus16_47_1:
242
22.0k
  case Xtensa_OP_GROUP_ImmOperand_0_3_1:
243
22.0k
  case Xtensa_OP_GROUP_ImmOperand_0_63_1:
244
22.2k
  case Xtensa_OP_GROUP_Entry_Imm12_AsmOperand:
245
23.0k
  case Xtensa_OP_GROUP_Offset8m32_AsmOperand:
246
23.0k
  case Xtensa_OP_GROUP_Select_4_AsmOperand:
247
23.0k
  case Xtensa_OP_GROUP_Select_2_AsmOperand:
248
23.0k
  case Xtensa_OP_GROUP_Select_8_AsmOperand:
249
23.0k
  case Xtensa_OP_GROUP_Offset_16_16_AsmOperand:
250
23.0k
  case Xtensa_OP_GROUP_Offset_256_8_AsmOperand:
251
23.0k
  case Xtensa_OP_GROUP_Offset_256_16_AsmOperand:
252
23.0k
  case Xtensa_OP_GROUP_Offset_256_4_AsmOperand:
253
23.0k
  case Xtensa_OP_GROUP_Select_16_AsmOperand:
254
23.0k
  case Xtensa_OP_GROUP_Offset_128_2_AsmOperand:
255
23.0k
  case Xtensa_OP_GROUP_Offset_128_1_AsmOperand:
256
23.0k
  case Xtensa_OP_GROUP_Offset_64_16_AsmOperand:
257
23.1k
  case Xtensa_OP_GROUP_Select_256_AsmOperand: {
258
23.1k
    int64_t val = MCOperand_getImm(MCInst_getOperand(MI, op_num));
259
23.1k
    xop->type = XTENSA_OP_IMM;
260
23.1k
    xop->imm = (int32_t)val;
261
23.1k
  } break;
262
11.2k
  case Xtensa_OP_GROUP_BranchTarget:
263
12.2k
  case Xtensa_OP_GROUP_JumpTarget:
264
14.7k
  case Xtensa_OP_GROUP_CallOperand:
265
15.0k
  case Xtensa_OP_GROUP_LoopTarget: {
266
15.0k
    int64_t val =
267
15.0k
      MCOperand_getImm(MCInst_getOperand(MI, op_num)) + 4;
268
15.0k
    xop->type = XTENSA_OP_IMM;
269
15.0k
    xop->imm = (int32_t)val;
270
15.0k
  } break;
271
3.71k
  case Xtensa_OP_GROUP_L32RTarget: {
272
3.71k
    xop->type = XTENSA_OP_L32R;
273
3.71k
    xop->imm = (int32_t)Xtensa_L32R_Value(MI, op_num);
274
3.71k
  } break;
275
9.32k
  case Xtensa_OP_GROUP_MemOperand: {
276
9.32k
    unsigned reg =
277
9.32k
      MCOperand_getReg(MCInst_getOperand(MI, (op_num)));
278
9.32k
    int64_t imm8 =
279
9.32k
      MCOperand_getImm(MCInst_getOperand(MI, op_num + 1));
280
9.32k
    xop->type = XTENSA_OP_MEM;
281
9.32k
    xop->mem.base = reg;
282
9.32k
    xop->mem.disp = (int32_t)imm8;
283
9.32k
  } break;
284
152k
  }
285
286
152k
  xop->access = map_get_op_access(MI, op_num);
287
152k
  Xtensa_inc_op_count(MI);
288
152k
}