Coverage Report

Created: 2025-07-01 07:03

/src/capstonev5/arch/Sparc/SparcInstPrinter.c
Line
Count
Source (jump to first uncovered line)
1
//===-- SparcInstPrinter.cpp - Convert Sparc MCInst to assembly syntax --------===//
2
//
3
//                     The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
//
10
// This class prints an Sparc MCInst to a .s file.
11
//
12
//===----------------------------------------------------------------------===//
13
14
/* Capstone Disassembly Engine */
15
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2015 */
16
17
#ifdef CAPSTONE_HAS_SPARC
18
19
#ifdef _MSC_VER
20
#define _CRT_SECURE_NO_WARNINGS
21
#endif
22
23
#include <stdio.h>
24
#include <stdlib.h>
25
#include <string.h>
26
#include <limits.h>
27
28
#include "SparcInstPrinter.h"
29
#include "../../MCInst.h"
30
#include "../../utils.h"
31
#include "../../SStream.h"
32
#include "../../MCRegisterInfo.h"
33
#include "../../MathExtras.h"
34
#include "SparcMapping.h"
35
36
#include "Sparc.h"
37
38
static const char *getRegisterName(unsigned RegNo);
39
static void printInstruction(MCInst *MI, SStream *O, const MCRegisterInfo *MRI);
40
static void printMemOperand(MCInst *MI, int opNum, SStream *O, const char *Modifier);
41
static void printOperand(MCInst *MI, int opNum, SStream *O);
42
43
static void Sparc_add_hint(MCInst *MI, unsigned int hint)
44
1.33k
{
45
1.33k
  if (MI->csh->detail) {
46
1.33k
    MI->flat_insn->detail->sparc.hint = hint;
47
1.33k
  }
48
1.33k
}
49
50
static void Sparc_add_reg(MCInst *MI, unsigned int reg)
51
3.17k
{
52
3.17k
  if (MI->csh->detail) {
53
3.17k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].type = SPARC_OP_REG;
54
3.17k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].reg = reg;
55
3.17k
    MI->flat_insn->detail->sparc.op_count++;
56
3.17k
  }
57
3.17k
}
58
59
static void set_mem_access(MCInst *MI, bool status)
60
5.77k
{
61
5.77k
  if (MI->csh->detail != CS_OPT_ON)
62
0
    return;
63
64
5.77k
  MI->csh->doing_mem = status;
65
66
5.77k
  if (status) {
67
2.88k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].type = SPARC_OP_MEM;
68
2.88k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.base = SPARC_REG_INVALID;
69
2.88k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.disp = 0;
70
2.88k
  } else {
71
    // done, create the next operand slot
72
2.88k
    MI->flat_insn->detail->sparc.op_count++;
73
2.88k
  }
74
5.77k
}
75
76
void Sparc_post_printer(csh ud, cs_insn *insn, char *insn_asm, MCInst *mci)
77
51.5k
{
78
51.5k
  if (((cs_struct *)ud)->detail != CS_OPT_ON)
79
0
    return;
80
81
  // fix up some instructions
82
51.5k
  if (insn->id == SPARC_INS_CASX) {
83
    // first op is actually a memop, not regop
84
55
    insn->detail->sparc.operands[0].type = SPARC_OP_MEM;
85
55
    insn->detail->sparc.operands[0].mem.base = (uint8_t)insn->detail->sparc.operands[0].reg;
86
55
    insn->detail->sparc.operands[0].mem.disp = 0;
87
55
  }
88
51.5k
}
89
90
static void printRegName(SStream *OS, unsigned RegNo)
91
43.2k
{
92
43.2k
  SStream_concat0(OS, "%");
93
43.2k
  SStream_concat0(OS, getRegisterName(RegNo));
94
43.2k
}
95
96
#define GET_INSTRINFO_ENUM
97
#include "SparcGenInstrInfo.inc"
98
99
#define GET_REGINFO_ENUM
100
#include "SparcGenRegisterInfo.inc"
101
102
static bool printSparcAliasInstr(MCInst *MI, SStream *O)
103
31.5k
{
104
31.5k
  switch (MCInst_getOpcode(MI)) {
105
30.0k
    default: return false;
106
230
    case SP_JMPLrr:
107
823
    case SP_JMPLri:
108
823
         if (MCInst_getNumOperands(MI) != 3)
109
0
           return false;
110
823
         if (!MCOperand_isReg(MCInst_getOperand(MI, 0)))
111
0
           return false;
112
113
823
         switch (MCOperand_getReg(MCInst_getOperand(MI, 0))) {
114
83
           default: return false;
115
679
           case SP_G0: // jmp $addr | ret | retl
116
679
                if (MCOperand_isImm(MCInst_getOperand(MI, 2)) &&
117
679
                  MCOperand_getImm(MCInst_getOperand(MI, 2)) == 8) {
118
153
                  switch(MCOperand_getReg(MCInst_getOperand(MI, 1))) {
119
20
                    default: break;
120
127
                    case SP_I7: SStream_concat0(O, "ret"); MCInst_setOpcodePub(MI, SPARC_INS_RET); return true;
121
6
                    case SP_O7: SStream_concat0(O, "retl"); MCInst_setOpcodePub(MI, SPARC_INS_RETL); return true;
122
153
                  }
123
153
                }
124
125
546
                SStream_concat0(O, "jmp\t");
126
546
                MCInst_setOpcodePub(MI, SPARC_INS_JMP);
127
546
                printMemOperand(MI, 1, O, NULL);
128
546
                return true;
129
61
           case SP_O7: // call $addr
130
61
                SStream_concat0(O, "call ");
131
61
                MCInst_setOpcodePub(MI, SPARC_INS_CALL);
132
61
                printMemOperand(MI, 1, O, NULL);
133
61
                return true;
134
823
         }
135
201
    case SP_V9FCMPS:
136
252
    case SP_V9FCMPD:
137
294
    case SP_V9FCMPQ:
138
329
    case SP_V9FCMPES:
139
351
    case SP_V9FCMPED:
140
700
    case SP_V9FCMPEQ:
141
700
         if (MI->csh->mode & CS_MODE_V9 || (MCInst_getNumOperands(MI) != 3) ||
142
700
             (!MCOperand_isReg(MCInst_getOperand(MI, 0))) ||
143
700
             (MCOperand_getReg(MCInst_getOperand(MI, 0)) != SP_FCC0))
144
700
             return false;
145
         // if V8, skip printing %fcc0.
146
0
         switch(MCInst_getOpcode(MI)) {
147
0
           default:
148
0
           case SP_V9FCMPS:  SStream_concat0(O, "fcmps\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPS); break;
149
0
           case SP_V9FCMPD:  SStream_concat0(O, "fcmpd\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPD); break;
150
0
           case SP_V9FCMPQ:  SStream_concat0(O, "fcmpq\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPQ); break;
151
0
           case SP_V9FCMPES: SStream_concat0(O, "fcmpes\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPES); break;
152
0
           case SP_V9FCMPED: SStream_concat0(O, "fcmped\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPED); break;
153
0
           case SP_V9FCMPEQ: SStream_concat0(O, "fcmpeq\t"); MCInst_setOpcodePub(MI, SPARC_INS_FCMPEQ); break;
154
0
         }
155
0
         printOperand(MI, 1, O);
156
0
         SStream_concat0(O, ", ");
157
0
         printOperand(MI, 2, O);
158
0
         return true;
159
31.5k
  }
160
31.5k
}
161
162
static void printOperand(MCInst *MI, int opNum, SStream *O)
163
81.7k
{
164
81.7k
  int64_t Imm;
165
81.7k
  unsigned reg;
166
81.7k
  MCOperand *MO = MCInst_getOperand(MI, opNum);
167
168
81.7k
  if (MCOperand_isReg(MO)) {
169
39.6k
    reg = MCOperand_getReg(MO);
170
39.6k
    printRegName(O, reg);
171
39.6k
    reg = Sparc_map_register(reg);
172
173
39.6k
    if (MI->csh->detail) {
174
39.6k
      if (MI->csh->doing_mem) {
175
3.69k
        if (MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.base)
176
812
          MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.index = (uint8_t)reg;
177
2.88k
        else
178
2.88k
          MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.base = (uint8_t)reg;
179
35.9k
      } else {
180
35.9k
        MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].type = SPARC_OP_REG;
181
35.9k
        MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].reg = reg;
182
35.9k
        MI->flat_insn->detail->sparc.op_count++;
183
35.9k
      }
184
39.6k
    }
185
186
39.6k
    return;
187
39.6k
  }
188
189
42.1k
  if (MCOperand_isImm(MO)) {
190
42.1k
    Imm = (int)MCOperand_getImm(MO);
191
192
    // Conditional branches displacements needs to be signextended to be
193
    // able to jump backwards.
194
    //
195
    // Displacements are measured as the number of instructions forward or
196
    // backward, so they need to be multiplied by 4
197
42.1k
    switch (MI->Opcode) {
198
10.6k
      case SP_CALL:
199
        // Imm = SignExtend32(Imm, 30);
200
10.6k
        Imm += MI->address;
201
10.6k
        break;
202
203
      // Branch on integer condition with prediction (BPcc)
204
      // Branch on floating point condition with prediction (FBPfcc)
205
112
      case SP_BPICC:
206
283
      case SP_BPICCA:
207
1.97k
      case SP_BPICCANT:
208
4.64k
      case SP_BPICCNT:
209
4.87k
      case SP_BPXCC:
210
5.30k
      case SP_BPXCCA:
211
6.24k
      case SP_BPXCCANT:
212
7.48k
      case SP_BPXCCNT:
213
7.96k
      case SP_BPFCC:
214
8.23k
      case SP_BPFCCA:
215
10.2k
      case SP_BPFCCANT:
216
12.2k
      case SP_BPFCCNT:
217
12.2k
        Imm = SignExtend32(Imm, 19);
218
12.2k
        Imm = MI->address + Imm * 4;
219
12.2k
        break;
220
221
      // Branch on integer condition (Bicc)
222
      // Branch on floating point condition (FBfcc)
223
172
      case SP_BA:
224
1.96k
      case SP_BCOND:
225
3.76k
      case SP_BCONDA:
226
4.14k
      case SP_FBCOND:
227
4.60k
      case SP_FBCONDA:
228
4.60k
        Imm = SignExtend32(Imm, 22);
229
4.60k
        Imm = MI->address + Imm * 4;
230
4.60k
        break;
231
232
      // Branch on integer register with prediction (BPr)
233
235
      case SP_BPGEZapn:
234
318
      case SP_BPGEZapt:
235
421
      case SP_BPGEZnapn:
236
474
      case SP_BPGEZnapt:
237
487
      case SP_BPGZapn:
238
544
      case SP_BPGZapt:
239
715
      case SP_BPGZnapn:
240
878
      case SP_BPGZnapt:
241
897
      case SP_BPLEZapn:
242
1.06k
      case SP_BPLEZapt:
243
1.07k
      case SP_BPLEZnapn:
244
1.16k
      case SP_BPLEZnapt:
245
1.20k
      case SP_BPLZapn:
246
1.39k
      case SP_BPLZapt:
247
1.41k
      case SP_BPLZnapn:
248
1.60k
      case SP_BPLZnapt:
249
1.68k
      case SP_BPNZapn:
250
1.71k
      case SP_BPNZapt:
251
1.76k
      case SP_BPNZnapn:
252
1.78k
      case SP_BPNZnapt:
253
1.79k
      case SP_BPZapn:
254
1.80k
      case SP_BPZapt:
255
1.84k
      case SP_BPZnapn:
256
1.90k
      case SP_BPZnapt:
257
1.90k
        Imm = SignExtend32(Imm, 16);
258
1.90k
        Imm = MI->address + Imm * 4;
259
1.90k
        break;
260
42.1k
    }
261
    
262
42.1k
    printInt64(O, Imm);
263
264
42.1k
    if (MI->csh->detail) {
265
42.1k
      if (MI->csh->doing_mem) {
266
1.71k
        MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].mem.disp = Imm;
267
40.3k
      } else {
268
40.3k
        MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].type = SPARC_OP_IMM;
269
40.3k
        MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].imm = Imm;
270
40.3k
        MI->flat_insn->detail->sparc.op_count++;
271
40.3k
      }
272
42.1k
    }
273
42.1k
  }
274
275
42.1k
  return;
276
42.1k
}
277
278
static void printMemOperand(MCInst *MI, int opNum, SStream *O, const char *Modifier)
279
2.88k
{
280
2.88k
  MCOperand *MO;
281
282
2.88k
  set_mem_access(MI, true);
283
2.88k
  printOperand(MI, opNum, O);
284
285
  // If this is an ADD operand, emit it like normal operands.
286
2.88k
  if (Modifier && !strcmp(Modifier, "arith")) {
287
0
    SStream_concat0(O, ", ");
288
0
    printOperand(MI, opNum + 1, O);
289
0
    set_mem_access(MI, false);
290
0
    return;
291
0
  }
292
293
2.88k
  MO = MCInst_getOperand(MI, opNum + 1);
294
295
2.88k
  if (MCOperand_isReg(MO) && (MCOperand_getReg(MO) == SP_G0)) {
296
186
    set_mem_access(MI, false);
297
186
    return;   // don't print "+%g0"
298
186
  }
299
300
2.70k
  if (MCOperand_isImm(MO) && (MCOperand_getImm(MO) == 0)) {
301
173
    set_mem_access(MI, false);
302
173
    return;   // don't print "+0"
303
173
  }
304
305
2.52k
  SStream_concat0(O, "+");  // qq
306
307
2.52k
  printOperand(MI, opNum + 1, O);
308
2.52k
  set_mem_access(MI, false);
309
2.52k
}
310
311
static void printCCOperand(MCInst *MI, int opNum, SStream *O)
312
5.26k
{
313
5.26k
  int CC = (int)MCOperand_getImm(MCInst_getOperand(MI, opNum)) + 256;
314
315
5.26k
  switch (MCInst_getOpcode(MI)) {
316
2.42k
    default: break;
317
2.42k
    case SP_FBCOND:
318
839
    case SP_FBCONDA:
319
1.32k
    case SP_BPFCC:
320
1.58k
    case SP_BPFCCA:
321
1.58k
    case SP_BPFCCNT:
322
1.58k
    case SP_BPFCCANT:
323
2.18k
    case SP_MOVFCCrr:  case SP_V9MOVFCCrr:
324
2.60k
    case SP_MOVFCCri:  case SP_V9MOVFCCri:
325
2.69k
    case SP_FMOVS_FCC: case SP_V9FMOVS_FCC:
326
2.78k
    case SP_FMOVD_FCC: case SP_V9FMOVD_FCC:
327
2.84k
    case SP_FMOVQ_FCC: case SP_V9FMOVQ_FCC:
328
         // Make sure CC is a fp conditional flag.
329
2.84k
         CC = (CC < 16+256) ? (CC + 16) : CC;
330
2.84k
         break;
331
5.26k
  }
332
333
5.26k
  SStream_concat0(O, SPARCCondCodeToString((sparc_cc)CC));
334
335
5.26k
  if (MI->csh->detail)
336
5.26k
    MI->flat_insn->detail->sparc.cc = (sparc_cc)CC;
337
5.26k
}
338
339
340
static bool printGetPCX(MCInst *MI, unsigned opNum, SStream *O)
341
0
{
342
0
  return true;
343
0
}
344
345
346
#define PRINT_ALIAS_INSTR
347
#include "SparcGenAsmWriter.inc"
348
349
void Sparc_printInst(MCInst *MI, SStream *O, void *Info)
350
51.5k
{
351
51.5k
  char *mnem, *p;
352
51.5k
  char instr[64]; // Sparc has no instruction this long
353
354
51.5k
  mnem = printAliasInstr(MI, O, Info);
355
51.5k
  if (mnem) {
356
    // fixup instruction id due to the change in alias instruction
357
19.9k
    unsigned cpy_len = sizeof(instr) - 1 < strlen(mnem) ? sizeof(instr) - 1 : strlen(mnem);
358
19.9k
    memcpy(instr, mnem, cpy_len);
359
19.9k
    instr[cpy_len] = '\0';
360
    // does this contains hint with a coma?
361
19.9k
    p = strchr(instr, ',');
362
19.9k
    if (p)
363
12.3k
      *p = '\0'; // now instr only has instruction mnemonic
364
19.9k
    MCInst_setOpcodePub(MI, Sparc_map_insn(instr));
365
19.9k
    switch(MCInst_getOpcode(MI)) {
366
1.79k
      case SP_BCOND:
367
3.59k
      case SP_BCONDA:
368
5.28k
      case SP_BPICCANT:
369
7.96k
      case SP_BPICCNT:
370
8.89k
      case SP_BPXCCANT:
371
10.1k
      case SP_BPXCCNT:
372
12.6k
      case SP_TXCCri:
373
14.7k
      case SP_TXCCrr:
374
14.7k
        if (MI->csh->detail) {
375
          // skip 'b', 't'
376
14.7k
          MI->flat_insn->detail->sparc.cc = Sparc_map_ICC(instr + 1);
377
14.7k
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
378
14.7k
        }
379
14.7k
        break;
380
2.05k
      case SP_BPFCCANT:
381
4.04k
      case SP_BPFCCNT:
382
4.04k
        if (MI->csh->detail) {
383
          // skip 'fb'
384
4.04k
          MI->flat_insn->detail->sparc.cc = Sparc_map_FCC(instr + 2);
385
4.04k
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
386
4.04k
        }
387
4.04k
        break;
388
0
      case SP_FMOVD_ICC:
389
0
      case SP_FMOVD_XCC:
390
0
      case SP_FMOVQ_ICC:
391
0
      case SP_FMOVQ_XCC:
392
0
      case SP_FMOVS_ICC:
393
0
      case SP_FMOVS_XCC:
394
0
        if (MI->csh->detail) {
395
          // skip 'fmovd', 'fmovq', 'fmovs'
396
0
          MI->flat_insn->detail->sparc.cc = Sparc_map_ICC(instr + 5);
397
0
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
398
0
        }
399
0
        break;
400
0
      case SP_MOVICCri:
401
0
      case SP_MOVICCrr:
402
0
      case SP_MOVXCCri:
403
0
      case SP_MOVXCCrr:
404
0
        if (MI->csh->detail) {
405
          // skip 'mov'
406
0
          MI->flat_insn->detail->sparc.cc = Sparc_map_ICC(instr + 3);
407
0
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
408
0
        }
409
0
        break;
410
0
      case SP_V9FMOVD_FCC:
411
0
      case SP_V9FMOVQ_FCC:
412
0
      case SP_V9FMOVS_FCC:
413
0
        if (MI->csh->detail) {
414
          // skip 'fmovd', 'fmovq', 'fmovs'
415
0
          MI->flat_insn->detail->sparc.cc = Sparc_map_FCC(instr + 5);
416
0
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
417
0
        }
418
0
        break;
419
0
      case SP_V9MOVFCCri:
420
0
      case SP_V9MOVFCCrr:
421
0
        if (MI->csh->detail) {
422
          // skip 'mov'
423
0
          MI->flat_insn->detail->sparc.cc = Sparc_map_FCC(instr + 3);
424
0
          MI->flat_insn->detail->sparc.hint = Sparc_map_hint(mnem);
425
0
        }
426
0
        break;
427
1.13k
      default:
428
1.13k
        break;
429
19.9k
    }
430
19.9k
    cs_mem_free(mnem);
431
31.5k
  } else {
432
31.5k
    if (!printSparcAliasInstr(MI, O))
433
30.8k
      printInstruction(MI, O, NULL);
434
31.5k
  }
435
51.5k
}
436
437
void Sparc_addReg(MCInst *MI, int reg)
438
11.1k
{
439
11.1k
  if (MI->csh->detail) {
440
11.1k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].type = SPARC_OP_REG;
441
11.1k
    MI->flat_insn->detail->sparc.operands[MI->flat_insn->detail->sparc.op_count].reg = reg;
442
11.1k
    MI->flat_insn->detail->sparc.op_count++;
443
11.1k
  }
444
11.1k
}
445
446
#endif