Coverage Report

Created: 2025-11-24 06:12

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonev5/arch/SystemZ/SystemZDisassembler.c
Line
Count
Source
1
//===------ SystemZDisassembler.cpp - Disassembler for PowerPC ------*- C++ -*-===//
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
/* Capstone Disassembly Engine */
11
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2015 */
12
13
#ifdef CAPSTONE_HAS_SYSZ
14
15
#include <stdio.h>  // DEBUG
16
#include <stdlib.h>
17
#include <string.h>
18
19
#include "../../cs_priv.h"
20
#include "../../utils.h"
21
22
#include "SystemZDisassembler.h"
23
24
#include "../../MCInst.h"
25
#include "../../MCInstrDesc.h"
26
#include "../../MCFixedLenDisassembler.h"
27
#include "../../MCRegisterInfo.h"
28
#include "../../MCDisassembler.h"
29
#include "../../MathExtras.h"
30
31
#include "SystemZMCTargetDesc.h"
32
33
static uint64_t getFeatureBits(int mode)
34
14.1k
{
35
  // support everything
36
14.1k
  return (uint64_t)-1;
37
14.1k
}
38
39
static DecodeStatus decodeRegisterClass(MCInst *Inst, uint64_t RegNo, const unsigned *Regs)
40
26.7k
{
41
  //assert(RegNo < 16 && "Invalid register");
42
26.7k
  RegNo = Regs[RegNo];
43
26.7k
  if (RegNo == 0)
44
18
    return MCDisassembler_Fail;
45
46
26.7k
  MCOperand_CreateReg0(Inst, (unsigned)RegNo);
47
26.7k
  return MCDisassembler_Success;
48
26.7k
}
49
50
static DecodeStatus DecodeGR32BitRegisterClass(MCInst *Inst, uint64_t RegNo,
51
    uint64_t Address, const void *Decoder)
52
6.66k
{
53
6.66k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_GR32Regs);
54
6.66k
}
55
56
static DecodeStatus DecodeGRH32BitRegisterClass(MCInst *Inst, uint64_t RegNo,
57
    uint64_t Address, const void *Decoder)
58
771
{
59
771
  return decodeRegisterClass(Inst, RegNo, SystemZMC_GRH32Regs);
60
771
}
61
62
static DecodeStatus DecodeGR64BitRegisterClass(MCInst *Inst, uint64_t RegNo,
63
    uint64_t Address, const void *Decoder)
64
4.30k
{
65
4.30k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_GR64Regs);
66
4.30k
}
67
68
static DecodeStatus DecodeGR128BitRegisterClass(MCInst *Inst, uint64_t RegNo,
69
    uint64_t Address, const void *Decoder)
70
2.26k
{
71
2.26k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_GR128Regs);
72
2.26k
}
73
74
static DecodeStatus DecodeADDR64BitRegisterClass(MCInst *Inst, uint64_t RegNo,
75
    uint64_t Address, const void *Decoder)
76
235
{
77
235
  return decodeRegisterClass(Inst, RegNo, SystemZMC_GR64Regs);
78
235
}
79
80
static DecodeStatus DecodeFP32BitRegisterClass(MCInst *Inst, uint64_t RegNo,
81
    uint64_t Address, const void *Decoder) 
82
2.01k
{
83
2.01k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_FP32Regs);
84
2.01k
}
85
86
static DecodeStatus DecodeFP64BitRegisterClass(MCInst *Inst, uint64_t RegNo,
87
    uint64_t Address, const void *Decoder)
88
4.38k
{
89
4.38k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_FP64Regs);
90
4.38k
}
91
92
static DecodeStatus DecodeFP128BitRegisterClass(MCInst *Inst, uint64_t RegNo,
93
    uint64_t Address, const void *Decoder)
94
624
{
95
624
  return decodeRegisterClass(Inst, RegNo, SystemZMC_FP128Regs);
96
624
}
97
98
static DecodeStatus DecodeVR32BitRegisterClass(MCInst *Inst, uint64_t RegNo,
99
    uint64_t Address, const void *Decoder)
100
239
{
101
239
  return decodeRegisterClass(Inst, RegNo, SystemZMC_VR32Regs);
102
239
}
103
104
static DecodeStatus DecodeVR64BitRegisterClass(MCInst *Inst, uint64_t RegNo,
105
    uint64_t Address, const void *Decoder)
106
368
{
107
368
  return decodeRegisterClass(Inst, RegNo, SystemZMC_VR64Regs);
108
368
}
109
110
static DecodeStatus DecodeVR128BitRegisterClass(MCInst *Inst, uint64_t RegNo,
111
    uint64_t Address, const void *Decoder)
112
4.73k
{
113
4.73k
  return decodeRegisterClass(Inst, RegNo, SystemZMC_VR128Regs);
114
4.73k
}
115
116
static DecodeStatus DecodeAR32BitRegisterClass(MCInst *Inst, uint64_t RegNo,
117
    uint64_t Address, const void *Decoder)
118
164
{
119
164
  return decodeRegisterClass(Inst, RegNo, SystemZMC_AR32Regs);
120
164
}
121
122
static DecodeStatus DecodeCR64BitRegisterClass(MCInst *Inst, uint64_t RegNo,
123
    uint64_t Address, const void *Decoder)
124
8
{
125
8
  return decodeRegisterClass(Inst, RegNo, SystemZMC_CR64Regs);
126
8
}
127
128
static DecodeStatus decodeUImmOperand(MCInst *Inst, uint64_t Imm)
129
5.92k
{
130
  //assert(isUInt<N>(Imm) && "Invalid immediate");
131
5.92k
  MCOperand_CreateImm0(Inst, Imm);
132
5.92k
  return MCDisassembler_Success;
133
5.92k
}
134
135
static DecodeStatus decodeSImmOperand(MCInst *Inst, uint64_t Imm, unsigned N)
136
519
{
137
  //assert(isUInt<N>(Imm) && "Invalid immediate");
138
519
  MCOperand_CreateImm0(Inst, SignExtend64(Imm, N));
139
519
  return MCDisassembler_Success;
140
519
}
141
142
static DecodeStatus decodeU1ImmOperand(MCInst *Inst, uint64_t Imm,
143
    uint64_t Address, const void *Decoder)
144
24
{
145
24
  return decodeUImmOperand(Inst, Imm);
146
24
}
147
148
static DecodeStatus decodeU2ImmOperand(MCInst *Inst, uint64_t Imm,
149
    uint64_t Address, const void *Decoder)
150
83
{
151
83
  return decodeUImmOperand(Inst, Imm);
152
83
}
153
154
static DecodeStatus decodeU3ImmOperand(MCInst *Inst, uint64_t Imm,
155
    uint64_t Address, const void *Decoder)
156
38
{
157
38
  return decodeUImmOperand(Inst, Imm);
158
38
}
159
160
static DecodeStatus decodeU4ImmOperand(MCInst *Inst, uint64_t Imm,
161
    uint64_t Address, const void *Decoder)
162
4.24k
{
163
4.24k
  return decodeUImmOperand(Inst, Imm);
164
4.24k
}
165
166
static DecodeStatus decodeU6ImmOperand(MCInst *Inst, uint64_t Imm,
167
    uint64_t Address, const void *Decoder)
168
63
{
169
63
  return decodeUImmOperand(Inst, Imm);
170
63
}
171
172
static DecodeStatus decodeU8ImmOperand(MCInst *Inst, uint64_t Imm,
173
    uint64_t Address, const void *Decoder)
174
783
{
175
783
  return decodeUImmOperand(Inst, Imm);
176
783
}
177
178
static DecodeStatus decodeU12ImmOperand(MCInst *Inst, uint64_t Imm,
179
    uint64_t Address, const void *Decoder)
180
17
{
181
17
  return decodeUImmOperand(Inst, Imm);
182
17
}
183
184
static DecodeStatus decodeU16ImmOperand(MCInst *Inst, uint64_t Imm,
185
    uint64_t Address, const void *Decoder)
186
623
{
187
623
  return decodeUImmOperand(Inst, Imm);
188
623
}
189
190
static DecodeStatus decodeU32ImmOperand(MCInst *Inst, uint64_t Imm,
191
    uint64_t Address, const void *Decoder)
192
58
{
193
58
  return decodeUImmOperand(Inst, Imm);
194
58
}
195
196
static DecodeStatus decodeS8ImmOperand(MCInst *Inst, uint64_t Imm,
197
    uint64_t Address, const void *Decoder)
198
229
{
199
229
  return decodeSImmOperand(Inst, Imm, 8);
200
229
}
201
202
static DecodeStatus decodeS16ImmOperand(MCInst *Inst, uint64_t Imm,
203
    uint64_t Address, const void *Decoder) 
204
270
{
205
270
  return decodeSImmOperand(Inst, Imm, 16);
206
270
}
207
208
static DecodeStatus decodeS32ImmOperand(MCInst *Inst, uint64_t Imm,
209
    uint64_t Address, const void *Decoder)
210
20
{
211
20
  return decodeSImmOperand(Inst, Imm, 32);
212
20
}
213
214
static DecodeStatus decodePCDBLOperand(MCInst *Inst, uint64_t Imm,
215
    uint64_t Address, unsigned N)
216
1.02k
{
217
  //assert(isUInt<N>(Imm) && "Invalid PC-relative offset");
218
1.02k
  MCOperand_CreateImm0(Inst, SignExtend64(Imm, N) * 2 + Address);
219
1.02k
  return MCDisassembler_Success;
220
1.02k
}
221
222
static DecodeStatus decodePC12DBLBranchOperand(MCInst *Inst, uint64_t Imm,
223
    uint64_t Address,
224
    const void *Decoder)
225
20
{
226
20
  return decodePCDBLOperand(Inst, Imm, Address, 12);
227
20
}
228
229
static DecodeStatus decodePC16DBLBranchOperand(MCInst *Inst, uint64_t Imm,
230
    uint64_t Address,
231
    const void *Decoder)
232
588
{
233
588
  return decodePCDBLOperand(Inst, Imm, Address, 16);
234
588
}
235
236
static DecodeStatus decodePC24DBLBranchOperand(MCInst *Inst, uint64_t Imm,
237
    uint64_t Address,
238
    const void *Decoder)
239
20
{
240
20
  return decodePCDBLOperand(Inst, Imm, Address, 24);
241
20
}
242
243
static DecodeStatus decodePC32DBLBranchOperand(MCInst *Inst, uint64_t Imm,
244
    uint64_t Address,
245
    const void *Decoder)
246
254
{
247
254
  return decodePCDBLOperand(Inst, Imm, Address, 32);
248
254
}
249
250
static DecodeStatus decodePC32DBLOperand(MCInst *Inst, uint64_t Imm,
251
    uint64_t Address,
252
    const void *Decoder)
253
145
{
254
145
  return decodePCDBLOperand(Inst, Imm, Address, 32);
255
145
}
256
257
static DecodeStatus decodeBDAddr12Operand(MCInst *Inst, uint64_t Field,
258
    const unsigned *Regs)
259
2.67k
{
260
2.67k
  uint64_t Base = Field >> 12;
261
2.67k
  uint64_t Disp = Field & 0xfff;
262
  //assert(Base < 16 && "Invalid BDAddr12");
263
264
2.67k
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
265
2.67k
  MCOperand_CreateImm0(Inst, Disp);
266
267
2.67k
  return MCDisassembler_Success;
268
2.67k
}
269
270
static DecodeStatus decodeBDAddr20Operand(MCInst *Inst, uint64_t Field,
271
    const unsigned *Regs)
272
988
{
273
988
  uint64_t Base = Field >> 20;
274
988
  uint64_t Disp = ((Field << 12) & 0xff000) | ((Field >> 8) & 0xfff);
275
  //assert(Base < 16 && "Invalid BDAddr20");
276
277
988
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
278
988
  MCOperand_CreateImm0(Inst, SignExtend64(Disp, 20));
279
988
  return MCDisassembler_Success;
280
988
}
281
282
static DecodeStatus decodeBDXAddr12Operand(MCInst *Inst, uint64_t Field,
283
    const unsigned *Regs)
284
2.34k
{
285
2.34k
  uint64_t Index = Field >> 16;
286
2.34k
  uint64_t Base = (Field >> 12) & 0xf;
287
2.34k
  uint64_t Disp = Field & 0xfff;
288
289
  //assert(Index < 16 && "Invalid BDXAddr12");
290
2.34k
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
291
2.34k
  MCOperand_CreateImm0(Inst, Disp);
292
2.34k
  MCOperand_CreateReg0(Inst, Index == 0 ? 0 : Regs[Index]);
293
294
2.34k
  return MCDisassembler_Success;
295
2.34k
}
296
297
static DecodeStatus decodeBDXAddr20Operand(MCInst *Inst, uint64_t Field,
298
    const unsigned *Regs)
299
97
{
300
97
  uint64_t Index = Field >> 24;
301
97
  uint64_t Base = (Field >> 20) & 0xf;
302
97
  uint64_t Disp = ((Field & 0xfff00) >> 8) | ((Field & 0xff) << 12);
303
304
  //assert(Index < 16 && "Invalid BDXAddr20");
305
97
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
306
97
  MCOperand_CreateImm0(Inst, SignExtend64(Disp, 20));
307
97
  MCOperand_CreateReg0(Inst, Index == 0 ? 0 : Regs[Index]);
308
309
97
  return MCDisassembler_Success;
310
97
}
311
312
static DecodeStatus decodeBDLAddr12Len8Operand(MCInst *Inst, uint64_t Field,
313
    const unsigned *Regs)
314
1.04k
{
315
1.04k
  uint64_t Length = Field >> 16;
316
1.04k
  uint64_t Base = (Field >> 12) & 0xf;
317
1.04k
  uint64_t Disp = Field & 0xfff;
318
  //assert(Length < 256 && "Invalid BDLAddr12Len8");
319
320
1.04k
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
321
1.04k
  MCOperand_CreateImm0(Inst, Disp);
322
1.04k
  MCOperand_CreateImm0(Inst, Length + 1);
323
324
1.04k
  return MCDisassembler_Success;
325
1.04k
}
326
327
static DecodeStatus decodeBDRAddr12Operand(MCInst *Inst, uint64_t Field,
328
    const unsigned *Regs)
329
162
{
330
162
  uint64_t Length = Field >> 16;
331
162
  uint64_t Base = (Field >> 12) & 0xf;
332
162
  uint64_t Disp = Field & 0xfff;
333
  //assert(Length < 16 && "Invalid BDRAddr12");
334
335
162
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
336
162
  MCOperand_CreateImm0(Inst, Disp);
337
162
  MCOperand_CreateReg0(Inst, Regs[Length]);
338
339
162
  return MCDisassembler_Success;
340
162
}
341
342
static DecodeStatus decodeBDVAddr12Operand(MCInst *Inst, uint64_t Field,
343
    const unsigned *Regs)
344
31
{
345
31
  uint64_t Index = Field >> 16;
346
31
  uint64_t Base = (Field >> 12) & 0xf;
347
31
  uint64_t Disp = Field & 0xfff;
348
  //assert(Index < 32 && "Invalid BDVAddr12");
349
350
31
  MCOperand_CreateReg0(Inst, Base == 0 ? 0 : Regs[Base]);
351
31
  MCOperand_CreateImm0(Inst, Disp);
352
31
  MCOperand_CreateReg0(Inst, SystemZMC_VR128Regs[Index]);
353
354
31
  return MCDisassembler_Success;
355
31
}
356
357
static DecodeStatus decodeBDAddr32Disp12Operand(MCInst *Inst, uint64_t Field,
358
    uint64_t Address, const void *Decoder)
359
310
{
360
310
  return decodeBDAddr12Operand(Inst, Field, SystemZMC_GR32Regs);
361
310
}
362
363
static DecodeStatus decodeBDAddr32Disp20Operand(MCInst *Inst, uint64_t Field,
364
    uint64_t Address, const void *Decoder)
365
206
{
366
206
  return decodeBDAddr20Operand(Inst, Field, SystemZMC_GR32Regs);
367
206
}
368
369
static DecodeStatus decodeBDAddr64Disp12Operand(MCInst *Inst, uint64_t Field,
370
    uint64_t Address, const void *Decoder)
371
2.36k
{
372
2.36k
  return decodeBDAddr12Operand(Inst, Field, SystemZMC_GR64Regs);
373
2.36k
}
374
375
static DecodeStatus decodeBDAddr64Disp20Operand(MCInst *Inst, uint64_t Field,
376
    uint64_t Address, const void *Decoder)
377
782
{
378
782
  return decodeBDAddr20Operand(Inst, Field, SystemZMC_GR64Regs);
379
782
}
380
381
static DecodeStatus decodeBDXAddr64Disp12Operand(MCInst *Inst, uint64_t Field,
382
    uint64_t Address, const void *Decoder)
383
2.34k
{
384
2.34k
  return decodeBDXAddr12Operand(Inst, Field, SystemZMC_GR64Regs);
385
2.34k
}
386
387
static DecodeStatus decodeBDXAddr64Disp20Operand(MCInst *Inst, uint64_t Field,
388
    uint64_t Address, const void *Decoder)
389
97
{
390
97
  return decodeBDXAddr20Operand(Inst, Field, SystemZMC_GR64Regs);
391
97
}
392
393
static DecodeStatus decodeBDLAddr64Disp12Len4Operand(MCInst *Inst, uint64_t Field,
394
    uint64_t Address, const void *Decoder)
395
408
{
396
408
  return decodeBDLAddr12Len8Operand(Inst, Field, SystemZMC_GR64Regs);
397
408
}
398
399
static DecodeStatus decodeBDLAddr64Disp12Len8Operand(MCInst *Inst, uint64_t Field,
400
    uint64_t Address, const void *Decoder)
401
633
{
402
633
  return decodeBDLAddr12Len8Operand(Inst, Field, SystemZMC_GR64Regs);
403
633
}
404
405
static DecodeStatus decodeBDRAddr64Disp12Operand(MCInst *Inst, uint64_t Field,
406
    uint64_t Address, const void *Decoder)
407
162
{
408
162
  return decodeBDRAddr12Operand(Inst, Field, SystemZMC_GR64Regs);
409
162
}
410
411
static DecodeStatus decodeBDVAddr64Disp12Operand(MCInst *Inst, uint64_t Field,
412
    uint64_t Address, const void *Decoder)
413
31
{
414
31
  return decodeBDVAddr12Operand(Inst, Field, SystemZMC_GR64Regs);
415
31
}
416
417
418
#define GET_SUBTARGETINFO_ENUM
419
#include "SystemZGenSubtargetInfo.inc"
420
#include "SystemZGenDisassemblerTables.inc"
421
bool SystemZ_getInstruction(csh ud, const uint8_t *code, size_t code_len, MCInst *MI,
422
    uint16_t *size, uint64_t address, void *info)
423
14.3k
{
424
14.3k
  uint64_t Inst;
425
14.3k
  const uint8_t *Table;
426
14.3k
  uint16_t I; 
427
428
  // The top 2 bits of the first byte specify the size.
429
14.3k
  if (*code < 0x40) {
430
2.73k
    *size = 2;
431
2.73k
    Table = DecoderTable16;
432
11.5k
  } else if (*code < 0xc0) {
433
4.95k
    *size = 4;
434
4.95k
    Table = DecoderTable32;
435
6.61k
  } else {
436
6.61k
    *size = 6;
437
6.61k
    Table = DecoderTable48;
438
6.61k
  }
439
440
14.3k
  if (code_len < *size)
441
    // short of input data
442
106
    return false;
443
444
14.1k
  if (MI->flat_insn->detail) {
445
14.1k
    memset(MI->flat_insn->detail, 0, offsetof(cs_detail, sysz)+sizeof(cs_sysz));
446
14.1k
  }
447
448
  // Construct the instruction.
449
14.1k
  Inst = 0;
450
78.6k
  for (I = 0; I < *size; ++I)
451
64.5k
    Inst = (Inst << 8) | code[I];
452
453
14.1k
  return decodeInstruction(Table, MI, Inst, address, info, 0);
454
14.3k
}
455
456
#define GET_REGINFO_ENUM
457
#define GET_REGINFO_MC_DESC
458
#include "SystemZGenRegisterInfo.inc"
459
void SystemZ_init(MCRegisterInfo *MRI)
460
612
{
461
  /*
462
  InitMCRegisterInfo(SystemZRegDesc, 98, RA, PC,
463
      SystemZMCRegisterClasses, 12,
464
      SystemZRegUnitRoots,
465
      49,
466
      SystemZRegDiffLists,
467
      SystemZRegStrings,
468
      SystemZSubRegIdxLists,
469
      7,
470
      SystemZSubRegIdxRanges,
471
      SystemZRegEncodingTable);
472
  */
473
474
612
  MCRegisterInfo_InitMCRegisterInfo(MRI, SystemZRegDesc, 194,
475
612
      0, 0,
476
612
      SystemZMCRegisterClasses, 21,
477
612
      0, 0,
478
612
      SystemZRegDiffLists,
479
612
      0,
480
612
      SystemZSubRegIdxLists, 7,
481
612
      0);
482
612
}
483
484
#endif