Coverage Report

Created: 2023-12-08 06:05

/src/capstonenext/arch/MOS65XX/MOS65XXDisassembler.c
Line
Count
Source (jump to first uncovered line)
1
/* Capstone Disassembly Engine */
2
/* MOS65XX Backend by Sebastian Macke <sebastian@macke.de> 2018 */
3
4
#include "capstone/mos65xx.h"
5
#include "MOS65XXDisassembler.h"
6
#include "MOS65XXDisassemblerInternals.h"
7
8
typedef struct OpInfo {
9
  mos65xx_insn ins;
10
  mos65xx_address_mode am;
11
  int operand_bytes;
12
} OpInfo;
13
14
static const struct OpInfo OpInfoTable[]= {
15
16
#include "m6502.inc"
17
#include "m65c02.inc"
18
#include "mw65c02.inc"
19
#include "m65816.inc"
20
21
};
22
23
static const char* const RegNames[] = {
24
  "invalid", "A", "X", "Y", "P", "SP", "DP", "B", "K" 
25
};
26
27
#ifndef CAPSTONE_DIET
28
static const char* const GroupNames[] = {
29
  NULL,
30
  "jump",
31
  "call",
32
  "ret",
33
  "int",
34
  "iret",
35
  "branch_relative"
36
};
37
38
typedef struct InstructionInfo {
39
  const char* name;
40
  mos65xx_group_type group_type;
41
  mos65xx_reg write, read;
42
  bool modifies_status;
43
} InstructionInfo;
44
45
static const struct InstructionInfo InstructionInfoTable[]= {
46
47
#include "instruction_info.inc"
48
49
};
50
#endif
51
52
#ifndef CAPSTONE_DIET
53
static void fillDetails(MCInst *MI, struct OpInfo opinfo, int cpu_type)
54
6.65k
{
55
6.65k
  int i;
56
6.65k
  cs_detail *detail = MI->flat_insn->detail;
57
58
6.65k
  InstructionInfo insinfo = InstructionInfoTable[opinfo.ins];
59
60
6.65k
  detail->mos65xx.am = opinfo.am;
61
6.65k
  detail->mos65xx.modifies_flags = insinfo.modifies_status;
62
6.65k
  detail->groups_count = 0;
63
6.65k
  detail->regs_read_count = 0;
64
6.65k
  detail->regs_write_count = 0;
65
6.65k
  detail->mos65xx.op_count = 0;
66
67
6.65k
  if (insinfo.group_type != MOS65XX_GRP_INVALID) {
68
1.85k
    detail->groups[detail->groups_count] = insinfo.group_type;
69
1.85k
    detail->groups_count++;
70
1.85k
  }
71
72
6.65k
  if (opinfo.am == MOS65XX_AM_REL || opinfo.am == MOS65XX_AM_ZP_REL) {
73
262
    detail->groups[detail->groups_count] = MOS65XX_GRP_BRANCH_RELATIVE;
74
262
    detail->groups_count++; 
75
262
  }
76
77
6.65k
  if (insinfo.read != MOS65XX_REG_INVALID) {
78
2.29k
    detail->regs_read[detail->regs_read_count++] = insinfo.read;
79
4.35k
  } else switch(opinfo.am) {
80
419
    case MOS65XX_AM_ACC:
81
419
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_ACC;
82
419
      break;
83
227
    case MOS65XX_AM_ZP_Y:
84
441
    case MOS65XX_AM_ZP_IND_Y:
85
639
    case MOS65XX_AM_ABS_Y:
86
639
    case MOS65XX_AM_ZP_IND_LONG_Y:
87
639
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_Y;
88
639
      break;
89
90
348
    case MOS65XX_AM_ZP_X:
91
457
    case MOS65XX_AM_ZP_X_IND:
92
714
    case MOS65XX_AM_ABS_X:
93
714
    case MOS65XX_AM_ABS_X_IND:
94
714
    case MOS65XX_AM_ABS_LONG_X:
95
714
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_X;
96
714
      break;
97
98
0
    case MOS65XX_AM_SR:
99
0
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_SP;
100
0
      break;
101
0
    case MOS65XX_AM_SR_IND_Y:
102
0
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_SP;
103
0
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_Y;
104
0
      break;
105
106
2.58k
    default:
107
2.58k
      break;
108
4.35k
  }
109
110
6.65k
  if (insinfo.write != MOS65XX_REG_INVALID) {
111
2.35k
    detail->regs_write[detail->regs_write_count++] = insinfo.write;
112
4.29k
  } else if (opinfo.am == MOS65XX_AM_ACC) {
113
419
    detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_ACC;
114
419
  }
115
116
117
6.65k
  switch(opinfo.ins) {
118
218
    case MOS65XX_INS_ADC:
119
520
    case MOS65XX_INS_SBC:
120
789
    case MOS65XX_INS_ROL:
121
1.01k
    case MOS65XX_INS_ROR:
122
      /* these read carry flag (and decimal for ADC/SBC) */
123
1.01k
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_P;
124
1.01k
      break;
125
    /* stack operations */
126
0
    case MOS65XX_INS_JSL:
127
221
    case MOS65XX_INS_JSR:
128
221
    case MOS65XX_INS_PEA:
129
221
    case MOS65XX_INS_PEI:
130
221
    case MOS65XX_INS_PER:
131
493
    case MOS65XX_INS_PHA:
132
493
    case MOS65XX_INS_PHB:
133
493
    case MOS65XX_INS_PHD:
134
493
    case MOS65XX_INS_PHK:
135
730
    case MOS65XX_INS_PHP:
136
730
    case MOS65XX_INS_PHX:
137
730
    case MOS65XX_INS_PHY:
138
963
    case MOS65XX_INS_PLA:
139
963
    case MOS65XX_INS_PLB:
140
963
    case MOS65XX_INS_PLD:
141
1.19k
    case MOS65XX_INS_PLP:
142
1.19k
    case MOS65XX_INS_PLX:
143
1.19k
    case MOS65XX_INS_PLY:
144
1.42k
    case MOS65XX_INS_RTI:
145
1.42k
    case MOS65XX_INS_RTL:
146
1.63k
    case MOS65XX_INS_RTS:
147
1.63k
      detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_SP;
148
1.63k
      detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_SP;
149
1.63k
      break;
150
4.00k
    default:
151
4.00k
      break;
152
6.65k
  }
153
154
6.65k
  if (cpu_type == MOS65XX_CPU_TYPE_65816) {
155
0
    switch (opinfo.am) {
156
0
      case MOS65XX_AM_ZP:
157
0
      case MOS65XX_AM_ZP_X:
158
0
      case MOS65XX_AM_ZP_Y:
159
0
      case MOS65XX_AM_ZP_IND:
160
0
      case MOS65XX_AM_ZP_X_IND:
161
0
      case MOS65XX_AM_ZP_IND_Y:
162
0
      case MOS65XX_AM_ZP_IND_LONG:
163
0
      case MOS65XX_AM_ZP_IND_LONG_Y:
164
0
        detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_DP;
165
0
        break;
166
0
      case MOS65XX_AM_BLOCK:
167
0
        detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_ACC;
168
0
        detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_X;
169
0
        detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_Y;
170
0
        detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_ACC;
171
0
        detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_X;
172
0
        detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_Y;
173
0
        detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_B;
174
0
        break;
175
0
      default:
176
0
        break;
177
0
    }
178
179
0
    switch (opinfo.am) {
180
0
      case MOS65XX_AM_ZP_IND:
181
0
      case MOS65XX_AM_ZP_X_IND:
182
0
      case MOS65XX_AM_ZP_IND_Y:
183
0
      case MOS65XX_AM_ABS:
184
0
      case MOS65XX_AM_ABS_X:
185
0
      case MOS65XX_AM_ABS_Y:
186
0
      case MOS65XX_AM_ABS_X_IND:
187
        /* these depend on the databank to generate a 24-bit address */
188
        /* exceptions: PEA, PEI, and JMP (abs) */
189
0
        if (opinfo.ins == MOS65XX_INS_PEI || opinfo.ins == MOS65XX_INS_PEA) break;
190
0
        detail->regs_read[detail->regs_read_count++] = MOS65XX_REG_B;
191
0
        break;
192
0
      default:
193
0
        break;
194
0
    }
195
0
  }
196
197
6.65k
  if (insinfo.modifies_status) {
198
4.21k
    detail->regs_write[detail->regs_write_count++] = MOS65XX_REG_P;
199
4.21k
  }
200
201
6.65k
  switch(opinfo.am) {
202
1.71k
    case MOS65XX_AM_IMP:
203
1.71k
      break;
204
396
    case MOS65XX_AM_IMM:
205
396
      detail->mos65xx.operands[detail->mos65xx.op_count].type = MOS65XX_OP_IMM;
206
396
      detail->mos65xx.operands[detail->mos65xx.op_count].imm = MI->Operands[0].ImmVal;
207
396
      detail->mos65xx.op_count++;
208
396
      break;
209
419
    case MOS65XX_AM_ACC:
210
419
      detail->mos65xx.operands[detail->mos65xx.op_count].type = MOS65XX_OP_REG;
211
419
      detail->mos65xx.operands[detail->mos65xx.op_count].reg = MOS65XX_REG_ACC;
212
419
      detail->mos65xx.op_count++;
213
419
      break;
214
262
    case MOS65XX_AM_REL: {
215
262
      int value = MI->Operands[0].ImmVal;
216
262
      if (MI->op1_size == 1)
217
262
        value = 2 + (signed char)value;
218
0
      else
219
0
        value = 3 + (signed short)value;
220
262
      detail->mos65xx.operands[detail->mos65xx.op_count].type = MOS65XX_OP_MEM;
221
262
      detail->mos65xx.operands[detail->mos65xx.op_count].mem = (MI->address + value) & 0xffff;
222
262
      detail->mos65xx.op_count++;
223
262
      break;
224
0
    }
225
0
    case MOS65XX_AM_ZP_REL: {
226
0
      int value = 3 + (signed char)MI->Operands[1].ImmVal;
227
      /* BBR0, zp, rel  and BBS0, zp, rel */
228
0
      detail->mos65xx.operands[detail->mos65xx.op_count].type = MOS65XX_OP_MEM;
229
0
      detail->mos65xx.operands[detail->mos65xx.op_count].mem = MI->Operands[0].ImmVal;
230
0
      detail->mos65xx.operands[detail->mos65xx.op_count+1].type = MOS65XX_OP_MEM;
231
0
      detail->mos65xx.operands[detail->mos65xx.op_count+1].mem = (MI->address + value) & 0xffff;
232
0
      detail->mos65xx.op_count+=2;
233
0
      break;
234
0
    }
235
3.86k
    default:
236
7.72k
      for (i = 0; i < MI->size; ++i) {
237
3.86k
        detail->mos65xx.operands[detail->mos65xx.op_count].type = MOS65XX_OP_MEM;
238
3.86k
        detail->mos65xx.operands[detail->mos65xx.op_count].mem = MI->Operands[i].ImmVal;
239
3.86k
        detail->mos65xx.op_count++;
240
3.86k
      }
241
3.86k
      break;
242
6.65k
  }
243
6.65k
}
244
#endif
245
246
void MOS65XX_printInst(MCInst *MI, struct SStream *O, void *PrinterInfo)
247
6.65k
{
248
6.65k
#ifndef CAPSTONE_DIET
249
6.65k
  unsigned int value;
250
6.65k
  unsigned opcode = MCInst_getOpcode(MI);
251
6.65k
  mos65xx_info *info = (mos65xx_info *)PrinterInfo;
252
253
6.65k
  OpInfo opinfo = OpInfoTable[opcode];
254
255
6.65k
  const char *prefix = info->hex_prefix ? info->hex_prefix : "0x";
256
257
6.65k
  SStream_concat0(O, InstructionInfoTable[opinfo.ins].name);
258
6.65k
  switch (opinfo.ins) {
259
    /* special case - bit included as part of the instruction name */
260
0
    case MOS65XX_INS_BBR:
261
0
    case MOS65XX_INS_BBS:
262
0
    case MOS65XX_INS_RMB:
263
0
    case MOS65XX_INS_SMB:
264
0
      SStream_concat(O, "%d", (opcode >> 4) & 0x07);
265
0
      break;
266
6.65k
    default:
267
6.65k
      break;
268
6.65k
  }
269
270
6.65k
  value = MI->Operands[0].ImmVal;
271
272
6.65k
  switch (opinfo.am) {
273
0
    default:
274
0
      break;
275
276
1.71k
    case MOS65XX_AM_IMP:
277
1.71k
      break;
278
279
419
    case MOS65XX_AM_ACC:
280
419
      SStream_concat0(O, " a");
281
419
      break;
282
283
396
    case MOS65XX_AM_IMM:
284
396
      if (MI->imm_size == 1)
285
396
        SStream_concat(O, " #%s%02x", prefix, value);
286
0
      else
287
0
        SStream_concat(O, " #%s%04x", prefix, value);
288
396
      break;
289
290
273
    case MOS65XX_AM_ZP:
291
273
      SStream_concat(O, " %s%02x", prefix, value);
292
273
      break;
293
294
472
    case MOS65XX_AM_ABS:
295
472
      SStream_concat(O, " %s%04x", prefix, value);
296
472
      break;
297
298
0
    case MOS65XX_AM_ABS_LONG_X:
299
0
      SStream_concat(O, " %s%06x, x", prefix, value);
300
0
      break;
301
302
720
    case MOS65XX_AM_INT:
303
720
      SStream_concat(O, " %s%02x", prefix, value);
304
720
      break;
305
306
447
    case MOS65XX_AM_ABS_X:
307
447
      SStream_concat(O, " %s%04x, x", prefix, value);
308
447
      break;
309
310
348
    case MOS65XX_AM_ABS_Y:
311
348
      SStream_concat(O, " %s%04x, y", prefix, value);
312
348
      break;
313
314
0
    case MOS65XX_AM_ABS_LONG:
315
0
      SStream_concat(O, " %s%06x", prefix, value);
316
0
      break;
317
318
370
    case MOS65XX_AM_ZP_X:
319
370
      SStream_concat(O, " %s%02x, x", prefix, value);
320
370
      break;
321
322
278
    case MOS65XX_AM_ZP_Y:
323
278
      SStream_concat(O, " %s%02x, y", prefix, value);
324
278
      break;
325
326
262
    case MOS65XX_AM_REL:
327
262
      if (MI->op1_size == 1)
328
262
        value = 2 + (signed char)value;
329
0
      else
330
0
        value = 3 + (signed short)value;
331
332
262
      SStream_concat(O, " %s%04x", prefix, 
333
262
        (MI->address + value) & 0xffff);
334
262
      break;
335
336
212
    case MOS65XX_AM_ABS_IND:
337
212
      SStream_concat(O, " (%s%04x)", prefix, value);
338
212
      break;
339
340
0
    case MOS65XX_AM_ABS_X_IND:
341
0
      SStream_concat(O, " (%s%04x, x)", prefix, value);
342
0
      break;
343
344
0
    case MOS65XX_AM_ABS_IND_LONG:
345
0
      SStream_concat(O, " [%s%04x]", prefix, value);
346
0
      break;
347
348
0
    case MOS65XX_AM_ZP_IND:
349
0
      SStream_concat(O, " (%s%02x)", prefix, value);
350
0
      break;
351
352
310
    case MOS65XX_AM_ZP_X_IND:
353
310
      SStream_concat(O, " (%s%02x, x)", prefix, value);
354
310
      break;
355
356
430
    case MOS65XX_AM_ZP_IND_Y:
357
430
      SStream_concat(O, " (%s%02x), y", prefix, value);
358
430
      break;
359
360
0
    case MOS65XX_AM_ZP_IND_LONG:
361
0
      SStream_concat(O, " [%s%02x]", prefix, value);
362
0
      break;
363
364
0
    case MOS65XX_AM_ZP_IND_LONG_Y:
365
0
      SStream_concat(O, " [%s%02x], y", prefix, value);
366
0
      break;
367
368
0
    case MOS65XX_AM_SR:
369
0
      SStream_concat(O, " %s%02x, s", prefix, value);
370
0
      break;
371
372
0
    case MOS65XX_AM_SR_IND_Y:
373
0
      SStream_concat(O, " (%s%02x, s), y", prefix, value);
374
0
      break;
375
376
0
    case MOS65XX_AM_BLOCK:
377
0
      SStream_concat(O, " %s%02x, %s%02x",
378
0
        prefix, MI->Operands[0].ImmVal,
379
0
        prefix, MI->Operands[1].ImmVal);
380
0
      break;
381
382
0
    case MOS65XX_AM_ZP_REL:
383
0
      value = 3 + (signed char)MI->Operands[1].ImmVal;
384
      /* BBR0, zp, rel  and BBS0, zp, rel */
385
0
      SStream_concat(O, " %s%02x, %s%04x",
386
0
        prefix, MI->Operands[0].ImmVal,
387
0
        prefix, (MI->address + value) & 0xffff);
388
0
      break;
389
390
6.65k
  }
391
6.65k
#endif
392
6.65k
}
393
394
bool MOS65XX_getInstruction(csh ud, const uint8_t *code, size_t code_len,
395
              MCInst *MI, uint16_t *size, uint64_t address, void *inst_info)
396
6.75k
{
397
6.75k
  int i;
398
6.75k
  unsigned char opcode;
399
6.75k
  unsigned char len;
400
6.75k
  unsigned cpu_offset = 0;
401
6.75k
  int cpu_type = MOS65XX_CPU_TYPE_6502;
402
6.75k
  cs_struct* handle = MI->csh;
403
6.75k
  mos65xx_info *info = (mos65xx_info *)handle->printer_info;
404
6.75k
  OpInfo opinfo;
405
406
6.75k
  if (code_len == 0) {
407
0
    *size = 1;
408
0
    return false;
409
0
  }
410
411
6.75k
  cpu_type = info->cpu_type;
412
6.75k
  cpu_offset = cpu_type * 256;
413
414
6.75k
  opcode = code[0];
415
6.75k
  opinfo = OpInfoTable[cpu_offset + opcode];
416
6.75k
  if (opinfo.ins == MOS65XX_INS_INVALID) {
417
59
    *size = 1;
418
59
    return false;
419
59
  }
420
421
6.69k
  len = opinfo.operand_bytes + 1;
422
423
6.69k
  if (cpu_type == MOS65XX_CPU_TYPE_65816 && opinfo.am == MOS65XX_AM_IMM) {
424
0
    switch(opinfo.ins) {
425
0
      case MOS65XX_INS_CPX:
426
0
      case MOS65XX_INS_CPY:
427
0
      case MOS65XX_INS_LDX:
428
0
      case MOS65XX_INS_LDY:
429
0
        if (info->long_x) ++len;
430
0
        break;
431
0
      case MOS65XX_INS_ADC:
432
0
      case MOS65XX_INS_AND:
433
0
      case MOS65XX_INS_BIT:
434
0
      case MOS65XX_INS_CMP:
435
0
      case MOS65XX_INS_EOR:
436
0
      case MOS65XX_INS_LDA:
437
0
      case MOS65XX_INS_ORA:
438
0
      case MOS65XX_INS_SBC:
439
0
        if (info->long_m) ++len;
440
0
        break;
441
0
      default:
442
0
        break;
443
0
    }
444
0
  }
445
446
6.69k
  if (code_len < len) {
447
43
    *size = 1;
448
43
    return false;
449
43
  }
450
451
6.65k
  MI->address = address;
452
453
6.65k
  MCInst_setOpcode(MI, cpu_offset + opcode);
454
6.65k
  MCInst_setOpcodePub(MI, opinfo.ins);
455
456
6.65k
  *size = len;
457
458
  /* needed to differentiate relative vs relative long */
459
6.65k
  MI->op1_size = len - 1;
460
6.65k
  if (opinfo.ins == MOS65XX_INS_NOP) {
461
244
    for (i = 1; i < len; ++i)
462
0
      MCOperand_CreateImm0(MI, code[i]);
463
244
  }
464
465
6.65k
  switch (opinfo.am) {
466
0
    case MOS65XX_AM_ZP_REL:
467
0
      MCOperand_CreateImm0(MI, code[1]);
468
0
      MCOperand_CreateImm0(MI, code[2]);
469
0
      break;
470
0
    case MOS65XX_AM_BLOCK:
471
0
      MCOperand_CreateImm0(MI, code[2]);
472
0
      MCOperand_CreateImm0(MI, code[1]);
473
0
      break;
474
1.71k
    case MOS65XX_AM_IMP:
475
2.13k
    case MOS65XX_AM_ACC:
476
2.13k
      break;
477
478
396
    case MOS65XX_AM_IMM:
479
396
      MI->has_imm = 1;
480
396
      MI->imm_size = len - 1;
481
      /* 65816 immediate is either 1 or 2 bytes */
482
      /* drop through */
483
4.51k
    default:
484
4.51k
      if (len == 2)
485
3.03k
        MCOperand_CreateImm0(MI, code[1]);
486
1.47k
      else if (len == 3)
487
1.47k
        MCOperand_CreateImm0(MI, (code[2]<<8) | code[1]);
488
0
      else if (len == 4)
489
0
        MCOperand_CreateImm0(MI, (code[3]<<16) | (code[2]<<8) | code[1]);
490
4.51k
      break;
491
6.65k
  }
492
493
6.65k
#ifndef CAPSTONE_DIET
494
6.65k
  if (MI->flat_insn->detail) {
495
6.65k
    fillDetails(MI, opinfo, cpu_type);
496
6.65k
  }
497
6.65k
#endif
498
499
6.65k
  return true;
500
6.65k
}
501
502
const char *MOS65XX_insn_name(csh handle, unsigned int id)
503
6.65k
{
504
#ifdef CAPSTONE_DIET
505
  return NULL;
506
#else
507
6.65k
  if (id >= ARR_SIZE(InstructionInfoTable)) {
508
0
    return NULL;
509
0
  }
510
6.65k
  return InstructionInfoTable[id].name;
511
6.65k
#endif
512
6.65k
}
513
514
const char* MOS65XX_reg_name(csh handle, unsigned int reg)
515
15.3k
{
516
#ifdef CAPSTONE_DIET
517
  return NULL;
518
#else
519
15.3k
  if (reg >= ARR_SIZE(RegNames)) {
520
0
    return NULL;
521
0
  }
522
15.3k
  return RegNames[(int)reg];
523
15.3k
#endif
524
15.3k
}
525
526
void MOS65XX_get_insn_id(cs_struct *h, cs_insn *insn, unsigned int id)
527
6.65k
{
528
  /* id is cpu_offset + opcode */
529
6.65k
  if (id < ARR_SIZE(OpInfoTable)) {
530
6.65k
    insn->id = OpInfoTable[id].ins;
531
6.65k
  }
532
6.65k
}
533
534
const char *MOS65XX_group_name(csh handle, unsigned int id)
535
2.11k
{
536
#ifdef CAPSTONE_DIET
537
  return NULL;
538
#else
539
2.11k
  if (id >= ARR_SIZE(GroupNames)) {
540
0
    return NULL;
541
0
  }
542
2.11k
  return GroupNames[(int)id];
543
2.11k
#endif
544
2.11k
}