Coverage Report

Created: 2025-10-10 06:20

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