Coverage Report

Created: 2026-09-01 07:20

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonenext/arch/SystemZ/SystemZMapping.c
Line
Count
Source
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
110k
{
45
110k
  map_cs_id(MI, systemz_insns, ARR_SIZE(systemz_insns));
46
110k
  map_implicit_reads(MI, systemz_insns);
47
110k
  map_implicit_writes(MI, systemz_insns);
48
110k
  map_groups(MI, systemz_insns);
49
110k
  const systemz_suppl_info *suppl_info =
50
110k
    map_get_suppl_info(MI, systemz_insns);
51
110k
  if (suppl_info) {
52
110k
    SystemZ_get_detail(MI)->format = suppl_info->form;
53
110k
  }
54
110k
}
55
56
void SystemZ_init_mri(MCRegisterInfo *MRI)
57
3.07k
{
58
3.07k
  MCRegisterInfo_InitMCRegisterInfo(
59
3.07k
    MRI, SystemZRegDesc, AARCH64_REG_ENDING, 0, 0,
60
3.07k
    SystemZMCRegisterClasses, ARR_SIZE(SystemZMCRegisterClasses), 0,
61
3.07k
    0, SystemZRegDiffLists, 0, SystemZSubRegIdxLists,
62
3.07k
    ARR_SIZE(SystemZSubRegIdxLists), 0);
63
3.07k
}
64
65
const char *SystemZ_reg_name(csh handle, unsigned int reg)
66
68.5k
{
67
68.5k
  return SystemZ_LLVM_getRegisterName(reg);
68
68.5k
}
69
70
void SystemZ_printer(MCInst *MI, SStream *O, void * /* MCRegisterInfo* */ info)
71
108k
{
72
108k
  MI->MRI = (MCRegisterInfo *)info;
73
108k
  MI->fillDetailOps = detail_is_set(MI);
74
108k
  SystemZ_LLVM_printInstruction(MI, "", O);
75
108k
#ifndef CAPSTONE_DIET
76
108k
  map_set_alias_id(MI, O, insn_alias_mnem_map,
77
108k
       ARR_SIZE(insn_alias_mnem_map));
78
108k
#endif
79
108k
}
80
81
void SystemZ_init_cs_detail(MCInst *MI)
82
110k
{
83
110k
  if (!detail_is_set(MI)) {
84
0
    return;
85
0
  }
86
110k
  memset(get_detail(MI), 0, sizeof(cs_detail));
87
110k
  if (detail_is_set(MI)) {
88
110k
    SystemZ_get_detail(MI)->cc = SYSTEMZ_CC_INVALID;
89
110k
  }
90
110k
}
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
110k
{
96
110k
  SystemZ_init_cs_detail(MI);
97
110k
  MI->MRI = (MCRegisterInfo *)info;
98
110k
  DecodeStatus Result = SystemZ_LLVM_getInstruction(
99
110k
    handle, bytes, bytes_len, MI, size, address, info);
100
110k
  SystemZ_set_instr_map_data(MI, bytes, bytes_len);
101
110k
  if (Result == MCDisassembler_SoftFail) {
102
0
    MCInst_setSoftFail(MI);
103
0
  }
104
110k
  return Result != MCDisassembler_Fail;
105
110k
}
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
108k
{
110
  // We do this after Instruction disassembly.
111
108k
}
112
113
const char *SystemZ_insn_name(csh handle, unsigned int id)
114
108k
{
115
108k
#ifndef CAPSTONE_DIET
116
108k
  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
108k
  if (id >= SYSTEMZ_INS_ENDING)
125
0
    return NULL;
126
127
108k
  if (id < ARR_SIZE(insn_name_maps))
128
108k
    return insn_name_maps[id];
129
130
  // not found
131
0
  return NULL;
132
#else
133
  return NULL;
134
#endif
135
108k
}
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
67.3k
{
155
67.3k
#ifndef CAPSTONE_DIET
156
67.3k
  return id2name(group_name_maps, ARR_SIZE(group_name_maps), id);
157
#else
158
  return NULL;
159
#endif
160
67.3k
}
161
162
void SystemZ_add_cs_detail_0(MCInst *MI, int /* systemz_op_group */ op_group,
163
           size_t op_num)
164
257k
{
165
257k
#ifndef CAPSTONE_DIET
166
257k
  if (!detail_is_set(MI) || !map_fill_detail_ops(MI))
167
0
    return;
168
169
257k
  switch (op_group) {
170
0
  default:
171
0
    printf("Operand group %d not handled\n", op_group);
172
0
    break;
173
145k
  case SystemZ_OP_GROUP_Operand: {
174
145k
    cs_op_type secondary_op_type = map_get_op_type(MI, op_num) &
175
145k
                 ~(CS_OP_MEM | CS_OP_BOUND);
176
145k
    if (secondary_op_type == CS_OP_IMM) {
177
0
      SystemZ_set_detail_op_imm(
178
0
        MI, op_num, MCInst_getOpVal(MI, op_num), 0);
179
145k
    } else if (secondary_op_type == CS_OP_REG) {
180
145k
      SystemZ_set_detail_op_reg(MI, op_num,
181
145k
              MCInst_getOpVal(MI, op_num));
182
145k
    } else {
183
0
      CS_ASSERT_RET(0 && "Op type not handled.");
184
0
    }
185
145k
    break;
186
145k
  }
187
145k
  case SystemZ_OP_GROUP_Cond4Operand: {
188
0
    systemz_cc cc = MCInst_getOpVal(MI, op_num);
189
0
    SystemZ_get_detail(MI)->cc = cc;
190
0
    break;
191
145k
  }
192
30.3k
  case SystemZ_OP_GROUP_BDAddrOperand:
193
30.3k
    CS_ASSERT_RET(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
194
30.3k
    CS_ASSERT_RET(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
195
30.3k
    CS_ASSERT_RET(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
196
30.3k
    CS_ASSERT_RET(
197
30.3k
      MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
198
30.3k
    SystemZ_set_detail_op_mem(MI, op_num,
199
30.3k
            MCInst_getOpVal(MI, (op_num)),
200
30.3k
            MCInst_getOpVal(MI, (op_num + 1)), 0,
201
30.3k
            0, SYSTEMZ_AM_BD);
202
30.3k
    break;
203
381
  case SystemZ_OP_GROUP_BDVAddrOperand:
204
26.3k
  case SystemZ_OP_GROUP_BDXAddrOperand: {
205
26.3k
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
206
26.3k
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
207
26.3k
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
208
26.3k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
209
26.3k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
210
26.3k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num + 2))));
211
26.3k
    SystemZ_set_detail_op_mem(
212
26.3k
      MI, op_num, MCInst_getOpVal(MI, (op_num)),
213
26.3k
      MCInst_getOpVal(MI, (op_num + 1)), 0,
214
26.3k
      MCInst_getOpVal(MI, (op_num + 2)),
215
26.3k
      (op_group == SystemZ_OP_GROUP_BDXAddrOperand ?
216
25.9k
         SYSTEMZ_AM_BDX :
217
26.3k
         SYSTEMZ_AM_BDV));
218
26.3k
    break;
219
381
  }
220
8.73k
  case SystemZ_OP_GROUP_BDLAddrOperand:
221
8.73k
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
222
8.73k
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
223
8.73k
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
224
8.73k
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
225
8.73k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
226
8.73k
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 2))));
227
8.73k
    SystemZ_set_detail_op_mem(MI, op_num,
228
8.73k
            MCInst_getOpVal(MI, (op_num)),
229
8.73k
            MCInst_getOpVal(MI, (op_num + 1)),
230
8.73k
            MCInst_getOpVal(MI, (op_num + 2)), 0,
231
8.73k
            SYSTEMZ_AM_BDL);
232
8.73k
    break;
233
761
  case SystemZ_OP_GROUP_BDRAddrOperand:
234
761
    CS_ASSERT(map_get_op_type(MI, (op_num)) & CS_OP_MEM);
235
761
    CS_ASSERT(map_get_op_type(MI, (op_num + 1)) & CS_OP_MEM);
236
761
    CS_ASSERT(map_get_op_type(MI, (op_num + 2)) & CS_OP_MEM);
237
761
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num))));
238
761
    CS_ASSERT(MCOperand_isImm(MCInst_getOperand(MI, (op_num + 1))));
239
761
    CS_ASSERT(MCOperand_isReg(MCInst_getOperand(MI, (op_num + 2))));
240
761
    SystemZ_set_detail_op_mem(MI, op_num,
241
761
            MCInst_getOpVal(MI, (op_num)),
242
761
            MCInst_getOpVal(MI, (op_num + 1)),
243
761
            MCInst_getOpVal(MI, (op_num + 2)), 0,
244
761
            SYSTEMZ_AM_BDL);
245
761
    break;
246
5.79k
  case SystemZ_OP_GROUP_PCRelOperand:
247
5.79k
    SystemZ_set_detail_op_imm(MI, op_num,
248
5.79k
            MCInst_getOpVal(MI, op_num), 0);
249
5.79k
    break;
250
1.38k
  case SystemZ_OP_GROUP_U1ImmOperand:
251
1.38k
    SystemZ_set_detail_op_imm(MI, op_num,
252
1.38k
            MCInst_getOpVal(MI, op_num), 1);
253
1.38k
    break;
254
526
  case SystemZ_OP_GROUP_U2ImmOperand:
255
526
    SystemZ_set_detail_op_imm(MI, op_num,
256
526
            MCInst_getOpVal(MI, op_num), 2);
257
526
    break;
258
415
  case SystemZ_OP_GROUP_U3ImmOperand:
259
415
    SystemZ_set_detail_op_imm(MI, op_num,
260
415
            MCInst_getOpVal(MI, op_num), 3);
261
415
    break;
262
22.1k
  case SystemZ_OP_GROUP_U4ImmOperand:
263
22.1k
    SystemZ_set_detail_op_imm(MI, op_num,
264
22.1k
            MCInst_getOpVal(MI, op_num), 4);
265
22.1k
    break;
266
6.66k
  case SystemZ_OP_GROUP_U8ImmOperand:
267
8.25k
  case SystemZ_OP_GROUP_S8ImmOperand:
268
8.25k
    SystemZ_set_detail_op_imm(MI, op_num,
269
8.25k
            MCInst_getOpVal(MI, op_num), 8);
270
8.25k
    break;
271
700
  case SystemZ_OP_GROUP_U12ImmOperand:
272
700
    SystemZ_set_detail_op_imm(MI, op_num,
273
700
            MCInst_getOpVal(MI, op_num), 12);
274
700
    break;
275
2.01k
  case SystemZ_OP_GROUP_U16ImmOperand:
276
5.04k
  case SystemZ_OP_GROUP_S16ImmOperand:
277
5.04k
    SystemZ_set_detail_op_imm(MI, op_num,
278
5.04k
            MCInst_getOpVal(MI, op_num), 16);
279
5.04k
    break;
280
1.04k
  case SystemZ_OP_GROUP_U32ImmOperand:
281
2.12k
  case SystemZ_OP_GROUP_S32ImmOperand:
282
2.12k
    SystemZ_set_detail_op_imm(MI, op_num,
283
2.12k
            MCInst_getOpVal(MI, op_num), 32);
284
2.12k
    break;
285
0
  case SystemZ_OP_GROUP_U48ImmOperand:
286
0
    SystemZ_set_detail_op_imm(MI, op_num,
287
0
            MCInst_getOpVal(MI, op_num), 48);
288
0
    break;
289
257k
  }
290
257k
#endif
291
257k
}
292
293
#ifndef CAPSTONE_DIET
294
295
void SystemZ_set_detail_op_imm(MCInst *MI, unsigned op_num, int64_t Imm,
296
             size_t width)
297
46.3k
{
298
46.3k
  if (!detail_is_set(MI))
299
0
    return;
300
46.3k
  CS_ASSERT((map_get_op_type(MI, op_num) & ~CS_OP_MEM) == CS_OP_IMM);
301
302
46.3k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_IMM;
303
46.3k
  SystemZ_get_detail_op(MI, 0)->imm = Imm;
304
46.3k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
305
46.3k
  SystemZ_get_detail_op(MI, 0)->imm_width = width;
306
46.3k
  SystemZ_inc_op_count(MI);
307
46.3k
}
308
309
void SystemZ_set_detail_op_reg(MCInst *MI, unsigned op_num, systemz_reg Reg)
310
145k
{
311
145k
  if (!detail_is_set(MI))
312
0
    return;
313
145k
  CS_ASSERT((map_get_op_type(MI, op_num) & ~CS_OP_MEM) == CS_OP_REG);
314
145k
  if (Reg == SYSTEMZ_REG_INVALID) {
315
    // This case is legal. The ISA says:
316
    // "
317
    // When the R1 field is not zero, bits 8-15 of the instruction designated
318
    // by the second-operand address are ORed with bits 56-63 of
319
    // general register R1. [...] When the R1 field is zero, no ORing takes place
320
    // "
321
    // This means we just save the neutral element for ORing, so 0.
322
475
    SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_IMM;
323
475
    SystemZ_get_detail_op(MI, 0)->imm = 0;
324
475
    SystemZ_get_detail_op(MI, 0)->access =
325
475
      map_get_op_access(MI, op_num);
326
475
    SystemZ_get_detail_op(MI, 0)->imm_width = 0;
327
475
    SystemZ_inc_op_count(MI);
328
475
    return;
329
475
  }
330
331
144k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_REG;
332
144k
  SystemZ_get_detail_op(MI, 0)->reg = Reg;
333
144k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
334
144k
  SystemZ_inc_op_count(MI);
335
144k
}
336
337
void SystemZ_set_detail_op_mem(MCInst *MI, unsigned op_num, systemz_reg base,
338
             int64_t disp, uint64_t length, systemz_reg index,
339
             systemz_addr_mode am)
340
66.1k
{
341
66.1k
  if (!detail_is_set(MI))
342
0
    return;
343
66.1k
  SystemZ_get_detail_op(MI, 0)->type = SYSTEMZ_OP_MEM;
344
66.1k
  SystemZ_get_detail_op(MI, 0)->access = map_get_op_access(MI, op_num);
345
66.1k
  SystemZ_get_detail_op(MI, 0)->mem.am = am;
346
66.1k
  switch (am) {
347
0
  default:
348
0
    CS_ASSERT(0 && "Address mode not handled\n");
349
0
    break;
350
30.3k
  case SYSTEMZ_AM_BD:
351
30.3k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
352
30.3k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
353
30.3k
    break;
354
25.9k
  case SYSTEMZ_AM_BDX:
355
26.3k
  case SYSTEMZ_AM_BDV:
356
26.3k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
357
26.3k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
358
26.3k
    SystemZ_get_detail_op(MI, 0)->mem.index = index;
359
26.3k
    break;
360
9.49k
  case SYSTEMZ_AM_BDL:
361
9.49k
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
362
9.49k
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
363
9.49k
    SystemZ_get_detail_op(MI, 0)->mem.length = length;
364
9.49k
    break;
365
0
  case SYSTEMZ_AM_BDR:
366
0
    SystemZ_get_detail_op(MI, 0)->mem.base = base;
367
0
    SystemZ_get_detail_op(MI, 0)->mem.disp = disp;
368
0
    SystemZ_get_detail_op(MI, 0)->mem.length = length;
369
0
    break;
370
66.1k
  }
371
66.1k
  SystemZ_inc_op_count(MI);
372
66.1k
}
373
374
#endif
375
376
#endif