Coverage Report

Created: 2025-08-29 06:29

/src/capstonenext/arch/SystemZ/SystemZMapping.c
Line
Count
Source (jump to first uncovered line)
1
/* Capstone Disassembly Engine */
2
/* By Rot127 <unisono@quyllur.org> 2022-2023 */
3
4
#ifdef CAPSTONE_HAS_SYSTEMZ
5
6
#include <stdio.h> // debug
7
#include <string.h>
8
9
#include "../../Mapping.h"
10
#include "../../utils.h"
11
#include "../../cs_simple_types.h"
12
#include <capstone/cs_operand.h>
13
14
#include "SystemZMCTargetDesc.h"
15
#include "SystemZMapping.h"
16
#include "SystemZLinkage.h"
17
18
#ifndef CAPSTONE_DIET
19
20
static const char *const insn_name_maps[] = {
21
#include "SystemZGenCSMappingInsnName.inc"
22
};
23
24
static const name_map insn_alias_mnem_map[] = {
25
#include "SystemZGenCSAliasMnemMap.inc"
26
  { SYSTEMZ_INS_ALIAS_END, NULL },
27
};
28
29
static const map_insn_ops insn_operands[] = {
30
#include "SystemZGenCSMappingInsnOp.inc"
31
};
32
33
#endif
34
35
#define GET_REGINFO_MC_DESC
36
#include "SystemZGenRegisterInfo.inc"
37
38
const insn_map systemz_insns[] = {
39
#include "SystemZGenCSMappingInsn.inc"
40
};
41
42
void SystemZ_set_instr_map_data(MCInst *MI, const uint8_t *Bytes,
43
        size_t BytesLen)
44
88.3k
{
45
88.3k
  map_cs_id(MI, systemz_insns, ARR_SIZE(systemz_insns));
46
88.3k
  map_implicit_reads(MI, systemz_insns);
47
88.3k
  map_implicit_writes(MI, systemz_insns);
48
88.3k
  map_groups(MI, systemz_insns);
49
88.3k
  const systemz_suppl_info *suppl_info =
50
88.3k
    map_get_suppl_info(MI, systemz_insns);
51
88.3k
  if (suppl_info) {
52
88.3k
    SystemZ_get_detail(MI)->format = suppl_info->form;
53
88.3k
  }
54
88.3k
}
55
56
void SystemZ_init_mri(MCRegisterInfo *MRI)
57
2.42k
{
58
2.42k
  MCRegisterInfo_InitMCRegisterInfo(
59
2.42k
    MRI, SystemZRegDesc, AARCH64_REG_ENDING, 0, 0,
60
2.42k
    SystemZMCRegisterClasses, ARR_SIZE(SystemZMCRegisterClasses), 0,
61
2.42k
    0, SystemZRegDiffLists, 0, SystemZSubRegIdxLists,
62
2.42k
    ARR_SIZE(SystemZSubRegIdxLists), 0);
63
2.42k
}
64
65
const char *SystemZ_reg_name(csh handle, unsigned int reg)
66
53.6k
{
67
53.6k
  return SystemZ_LLVM_getRegisterName(reg);
68
53.6k
}
69
70
void SystemZ_printer(MCInst *MI, SStream *O, void * /* MCRegisterInfo* */ info)
71
86.8k
{
72
86.8k
  MI->MRI = (MCRegisterInfo *)info;
73
86.8k
  MI->fillDetailOps = detail_is_set(MI);
74
86.8k
  SystemZ_LLVM_printInstruction(MI, "", O);
75
86.8k
#ifndef CAPSTONE_DIET
76
86.8k
  map_set_alias_id(MI, O, insn_alias_mnem_map,
77
86.8k
       ARR_SIZE(insn_alias_mnem_map));
78
86.8k
#endif
79
86.8k
}
80
81
void SystemZ_init_cs_detail(MCInst *MI)
82
88.3k
{
83
88.3k
  if (!detail_is_set(MI)) {
84
0
    return;
85
0
  }
86
88.3k
  memset(get_detail(MI), 0, sizeof(cs_detail));
87
88.3k
  if (detail_is_set(MI)) {
88
88.3k
    SystemZ_get_detail(MI)->cc = SYSTEMZ_CC_INVALID;
89
88.3k
  }
90
88.3k
}
91
92
bool SystemZ_getInstruction(csh handle, const uint8_t *bytes, size_t bytes_len,
93
          MCInst *MI, uint16_t *size, uint64_t address,
94
          void *info)
95
88.3k
{
96
88.3k
  SystemZ_init_cs_detail(MI);
97
88.3k
  MI->MRI = (MCRegisterInfo *)info;
98
88.3k
  DecodeStatus Result = SystemZ_LLVM_getInstruction(
99
88.3k
    handle, bytes, bytes_len, MI, size, address, info);
100
88.3k
  SystemZ_set_instr_map_data(MI, bytes, bytes_len);
101
88.3k
  if (Result == MCDisassembler_SoftFail) {
102
0
    MCInst_setSoftFail(MI);
103
0
  }
104
88.3k
  return Result != MCDisassembler_Fail;
105
88.3k
}
106
107
// given internal insn id, return public instruction info
108
void SystemZ_get_insn_id(cs_struct *h, cs_insn *insn, unsigned int id)
109
86.8k
{
110
  // We do this after Instruction disassembly.
111
86.8k
}
112
113
const char *SystemZ_insn_name(csh handle, unsigned int id)
114
86.8k
{
115
86.8k
#ifndef CAPSTONE_DIET
116
86.8k
  if (id < SYSTEMZ_INS_ALIAS_END && id > SYSTEMZ_INS_ALIAS_BEGIN) {
117
0
    if (id - SYSTEMZ_INS_ALIAS_BEGIN >=
118
0
        ARR_SIZE(insn_alias_mnem_map))
119
0
      return NULL;
120
121
0
    return insn_alias_mnem_map[id - SYSTEMZ_INS_ALIAS_BEGIN - 1]
122
0
      .name;
123
0
  }
124
86.8k
  if (id >= SYSTEMZ_INS_ENDING)
125
0
    return NULL;
126
127
86.8k
  if (id < ARR_SIZE(insn_name_maps))
128
86.8k
    return insn_name_maps[id];
129
130
  // not found
131
0
  return NULL;
132
#else
133
  return NULL;
134
#endif
135
86.8k
}
136
137
#ifndef CAPSTONE_DIET
138
static const name_map group_name_maps[] = {
139
  // generic groups
140
  { SYSTEMZ_GRP_INVALID, NULL },
141
  { SYSTEMZ_GRP_JUMP, "jump" },
142
  { SYSTEMZ_GRP_CALL, "call" },
143
  { SYSTEMZ_GRP_RET, "return" },
144
  { SYSTEMZ_GRP_INT, "int" },
145
  { SYSTEMZ_GRP_IRET, "iret" },
146
  { SYSTEMZ_GRP_PRIVILEGE, "privilege" },
147
  { SYSTEMZ_GRP_BRANCH_RELATIVE, "branch_relative" },
148
149
#include "SystemZGenCSFeatureName.inc"
150
};
151
#endif
152
153
const char *SystemZ_group_name(csh handle, unsigned int id)
154
31.1k
{
155
31.1k
#ifndef CAPSTONE_DIET
156
31.1k
  return id2name(group_name_maps, ARR_SIZE(group_name_maps), id);
157
#else
158
  return NULL;
159
#endif
160
31.1k
}
161
162
void SystemZ_add_cs_detail(MCInst *MI, int /* aarch64_op_group */ op_group,
163
         va_list args)
164
206k
{
165
206k
#ifndef CAPSTONE_DIET
166
206k
  if (!detail_is_set(MI) || !map_fill_detail_ops(MI))
167
0
    return;
168
169
206k
  unsigned op_num = va_arg(args, unsigned);
170
171
206k
  switch (op_group) {
172
0
  default:
173
0
    printf("Operand group %d not handled\n", op_group);
174
0
    break;
175
122k
  case SystemZ_OP_GROUP_Operand: {
176
122k
    cs_op_type secondary_op_type = map_get_op_type(MI, op_num) &
177
122k
                 ~(CS_OP_MEM | CS_OP_BOUND);
178
122k
    if (secondary_op_type == CS_OP_IMM) {
179
0
      SystemZ_set_detail_op_imm(
180
0
        MI, op_num, MCInst_getOpVal(MI, op_num), 0);
181
122k
    } else if (secondary_op_type == CS_OP_REG) {
182
122k
      SystemZ_set_detail_op_reg(MI, op_num,
183
122k
              MCInst_getOpVal(MI, op_num));
184
122k
    } else {
185
0
      CS_ASSERT_RET(0 && "Op type not handled.");
186
0
    }
187
122k
    break;
188
0
  }
189
0
  case SystemZ_OP_GROUP_Cond4Operand: {
190
0
    systemz_cc cc = MCInst_getOpVal(MI, op_num);
191
0
    SystemZ_get_detail(MI)->cc = cc;
192
0
    break;
193
0
  }
194
24.8k
  case SystemZ_OP_GROUP_BDAddrOperand:
195
24.8k
    CS_ASSERT_RET(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
196
24.8k
    CS_ASSERT_RET(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
197
24.8k
    CS_ASSERT_RET(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
198
24.8k
    CS_ASSERT_RET(
199
24.8k
      MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
200
24.8k
    SystemZ_set_detail_op_mem(MI, op_num,
201
24.8k
            MCInst_getOpVal(MI, (op_num)),
202
24.8k
            MCInst_getOpVal(MI, (op_num + 1)), 0,
203
24.8k
            0, SYSTEMZ_AM_BD);
204
24.8k
    break;
205
549
  case SystemZ_OP_GROUP_BDVAddrOperand:
206
21.8k
  case SystemZ_OP_GROUP_BDXAddrOperand: {
207
21.8k
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
208
21.8k
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
209
21.8k
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
210
21.8k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
211
21.8k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
212
21.8k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num + 2))));
213
21.8k
    SystemZ_set_detail_op_mem(
214
21.8k
      MI, op_num, MCInst_getOpVal(MI, (op_num)),
215
21.8k
      MCInst_getOpVal(MI, (op_num + 1)), 0,
216
21.8k
      MCInst_getOpVal(MI, (op_num + 2)),
217
21.8k
      (op_group == SystemZ_OP_GROUP_BDXAddrOperand ?
218
21.3k
         SYSTEMZ_AM_BDX :
219
21.8k
         SYSTEMZ_AM_BDV));
220
21.8k
    break;
221
549
  }
222
6.72k
  case SystemZ_OP_GROUP_BDLAddrOperand:
223
6.72k
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
224
6.72k
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
225
6.72k
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
226
6.72k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
227
6.72k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
228
6.72k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 2))));
229
6.72k
    SystemZ_set_detail_op_mem(MI, op_num,
230
6.72k
            MCInst_getOpVal(MI, (op_num)),
231
6.72k
            MCInst_getOpVal(MI, (op_num + 1)),
232
6.72k
            MCInst_getOpVal(MI, (op_num + 2)), 0,
233
6.72k
            SYSTEMZ_AM_BDL);
234
6.72k
    break;
235
416
  case SystemZ_OP_GROUP_BDRAddrOperand:
236
416
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
237
416
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
238
416
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
239
416
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
240
416
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
241
416
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num + 2))));
242
416
    SystemZ_set_detail_op_mem(MI, op_num,
243
416
            MCInst_getOpVal(MI, (op_num)),
244
416
            MCInst_getOpVal(MI, (op_num + 1)),
245
416
            MCInst_getOpVal(MI, (op_num + 2)), 0,
246
416
            SYSTEMZ_AM_BDL);
247
416
    break;
248
3.36k
  case SystemZ_OP_GROUP_PCRelOperand:
249
3.36k
    SystemZ_set_detail_op_imm(MI, op_num,
250
3.36k
            MCInst_getOpVal(MI, op_num), 0);
251
3.36k
    break;
252
1.39k
  case SystemZ_OP_GROUP_U1ImmOperand:
253
1.39k
    SystemZ_set_detail_op_imm(MI, op_num,
254
1.39k
            MCInst_getOpVal(MI, op_num), 1);
255
1.39k
    break;
256
724
  case SystemZ_OP_GROUP_U2ImmOperand:
257
724
    SystemZ_set_detail_op_imm(MI, op_num,
258
724
            MCInst_getOpVal(MI, op_num), 2);
259
724
    break;
260
459
  case SystemZ_OP_GROUP_U3ImmOperand:
261
459
    SystemZ_set_detail_op_imm(MI, op_num,
262
459
            MCInst_getOpVal(MI, op_num), 3);
263
459
    break;
264
14.1k
  case SystemZ_OP_GROUP_U4ImmOperand:
265
14.1k
    SystemZ_set_detail_op_imm(MI, op_num,
266
14.1k
            MCInst_getOpVal(MI, op_num), 4);
267
14.1k
    break;
268
5.27k
  case SystemZ_OP_GROUP_U8ImmOperand:
269
5.96k
  case SystemZ_OP_GROUP_S8ImmOperand:
270
5.96k
    SystemZ_set_detail_op_imm(MI, op_num,
271
5.96k
            MCInst_getOpVal(MI, op_num), 8);
272
5.96k
    break;
273
119
  case SystemZ_OP_GROUP_U12ImmOperand:
274
119
    SystemZ_set_detail_op_imm(MI, op_num,
275
119
            MCInst_getOpVal(MI, op_num), 12);
276
119
    break;
277
1.27k
  case SystemZ_OP_GROUP_U16ImmOperand:
278
2.89k
  case SystemZ_OP_GROUP_S16ImmOperand:
279
2.89k
    SystemZ_set_detail_op_imm(MI, op_num,
280
2.89k
            MCInst_getOpVal(MI, op_num), 16);
281
2.89k
    break;
282
647
  case SystemZ_OP_GROUP_U32ImmOperand:
283
1.50k
  case SystemZ_OP_GROUP_S32ImmOperand:
284
1.50k
    SystemZ_set_detail_op_imm(MI, op_num,
285
1.50k
            MCInst_getOpVal(MI, op_num), 32);
286
1.50k
    break;
287
0
  case SystemZ_OP_GROUP_U48ImmOperand:
288
0
    SystemZ_set_detail_op_imm(MI, op_num,
289
0
            MCInst_getOpVal(MI, op_num), 48);
290
0
    break;
291
206k
  }
292
206k
#endif
293
206k
}
294
295
#ifndef CAPSTONE_DIET
296
297
void SystemZ_set_detail_op_imm(MCInst *MI, unsigned op_num, int64_t Imm,
298
             size_t width)
299
30.6k
{
300
30.6k
  if (!detail_is_set(MI))
301
0
    return;
302
30.6k
  CS_ASSERT((map_get_op_type(MI, op_num) & ~CS_OP_MEM) == CS_OP_IMM);
303
304
30.6k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_IMM;
305
30.6k
  SystemZ_get_detail_op(MI, 0)->imm = Imm;
306
30.6k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
307
30.6k
  SystemZ_get_detail_op(MI, 0)->imm_width = width;
308
30.6k
  SystemZ_inc_op_count(MI);
309
30.6k
}
310
311
void SystemZ_set_detail_op_reg(MCInst *MI, unsigned op_num, systemz_reg Reg)
312
122k
{
313
122k
  if (!detail_is_set(MI))
314
0
    return;
315
122k
  CS_ASSERT((map_get_op_type(MI, op_num) & ~CS_OP_MEM) == CS_OP_REG);
316
122k
  if (Reg == SYSTEMZ_REG_INVALID) {
317
    // This case is legal. The ISA says:
318
    // "
319
    // When the R1 field is not zero, bits 8-15 of the instruction designated
320
    // by the second-operand address are ORed with bits 56-63 of
321
    // general register R1. [...] When the R1 field is zero, no ORing takes place
322
    // "
323
    // This means we just save the neutral element for ORing, so 0.
324
1.38k
    SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_IMM;
325
1.38k
    SystemZ_get_detail_op(MI, 0)->imm = 0;
326
1.38k
    SystemZ_get_detail_op(MI, 0)->access =
327
1.38k
      map_get_op_access(MI, op_num);
328
1.38k
    SystemZ_get_detail_op(MI, 0)->imm_width = 0;
329
1.38k
    SystemZ_inc_op_count(MI);
330
1.38k
    return;
331
1.38k
  }
332
333
120k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_REG;
334
120k
  SystemZ_get_detail_op(MI, 0)->reg = Reg;
335
120k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
336
120k
  SystemZ_inc_op_count(MI);
337
120k
}
338
339
void SystemZ_set_detail_op_mem(MCInst *MI, unsigned op_num, systemz_reg base,
340
             int64_t disp, uint64_t length, systemz_reg index,
341
             systemz_addr_mode am)
342
53.8k
{
343
53.8k
  if (!detail_is_set(MI))
344
0
    return;
345
53.8k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_MEM;
346
53.8k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
347
53.8k
  SystemZ_get_detail_op(MI, 0)->mem.am = am;
348
53.8k
  switch (am) {
349
0
  default:
350
0
    CS_ASSERT(0 && "Address mode not handled\n");
351
0
    break;
352
24.8k
  case SYSTEMZ_AM_BD:
353
24.8k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
354
24.8k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
355
24.8k
    break;
356
21.3k
  case SYSTEMZ_AM_BDX:
357
21.8k
  case SYSTEMZ_AM_BDV:
358
21.8k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
359
21.8k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
360
21.8k
    SystemZ_get_detail_op(MI, 0)->mem.index = index;
361
21.8k
    break;
362
7.13k
  case SYSTEMZ_AM_BDL:
363
7.13k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
364
7.13k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
365
7.13k
    SystemZ_get_detail_op(MI, 0)->mem.length = length;
366
7.13k
    break;
367
0
  case SYSTEMZ_AM_BDR:
368
0
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
369
0
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
370
0
    SystemZ_get_detail_op(MI, 0)->mem.length = length;
371
0
    break;
372
53.8k
  }
373
53.8k
  SystemZ_inc_op_count(MI);
374
53.8k
}
375
376
#endif
377
378
#endif