1 //===- AMDGPUDisassembler.hpp - Disassembler for AMDGPU ISA -----*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 ///
11 /// This file contains declaration for AMDGPU ISA disassembler
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_LIB_TARGET_AMDGPU_DISASSEMBLER_AMDGPUDISASSEMBLER_H
16 #define LLVM_LIB_TARGET_AMDGPU_DISASSEMBLER_AMDGPUDISASSEMBLER_H
17 
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/MC/MCContext.h"
20 #include "llvm/MC/MCInstrInfo.h"
21 #include "llvm/MC/MCDisassembler/MCDisassembler.h"
22 #include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
23 #include "llvm/MC/MCDisassembler/MCSymbolizer.h"
24 
25 #include <algorithm>
26 #include <cstdint>
27 #include <memory>
28 
29 namespace llvm {
30 
31 class MCInst;
32 class MCOperand;
33 class MCSubtargetInfo;
34 class Twine;
35 
36 //===----------------------------------------------------------------------===//
37 // AMDGPUDisassembler
38 //===----------------------------------------------------------------------===//
39 
40 class AMDGPUDisassembler : public MCDisassembler {
41 private:
42   std::unique_ptr<MCInstrInfo const> const MCII;
43   const MCRegisterInfo &MRI;
44   const unsigned TargetMaxInstBytes;
45   mutable ArrayRef<uint8_t> Bytes;
46   mutable uint32_t Literal;
47   mutable bool HasLiteral;
48 
49 public:
50   AMDGPUDisassembler(const MCSubtargetInfo &STI, MCContext &Ctx,
51                      MCInstrInfo const *MCII);
52   ~AMDGPUDisassembler() override = default;
53 
54   DecodeStatus getInstruction(MCInst &MI, uint64_t &Size,
55                               ArrayRef<uint8_t> Bytes, uint64_t Address,
56                               raw_ostream &WS, raw_ostream &CS) const override;
57 
58   const char* getRegClassName(unsigned RegClassID) const;
59 
60   MCOperand createRegOperand(unsigned int RegId) const;
61   MCOperand createRegOperand(unsigned RegClassID, unsigned Val) const;
62   MCOperand createSRegOperand(unsigned SRegClassID, unsigned Val) const;
63 
64   MCOperand errOperand(unsigned V, const Twine& ErrMsg) const;
65 
66   DecodeStatus tryDecodeInst(const uint8_t* Table, MCInst &MI, uint64_t Inst,
67                              uint64_t Address) const;
68 
69   DecodeStatus convertSDWAInst(MCInst &MI) const;
70   DecodeStatus convertMIMGInst(MCInst &MI) const;
71 
72   MCOperand decodeOperand_VGPR_32(unsigned Val) const;
73   MCOperand decodeOperand_VRegOrLds_32(unsigned Val) const;
74 
75   MCOperand decodeOperand_VS_32(unsigned Val) const;
76   MCOperand decodeOperand_VS_64(unsigned Val) const;
77   MCOperand decodeOperand_VS_128(unsigned Val) const;
78   MCOperand decodeOperand_VSrc16(unsigned Val) const;
79   MCOperand decodeOperand_VSrcV216(unsigned Val) const;
80 
81   MCOperand decodeOperand_VReg_64(unsigned Val) const;
82   MCOperand decodeOperand_VReg_96(unsigned Val) const;
83   MCOperand decodeOperand_VReg_128(unsigned Val) const;
84 
85   MCOperand decodeOperand_SReg_32(unsigned Val) const;
86   MCOperand decodeOperand_SReg_32_XM0_XEXEC(unsigned Val) const;
87   MCOperand decodeOperand_SReg_32_XEXEC_HI(unsigned Val) const;
88   MCOperand decodeOperand_SRegOrLds_32(unsigned Val) const;
89   MCOperand decodeOperand_SReg_64(unsigned Val) const;
90   MCOperand decodeOperand_SReg_64_XEXEC(unsigned Val) const;
91   MCOperand decodeOperand_SReg_128(unsigned Val) const;
92   MCOperand decodeOperand_SReg_256(unsigned Val) const;
93   MCOperand decodeOperand_SReg_512(unsigned Val) const;
94 
95   enum OpWidthTy {
96     OPW32,
97     OPW64,
98     OPW128,
99     OPW256,
100     OPW512,
101     OPW16,
102     OPWV216,
103     OPW_LAST_,
104     OPW_FIRST_ = OPW32
105   };
106 
107   unsigned getVgprClassId(const OpWidthTy Width) const;
108   unsigned getSgprClassId(const OpWidthTy Width) const;
109   unsigned getTtmpClassId(const OpWidthTy Width) const;
110 
111   static MCOperand decodeIntImmed(unsigned Imm);
112   static MCOperand decodeFPImmed(OpWidthTy Width, unsigned Imm);
113   MCOperand decodeLiteralConstant() const;
114 
115   MCOperand decodeSrcOp(const OpWidthTy Width, unsigned Val) const;
116   MCOperand decodeDstOp(const OpWidthTy Width, unsigned Val) const;
117   MCOperand decodeSpecialReg32(unsigned Val) const;
118   MCOperand decodeSpecialReg64(unsigned Val) const;
119 
120   MCOperand decodeSDWASrc(const OpWidthTy Width, unsigned Val) const;
121   MCOperand decodeSDWASrc16(unsigned Val) const;
122   MCOperand decodeSDWASrc32(unsigned Val) const;
123   MCOperand decodeSDWAVopcDst(unsigned Val) const;
124 
125   int getTTmpIdx(unsigned Val) const;
126 
127   bool isVI() const;
128   bool isGFX9() const;
129   bool isGFX10() const;
130   };
131 
132 //===----------------------------------------------------------------------===//
133 // AMDGPUSymbolizer
134 //===----------------------------------------------------------------------===//
135 
136 class AMDGPUSymbolizer : public MCSymbolizer {
137 private:
138   void *DisInfo;
139 
140 public:
141   AMDGPUSymbolizer(MCContext &Ctx, std::unique_ptr<MCRelocationInfo> &&RelInfo,
142                    void *disInfo)
143                    : MCSymbolizer(Ctx, std::move(RelInfo)), DisInfo(disInfo) {}
144 
145   bool tryAddingSymbolicOperand(MCInst &Inst, raw_ostream &cStream,
146                                 int64_t Value, uint64_t Address,
147                                 bool IsBranch, uint64_t Offset,
148                                 uint64_t InstSize) override;
149 
150   void tryAddingPcLoadReferenceComment(raw_ostream &cStream,
151                                        int64_t Value,
152                                        uint64_t Address) override;
153 };
154 
155 } // end namespace llvm
156 
157 #endif // LLVM_LIB_TARGET_AMDGPU_DISASSEMBLER_AMDGPUDISASSEMBLER_H
158