193f79364351650b58172522ae8346153a3c67a5cKevin Enderby//===------------- Disassembler.h - LLVM Disassembler -----------*- C++ -*-===// 293f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 393f79364351650b58172522ae8346153a3c67a5cKevin Enderby// The LLVM Compiler Infrastructure 493f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 593f79364351650b58172522ae8346153a3c67a5cKevin Enderby// This file is distributed under the University of Illinois Open Source 693f79364351650b58172522ae8346153a3c67a5cKevin Enderby// License. See LICENSE.TXT for details. 793f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 893f79364351650b58172522ae8346153a3c67a5cKevin Enderby//===----------------------------------------------------------------------===// 993f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 1093f79364351650b58172522ae8346153a3c67a5cKevin Enderby// This file defines the interface for the Disassembly library's disassembler 1193f79364351650b58172522ae8346153a3c67a5cKevin Enderby// context. The disassembler is responsible for producing strings for 1293f79364351650b58172522ae8346153a3c67a5cKevin Enderby// individual instructions according to a given architecture and disassembly 1393f79364351650b58172522ae8346153a3c67a5cKevin Enderby// syntax. 1493f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 1593f79364351650b58172522ae8346153a3c67a5cKevin Enderby//===----------------------------------------------------------------------===// 1669ffd7ad140dcc1d62a47ab1a2b28fd8da84ade8Sebastian Redl 1737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#ifndef LLVM_LIB_MC_MCDISASSEMBLER_DISASSEMBLER_H 1837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines#define LLVM_LIB_MC_MCDISASSEMBLER_DISASSEMBLER_H 1969ffd7ad140dcc1d62a47ab1a2b28fd8da84ade8Sebastian Redl 2093f79364351650b58172522ae8346153a3c67a5cKevin Enderby#include "llvm-c/Disassembler.h" 218f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson#include "llvm/ADT/SmallString.h" 22de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCAsmInfo.h" 23de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCContext.h" 24de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCDisassembler/MCDisassembler.h" 25de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCInstPrinter.h" 26de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCInstrInfo.h" 27de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCRegisterInfo.h" 28de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include "llvm/MC/MCSubtargetInfo.h" 298f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson#include "llvm/Support/raw_ostream.h" 30a1514e24cc24b050f53a12650e047799358833a1Chandler Carruth#include <string> 31de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar#include <utility> 3293f79364351650b58172522ae8346153a3c67a5cKevin Enderby 3393f79364351650b58172522ae8346153a3c67a5cKevin Enderbynamespace llvm { 3493f79364351650b58172522ae8346153a3c67a5cKevin Enderbyclass Target; 3593f79364351650b58172522ae8346153a3c67a5cKevin Enderby 3693f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 3793f79364351650b58172522ae8346153a3c67a5cKevin Enderby// This is the disassembler context returned by LLVMCreateDisasm(). 3893f79364351650b58172522ae8346153a3c67a5cKevin Enderby// 3993f79364351650b58172522ae8346153a3c67a5cKevin Enderbyclass LLVMDisasmContext { 4093f79364351650b58172522ae8346153a3c67a5cKevin Enderbyprivate: 4193f79364351650b58172522ae8346153a3c67a5cKevin Enderby // 4293f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The passed parameters when the disassembler context is created. 4393f79364351650b58172522ae8346153a3c67a5cKevin Enderby // 4493f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The TripleName for this disassembler. 4593f79364351650b58172522ae8346153a3c67a5cKevin Enderby std::string TripleName; 4693f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The pointer to the caller's block of symbolic information. 4793f79364351650b58172522ae8346153a3c67a5cKevin Enderby void *DisInfo; 4893f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The Triple specific symbolic information type returned by GetOpInfo. 4993f79364351650b58172522ae8346153a3c67a5cKevin Enderby int TagType; 5093f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The function to get the symbolic information for operands. 5193f79364351650b58172522ae8346153a3c67a5cKevin Enderby LLVMOpInfoCallback GetOpInfo; 5293f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The function to look up a symbol name. 5393f79364351650b58172522ae8346153a3c67a5cKevin Enderby LLVMSymbolLookupCallback SymbolLookUp; 5493f79364351650b58172522ae8346153a3c67a5cKevin Enderby // 5593f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The objects created and saved by LLVMCreateDisasm() then used by 5693f79364351650b58172522ae8346153a3c67a5cKevin Enderby // LLVMDisasmInstruction(). 5793f79364351650b58172522ae8346153a3c67a5cKevin Enderby // 5893f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The LLVM target corresponding to the disassembler. 5936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines // FIXME: using std::unique_ptr<const llvm::Target> causes a malloc error 6093f79364351650b58172522ae8346153a3c67a5cKevin Enderby // when this LLVMDisasmContext is deleted. 6193f79364351650b58172522ae8346153a3c67a5cKevin Enderby const Target *TheTarget; 6293f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The assembly information for the target architecture. 6336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCAsmInfo> MAI; 640e6a052331f674dd70e28af41f654a7874405eabEvan Cheng // The register information for the target architecture. 6536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCRegisterInfo> MRI; 6655e79804226f1da02ec880c120671ff930e3dbe4Sean Callanan // The subtarget information for the target architecture. 6736b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCSubtargetInfo> MSI; 6855e79804226f1da02ec880c120671ff930e3dbe4Sean Callanan // The instruction information for the target architecture. 6936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCInstrInfo> MII; 7093f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The assembly context for creating symbols and MCExprs. 7136b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCContext> Ctx; 7293f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The disassembler for the target architecture. 7336b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<const llvm::MCDisassembler> DisAsm; 7493f79364351650b58172522ae8346153a3c67a5cKevin Enderby // The instruction printer for the target architecture. 7536b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines std::unique_ptr<llvm::MCInstPrinter> IP; 76797f06e19b6f17217a69dea4d6ce900625432595Quentin Colombet // The options used to set up the disassembler. 77797f06e19b6f17217a69dea4d6ce900625432595Quentin Colombet uint64_t Options; 784b3685de23b4a1b3199a06e4bb2ccd1e316396c3Quentin Colombet // The CPU string. 794b3685de23b4a1b3199a06e4bb2ccd1e316396c3Quentin Colombet std::string CPU; 8093f79364351650b58172522ae8346153a3c67a5cKevin Enderby 8193f79364351650b58172522ae8346153a3c67a5cKevin Enderbypublic: 828f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson // Comment stream and backing vector. 838f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson SmallString<128> CommentsToEmit; 848f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson raw_svector_ostream CommentStream; 858f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson 8693f79364351650b58172522ae8346153a3c67a5cKevin Enderby LLVMDisasmContext(std::string tripleName, void *disInfo, int tagType, 87bd3327654b5708f1ba92aff3ab25b1bbf5034797Kevin Enderby LLVMOpInfoCallback getOpInfo, 8893f79364351650b58172522ae8346153a3c67a5cKevin Enderby LLVMSymbolLookupCallback symbolLookUp, 8993f79364351650b58172522ae8346153a3c67a5cKevin Enderby const Target *theTarget, const MCAsmInfo *mAI, 90de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const MCRegisterInfo *mRI, const MCSubtargetInfo *mSI, 91de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const MCInstrInfo *mII, llvm::MCContext *ctx, 92de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar const MCDisassembler *disAsm, MCInstPrinter *iP) 93de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar : TripleName(std::move(tripleName)), DisInfo(disInfo), TagType(tagType), 94de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar GetOpInfo(getOpInfo), SymbolLookUp(symbolLookUp), TheTarget(theTarget), 95de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar Options(0), CommentStream(CommentsToEmit) { 9693f79364351650b58172522ae8346153a3c67a5cKevin Enderby MAI.reset(mAI); 970e6a052331f674dd70e28af41f654a7874405eabEvan Cheng MRI.reset(mRI); 9855e79804226f1da02ec880c120671ff930e3dbe4Sean Callanan MSI.reset(mSI); 9955e79804226f1da02ec880c120671ff930e3dbe4Sean Callanan MII.reset(mII); 10093f79364351650b58172522ae8346153a3c67a5cKevin Enderby Ctx.reset(ctx); 10193f79364351650b58172522ae8346153a3c67a5cKevin Enderby DisAsm.reset(disAsm); 10293f79364351650b58172522ae8346153a3c67a5cKevin Enderby IP.reset(iP); 10393f79364351650b58172522ae8346153a3c67a5cKevin Enderby } 1048e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer const std::string &getTripleName() const { return TripleName; } 1058e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer void *getDisInfo() const { return DisInfo; } 1068e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer int getTagType() const { return TagType; } 1078e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer LLVMOpInfoCallback getGetOpInfo() const { return GetOpInfo; } 1088e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer LLVMSymbolLookupCallback getSymbolLookupCallback() const { 1098e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer return SymbolLookUp; 1108e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer } 1118e5271d4629a24a69c4816ae803888e178e82cc2Benjamin Kramer const Target *getTarget() const { return TheTarget; } 11293f79364351650b58172522ae8346153a3c67a5cKevin Enderby const MCDisassembler *getDisAsm() const { return DisAsm.get(); } 1138f29e6969eb99410b9914bcb5ee2d9a125f07f88Owen Anderson const MCAsmInfo *getAsmInfo() const { return MAI.get(); } 1145469f605fe86edcfb6d3f0e36f3e3ce0254334ccKevin Enderby const MCInstrInfo *getInstrInfo() const { return MII.get(); } 1155469f605fe86edcfb6d3f0e36f3e3ce0254334ccKevin Enderby const MCRegisterInfo *getRegisterInfo() const { return MRI.get(); } 1165469f605fe86edcfb6d3f0e36f3e3ce0254334ccKevin Enderby const MCSubtargetInfo *getSubtargetInfo() const { return MSI.get(); } 11793f79364351650b58172522ae8346153a3c67a5cKevin Enderby MCInstPrinter *getIP() { return IP.get(); } 1185469f605fe86edcfb6d3f0e36f3e3ce0254334ccKevin Enderby void setIP(MCInstPrinter *NewIP) { IP.reset(NewIP); } 119797f06e19b6f17217a69dea4d6ce900625432595Quentin Colombet uint64_t getOptions() const { return Options; } 120797f06e19b6f17217a69dea4d6ce900625432595Quentin Colombet void addOptions(uint64_t Options) { this->Options |= Options; } 1214b3685de23b4a1b3199a06e4bb2ccd1e316396c3Quentin Colombet StringRef getCPU() const { return CPU; } 1224b3685de23b4a1b3199a06e4bb2ccd1e316396c3Quentin Colombet void setCPU(const char *CPU) { this->CPU = CPU; } 12393f79364351650b58172522ae8346153a3c67a5cKevin Enderby}; 12493f79364351650b58172522ae8346153a3c67a5cKevin Enderby 12593f79364351650b58172522ae8346153a3c67a5cKevin Enderby} // namespace llvm 12669ffd7ad140dcc1d62a47ab1a2b28fd8da84ade8Sebastian Redl 12769ffd7ad140dcc1d62a47ab1a2b28fd8da84ade8Sebastian Redl#endif 128