Coverage Report

Created: 2025-07-18 06:43

/src/capstonenext/arch/M68K/M68KInstPrinter.c
Line
Count
Source (jump to first uncovered line)
1
/* Capstone Disassembly Engine */
2
/* M68K Backend by Daniel Collin <daniel@collin.com> 2015-2016 */
3
4
#include <stdio.h>  // DEBUG
5
#include <stdlib.h>
6
#include <string.h>
7
8
#include "M68KInstPrinter.h"
9
10
#include "M68KDisassembler.h"
11
12
#include "../../cs_priv.h"
13
#include "../../Mapping.h"
14
#include "../../utils.h"
15
16
#include "../../MCInst.h"
17
#include "../../MCInstrDesc.h"
18
#include "../../MCRegisterInfo.h"
19
20
#ifndef CAPSTONE_DIET
21
static const char s_spacing[] = " ";
22
23
static const char* const s_reg_names[] = {
24
  "invalid",
25
  "d0", "d1", "d2", "d3", "d4", "d5", "d6", "d7",
26
  "a0", "a1", "a2", "a3", "a4", "a5", "a6", "a7",
27
  "fp0", "fp1", "fp2", "fp3", "fp4", "fp5", "fp6", "fp7",
28
  "pc",
29
  "sr", "ccr", "sfc", "dfc", "usp", "vbr", "cacr",
30
  "caar", "msp", "isp", "tc", "itt0", "itt1", "dtt0",
31
  "dtt1", "mmusr", "urp", "srp",
32
33
  "fpcr", "fpsr", "fpiar",
34
};
35
36
static const char* const s_instruction_names[] = {
37
  "invalid",
38
  "abcd", "add", "adda", "addi", "addq", "addx", "and", "andi", "asl", "asr", "bhs", "blo", "bhi", "bls", "bcc", "bcs", "bne", "beq", "bvc",
39
  "bvs", "bpl", "bmi", "bge", "blt", "bgt", "ble", "bra", "bsr", "bchg", "bclr", "bset", "btst", "bfchg", "bfclr", "bfexts", "bfextu", "bfffo", "bfins",
40
  "bfset", "bftst", "bkpt", "callm", "cas", "cas2", "chk", "chk2", "clr", "cmp", "cmpa", "cmpi", "cmpm", "cmp2", "cinvl", "cinvp", "cinva", "cpushl", "cpushp",
41
  "cpusha", "dbt", "dbf", "dbhi", "dbls", "dbcc", "dbcs", "dbne", "dbeq", "dbvc", "dbvs", "dbpl", "dbmi", "dbge", "dblt", "dbgt", "dble", "dbra",
42
  "divs", "divsl", "divu", "divul", "eor", "eori", "exg", "ext", "extb", "fabs", "fsabs", "fdabs", "facos", "fadd", "fsadd", "fdadd", "fasin",
43
  "fatan", "fatanh", "fbf", "fbeq", "fbogt", "fboge", "fbolt", "fbole", "fbogl", "fbor", "fbun", "fbueq", "fbugt", "fbuge", "fbult", "fbule", "fbne", "fbt",
44
  "fbsf", "fbseq", "fbgt", "fbge", "fblt", "fble", "fbgl", "fbgle", "fbngle", "fbngl", "fbnle", "fbnlt", "fbnge", "fbngt", "fbsne", "fbst", "fcmp", "fcos",
45
  "fcosh", "fdbf", "fdbeq", "fdbogt", "fdboge", "fdbolt", "fdbole", "fdbogl", "fdbor", "fdbun", "fdbueq", "fdbugt", "fdbuge", "fdbult", "fdbule", "fdbne",
46
  "fdbt", "fdbsf", "fdbseq", "fdbgt", "fdbge", "fdblt", "fdble", "fdbgl", "fdbgle", "fdbngle", "fdbngl", "fdbnle", "fdbnlt", "fdbnge", "fdbngt", "fdbsne",
47
  "fdbst", "fdiv", "fsdiv", "fddiv", "fetox", "fetoxm1", "fgetexp", "fgetman", "fint", "fintrz", "flog10", "flog2", "flogn", "flognp1", "fmod", "fmove",
48
  "fsmove", "fdmove", "fmovecr", "fmovem", "fmul", "fsmul", "fdmul", "fneg", "fsneg", "fdneg", "fnop", "frem", "frestore", "fsave", "fscale", "fsgldiv",
49
  "fsglmul", "fsin", "fsincos", "fsinh", "fsqrt", "fssqrt", "fdsqrt", "fsf", "fseq", "fsogt", "fsoge", "fsolt", "fsole", "fsogl", "fsor", "fsun", "fsueq",
50
  "fsugt", "fsuge", "fsult", "fsule", "fsne", "fst", "fssf", "fsseq", "fsgt", "fsge", "fslt", "fsle", "fsgl", "fsgle", "fsngle",
51
  "fsngl", "fsnle", "fsnlt", "fsnge", "fsngt", "fssne", "fsst", "fsub", "fssub", "fdsub", "ftan", "ftanh", "ftentox", "ftrapf", "ftrapeq", "ftrapogt",
52
  "ftrapoge", "ftrapolt", "ftrapole", "ftrapogl", "ftrapor", "ftrapun", "ftrapueq", "ftrapugt", "ftrapuge", "ftrapult", "ftrapule", "ftrapne", "ftrapt",
53
  "ftrapsf", "ftrapseq", "ftrapgt", "ftrapge", "ftraplt", "ftraple", "ftrapgl", "ftrapgle", "ftrapngle", "ftrapngl", "ftrapnle", "ftrapnlt", "ftrapnge",
54
  "ftrapngt", "ftrapsne", "ftrapst", "ftst", "ftwotox", "halt", "illegal", "jmp", "jsr", "lea", "link", "lpstop", "lsl", "lsr", "move", "movea", "movec",
55
  "movem", "movep", "moveq", "moves", "move16", "muls", "mulu", "nbcd", "neg", "negx", "nop", "not", "or", "ori", "pack", "pea", "pflush", "pflusha",
56
  "pflushan", "pflushn", "ploadr", "ploadw", "plpar", "plpaw", "pmove", "pmovefd", "ptestr", "ptestw", "pulse", "rems", "remu", "reset", "rol", "ror",
57
  "roxl", "roxr", "rtd", "rte", "rtm", "rtr", "rts", "sbcd", "st", "sf", "shi", "sls", "scc", "shs", "scs", "slo", "sne", "seq", "svc", "svs", "spl", "smi",
58
  "sge", "slt", "sgt", "sle", "stop", "sub", "suba", "subi", "subq", "subx", "swap", "tas", "trap", "trapv", "trapt", "trapf", "traphi", "trapls",
59
  "trapcc", "traphs", "trapcs", "traplo", "trapne", "trapeq", "trapvc", "trapvs", "trappl", "trapmi", "trapge", "traplt", "trapgt", "traple", "tst", "unlk", "unpk",
60
};
61
#endif
62
63
64
#ifndef CAPSTONE_DIET
65
static const char* getRegName(m68k_reg reg)
66
57.2k
{
67
57.2k
  return s_reg_names[(int)reg];
68
57.2k
}
69
70
static void printRegbitsRange(char* buffer, size_t buf_len, uint32_t data, const char* prefix)
71
25.9k
{
72
25.9k
  unsigned int first = 0;
73
25.9k
  unsigned int run_length = 0;
74
25.9k
  int i;
75
76
214k
  for (i = 0; i < 8; ++i) {
77
188k
    if (data & (1 << i)) {
78
29.2k
      first = i;
79
29.2k
      run_length = 0;
80
81
48.0k
      while (i < 7 && (data & (1 << (i + 1)))) {
82
18.8k
        i++;
83
18.8k
        run_length++;
84
18.8k
      }
85
86
29.2k
      if (buffer[0] != 0)
87
20.5k
        strncat(buffer, "/", buf_len - 1);
88
89
29.2k
      snprintf(buffer + strlen(buffer), buf_len, "%s%d", prefix, first);
90
29.2k
      if (run_length > 0)
91
11.1k
        snprintf(buffer + strlen(buffer), buf_len, "-%s%d", prefix, first + run_length);
92
29.2k
    }
93
188k
  }
94
25.9k
}
95
96
static void registerBits(SStream* O, const cs_m68k_op* op)
97
9.24k
{
98
9.24k
  char buffer[128];
99
9.24k
  unsigned int data = op->register_bits;
100
101
9.24k
  buffer[0] = 0;
102
103
9.24k
  if (!data) {
104
588
    SStream_concat(O, "%s", "#$0");
105
588
    return;
106
588
  }
107
108
8.65k
  printRegbitsRange(buffer, sizeof(buffer), data & 0xff, "d");
109
8.65k
  printRegbitsRange(buffer, sizeof(buffer), (data >> 8) & 0xff, "a");
110
8.65k
  printRegbitsRange(buffer, sizeof(buffer), (data >> 16) & 0xff, "fp");
111
112
8.65k
  SStream_concat(O, "%s", buffer);
113
8.65k
}
114
115
static void registerPair(SStream* O, const cs_m68k_op* op)
116
6.03k
{
117
6.03k
  SStream_concat(O, "%s:%s", s_reg_names[op->reg_pair.reg_0],
118
6.03k
      s_reg_names[op->reg_pair.reg_1]);
119
6.03k
}
120
121
static void printAddressingMode(SStream* O, unsigned int pc, const cs_m68k* inst, const cs_m68k_op* op)
122
789k
{
123
789k
  switch (op->address_mode) {
124
75.2k
    case M68K_AM_NONE:
125
75.2k
      switch (op->type) {
126
9.24k
        case M68K_OP_REG_BITS:
127
9.24k
          registerBits(O, op);
128
9.24k
          break;
129
6.03k
        case M68K_OP_REG_PAIR:
130
6.03k
          registerPair(O, op);
131
6.03k
          break;
132
58.6k
        case M68K_OP_REG:
133
58.6k
          SStream_concat(O, "%s", s_reg_names[op->reg]);
134
58.6k
          break;
135
1.31k
        default:
136
1.31k
          break;
137
75.2k
      }
138
75.2k
      break;
139
140
270k
    case M68K_AM_REG_DIRECT_DATA: SStream_concat(O, "d%d", (op->reg - M68K_REG_D0)); break;
141
42.9k
    case M68K_AM_REG_DIRECT_ADDR: SStream_concat(O, "a%d", (op->reg - M68K_REG_A0)); break;
142
43.0k
    case M68K_AM_REGI_ADDR: SStream_concat(O, "(a%d)", (op->reg - M68K_REG_A0)); break;
143
46.1k
    case M68K_AM_REGI_ADDR_POST_INC: SStream_concat(O, "(a%d)+", (op->reg - M68K_REG_A0)); break;
144
75.5k
    case M68K_AM_REGI_ADDR_PRE_DEC: SStream_concat(O, "-(a%d)", (op->reg - M68K_REG_A0)); break;
145
29.7k
    case M68K_AM_REGI_ADDR_DISP: SStream_concat(O, "%s$%x(a%d)", op->mem.disp < 0 ? "-" : "", abs(op->mem.disp), (op->mem.base_reg - M68K_REG_A0)); break;
146
5.47k
    case M68K_AM_PCI_DISP: SStream_concat(O, "$%x(pc)", pc + 2 + op->mem.disp); break;
147
5.54k
    case M68K_AM_ABSOLUTE_DATA_SHORT: SStream_concat(O, "$%x.w", op->imm); break;
148
3.57k
    case M68K_AM_ABSOLUTE_DATA_LONG: SStream_concat(O, "$%x.l", op->imm); break;
149
115k
    case M68K_AM_IMMEDIATE:
150
115k
       if (inst->op_size.type == M68K_SIZE_TYPE_FPU) {
151
#if defined(_KERNEL_MODE)
152
         // Issue #681: Windows kernel does not support formatting float point
153
         SStream_concat(O, "#<float_point_unsupported>");
154
         break;
155
#else
156
319
         if (inst->op_size.fpu_size == M68K_FPU_SIZE_SINGLE)
157
171
           SStream_concat(O, "#%f", op->simm);
158
148
         else if (inst->op_size.fpu_size == M68K_FPU_SIZE_DOUBLE)
159
148
           SStream_concat(O, "#%f", op->dimm);
160
0
         else
161
0
           SStream_concat(O, "#<unsupported>");
162
319
         break;
163
319
#endif
164
319
       }
165
115k
       SStream_concat(O, "#$%x", op->imm);
166
115k
       break;
167
2.44k
    case M68K_AM_PCI_INDEX_8_BIT_DISP:
168
2.44k
      SStream_concat(O, "$%x(pc,%s%s.%c)", pc + 2 + op->mem.disp, s_spacing, getRegName(op->mem.index_reg), op->mem.index_size ? 'l' : 'w');
169
2.44k
      break;
170
18.1k
    case M68K_AM_AREGI_INDEX_8_BIT_DISP:
171
18.1k
      SStream_concat(O, "%s$%x(%s,%s%s.%c)", op->mem.disp < 0 ? "-" : "", abs(op->mem.disp), getRegName(op->mem.base_reg), s_spacing, getRegName(op->mem.index_reg), op->mem.index_size ? 'l' : 'w');
172
18.1k
      break;
173
356
    case M68K_AM_PCI_INDEX_BASE_DISP:
174
6.81k
    case M68K_AM_AREGI_INDEX_BASE_DISP:
175
176
6.81k
      if (op->address_mode == M68K_AM_PCI_INDEX_BASE_DISP) {
177
356
        SStream_concat(O, "$%x", pc + 2 + op->mem.in_disp);
178
6.45k
      } else {
179
6.45k
        if (op->mem.in_disp > 0)
180
2.20k
          SStream_concat(O, "$%x", op->mem.in_disp);
181
6.45k
      }
182
183
6.81k
      SStream_concat0(O, "(");
184
185
6.81k
      if (op->address_mode == M68K_AM_PCI_INDEX_BASE_DISP) {
186
356
          SStream_concat(O, "pc,%s.%c", getRegName(op->mem.index_reg), op->mem.index_size ? 'l' : 'w');
187
6.45k
      } else {
188
6.45k
        if (op->mem.base_reg != M68K_REG_INVALID)
189
4.27k
          SStream_concat(O, "a%d,%s", op->mem.base_reg - M68K_REG_A0, s_spacing);
190
6.45k
        SStream_concat(O, "%s.%c", getRegName(op->mem.index_reg), op->mem.index_size ? 'l' : 'w');
191
6.45k
      }
192
193
6.81k
      if (op->mem.scale > 0)
194
2.72k
          SStream_concat(O, "%s*%s%d)", s_spacing, s_spacing, op->mem.scale);
195
4.09k
      else
196
4.09k
          SStream_concat0(O, ")");
197
6.81k
      break;
198
      // It's ok to just use PCMI here as is as we set base_reg to PC in the disassembler. While this is not strictly correct it makes the code
199
      // easier and that is what actually happens when the code is executed anyway.
200
201
645
    case M68K_AM_PC_MEMI_POST_INDEX:
202
1.39k
    case M68K_AM_PC_MEMI_PRE_INDEX:
203
6.25k
    case M68K_AM_MEMI_PRE_INDEX:
204
10.3k
    case M68K_AM_MEMI_POST_INDEX:
205
10.3k
      SStream_concat0(O, "([");
206
207
10.3k
      if (op->address_mode == M68K_AM_PC_MEMI_POST_INDEX || op->address_mode == M68K_AM_PC_MEMI_PRE_INDEX) {
208
1.39k
        SStream_concat(O, "$%x", pc + 2 + op->mem.in_disp);
209
8.91k
      } else {
210
8.91k
        if (op->mem.in_disp > 0)
211
4.48k
          SStream_concat(O, "$%x", op->mem.in_disp);
212
8.91k
      }
213
214
10.3k
      if (op->mem.base_reg != M68K_REG_INVALID) {
215
5.76k
        if (op->mem.in_disp > 0)
216
2.58k
          SStream_concat(O, ",%s%s", s_spacing, getRegName(op->mem.base_reg));
217
3.17k
        else
218
3.17k
          SStream_concat(O, "%s", getRegName(op->mem.base_reg));
219
5.76k
      }
220
221
10.3k
      if (op->address_mode == M68K_AM_MEMI_POST_INDEX || op->address_mode == M68K_AM_PC_MEMI_POST_INDEX)
222
4.69k
          SStream_concat0(O, "]");
223
224
10.3k
      if (op->mem.index_reg != M68K_REG_INVALID)
225
5.84k
          SStream_concat(O, ",%s%s.%c", s_spacing, getRegName(op->mem.index_reg), op->mem.index_size ? 'l' : 'w');
226
227
10.3k
      if (op->mem.scale > 0)
228
3.71k
          SStream_concat(O, "%s*%s%d", s_spacing, s_spacing, op->mem.scale);
229
230
10.3k
      if (op->address_mode == M68K_AM_MEMI_PRE_INDEX || op->address_mode == M68K_AM_PC_MEMI_PRE_INDEX)
231
5.60k
          SStream_concat0(O, "]");
232
233
10.3k
      if (op->mem.out_disp > 0)
234
3.74k
          SStream_concat(O, ",%s$%x", s_spacing, op->mem.out_disp);
235
236
10.3k
      SStream_concat0(O, ")");
237
10.3k
      break;
238
37.7k
    case M68K_AM_BRANCH_DISPLACEMENT:
239
37.7k
      SStream_concat(O, "$%x", pc + 2 + op->br_disp.disp);
240
37.7k
    default:
241
37.7k
      break;
242
789k
  }
243
244
789k
  if (op->mem.bitfield)
245
4.57k
    SStream_concat(O, "{%d:%d}", op->mem.offset, op->mem.width);
246
789k
}
247
#endif
248
249
#define m68k_sizeof_array(array) (int)(sizeof(array)/sizeof(array[0]))
250
1.53M
#define m68k_min(a, b) (a < b) ? a : b
251
252
void M68K_printInst(MCInst* MI, SStream* O, void* PrinterInfo)
253
512k
{
254
512k
#ifndef CAPSTONE_DIET
255
512k
  m68k_info *info = (m68k_info *)PrinterInfo;
256
512k
  cs_m68k *ext = &info->extension;
257
512k
  cs_detail *detail = NULL;
258
512k
  int i = 0;
259
260
512k
  detail = MI->flat_insn->detail;
261
512k
  if (detail) {
262
512k
    int regs_read_count = m68k_min(m68k_sizeof_array(detail->regs_read), info->regs_read_count);
263
512k
    int regs_write_count = m68k_min(m68k_sizeof_array(detail->regs_write), info->regs_write_count);
264
512k
    int groups_count = m68k_min(m68k_sizeof_array(detail->groups), info->groups_count);
265
266
512k
    memcpy(&detail->m68k, ext, sizeof(cs_m68k));
267
268
512k
    memcpy(&detail->regs_read, &info->regs_read, regs_read_count * sizeof(info->regs_read[0]));
269
512k
    detail->regs_read_count = regs_read_count;
270
271
512k
    memcpy(&detail->regs_write, &info->regs_write, regs_write_count * sizeof(info->regs_write[0]));
272
512k
    detail->regs_write_count = regs_write_count;
273
274
512k
    memcpy(&detail->groups, &info->groups, groups_count);
275
512k
    detail->groups_count = groups_count;
276
512k
  }
277
278
512k
  if (MI->Opcode == M68K_INS_INVALID) {
279
73.9k
    if (ext->op_count)
280
73.9k
      SStream_concat(O, "dc.w $%x", ext->operands[0].imm);
281
0
    else
282
0
      SStream_concat(O, "dc.w $<unknown>");
283
73.9k
    return;
284
73.9k
  }
285
286
438k
  SStream_concat0(O, (char*)s_instruction_names[MI->Opcode]);
287
288
438k
  switch (ext->op_size.type) {
289
0
    case M68K_SIZE_TYPE_INVALID :
290
0
      break;
291
292
434k
    case M68K_SIZE_TYPE_CPU :
293
434k
      switch (ext->op_size.cpu_size) {
294
139k
        case M68K_CPU_SIZE_BYTE: SStream_concat0(O, ".b"); break;
295
120k
        case M68K_CPU_SIZE_WORD: SStream_concat0(O, ".w"); break;
296
115k
        case M68K_CPU_SIZE_LONG: SStream_concat0(O, ".l"); break;
297
58.6k
        case M68K_CPU_SIZE_NONE: break;
298
434k
      }
299
434k
      break;
300
301
434k
    case M68K_SIZE_TYPE_FPU :
302
4.33k
      switch (ext->op_size.fpu_size) {
303
1.23k
        case M68K_FPU_SIZE_SINGLE: SStream_concat0(O, ".s"); break;
304
2.48k
        case M68K_FPU_SIZE_DOUBLE: SStream_concat0(O, ".d"); break;
305
614
        case M68K_FPU_SIZE_EXTENDED: SStream_concat0(O, ".x"); break;
306
0
        case M68K_FPU_SIZE_NONE: break;
307
4.33k
      }
308
4.33k
      break;
309
438k
  }
310
311
438k
  SStream_concat0(O, " ");
312
313
  // this one is a bit spacial so we do special things
314
315
438k
  if (MI->Opcode == M68K_INS_CAS2) {
316
2.29k
    int reg_value_0, reg_value_1;
317
2.29k
    printAddressingMode(O, info->pc, ext, &ext->operands[0]); SStream_concat0(O, ",");
318
2.29k
    printAddressingMode(O, info->pc, ext, &ext->operands[1]); SStream_concat0(O, ",");
319
2.29k
    reg_value_0 = ext->operands[2].register_bits >> 4;
320
2.29k
    reg_value_1 = ext->operands[2].register_bits & 0xf;
321
2.29k
    SStream_concat(O, "(%s):(%s)", s_reg_names[M68K_REG_D0 + reg_value_0], s_reg_names[M68K_REG_D0 + reg_value_1]);
322
2.29k
    return;
323
2.29k
  }
324
325
1.22M
  for (i  = 0; i < ext->op_count; ++i) {
326
784k
    printAddressingMode(O, info->pc, ext, &ext->operands[i]);
327
784k
    if ((i + 1) != ext->op_count)
328
350k
      SStream_concat(O, ",%s", s_spacing);
329
784k
  }
330
436k
#endif
331
436k
}
332
333
const char* M68K_reg_name(csh handle, unsigned int reg)
334
647k
{
335
#ifdef CAPSTONE_DIET
336
  return NULL;
337
#else
338
647k
  if (reg >= ARR_SIZE(s_reg_names)) {
339
0
    return NULL;
340
0
  }
341
647k
  return s_reg_names[(int)reg];
342
647k
#endif
343
647k
}
344
345
void M68K_get_insn_id(cs_struct* h, cs_insn* insn, unsigned int id)
346
512k
{
347
512k
  insn->id = id; // These id's matches for 68k
348
512k
}
349
350
const char* M68K_insn_name(csh handle, unsigned int id)
351
512k
{
352
#ifdef CAPSTONE_DIET
353
  return NULL;
354
#else
355
512k
  return s_instruction_names[id];
356
512k
#endif
357
512k
}
358
359
#ifndef CAPSTONE_DIET
360
static const name_map group_name_maps[] = {
361
  { M68K_GRP_INVALID , NULL },
362
  { M68K_GRP_JUMP, "jump" },
363
  { M68K_GRP_RET , "ret" },
364
  { M68K_GRP_IRET, "iret" },
365
  { M68K_GRP_BRANCH_RELATIVE, "branch_relative" },
366
};
367
#endif
368
369
const char *M68K_group_name(csh handle, unsigned int id)
370
84.1k
{
371
84.1k
#ifndef CAPSTONE_DIET
372
84.1k
  return id2name(group_name_maps, ARR_SIZE(group_name_maps), id);
373
#else
374
  return NULL;
375
#endif
376
84.1k
}
377
378
#ifndef CAPSTONE_DIET
379
void M68K_reg_access(const cs_insn *insn,
380
    cs_regs regs_read, uint8_t *regs_read_count,
381
    cs_regs regs_write, uint8_t *regs_write_count)
382
0
{
383
0
  uint8_t read_count, write_count;
384
385
0
  read_count = insn->detail->regs_read_count;
386
0
  write_count = insn->detail->regs_write_count;
387
388
  // implicit registers
389
0
  memcpy(regs_read, insn->detail->regs_read,
390
0
         read_count * sizeof(insn->detail->regs_read[0]));
391
0
  memcpy(regs_write, insn->detail->regs_write,
392
0
         write_count * sizeof(insn->detail->regs_write[0]));
393
394
0
  *regs_read_count = read_count;
395
0
  *regs_write_count = write_count;
396
0
}
397
#endif
398