• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===------------- Disassembler.h - LLVM Disassembler -----------*- 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 // This file defines the interface for the Disassembly library's disassembler
11 // context.  The disassembler is responsible for producing strings for
12 // individual instructions according to a given architecture and disassembly
13 // syntax.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_MC_DISASSEMBLER_H
18 #define LLVM_MC_DISASSEMBLER_H
19 
20 #include "llvm-c/Disassembler.h"
21 #include "llvm/ADT/OwningPtr.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include <string>
25 
26 namespace llvm {
27 class MCContext;
28 class MCAsmInfo;
29 class MCDisassembler;
30 class MCInstPrinter;
31 class MCInstrInfo;
32 class MCRegisterInfo;
33 class MCSubtargetInfo;
34 class Target;
35 
36 //
37 // This is the disassembler context returned by LLVMCreateDisasm().
38 //
39 class LLVMDisasmContext {
40 private:
41   //
42   // The passed parameters when the disassembler context is created.
43   //
44   // The TripleName for this disassembler.
45   std::string TripleName;
46   // The pointer to the caller's block of symbolic information.
47   void *DisInfo;
48   // The Triple specific symbolic information type returned by GetOpInfo.
49   int TagType;
50   // The function to get the symbolic information for operands.
51   LLVMOpInfoCallback GetOpInfo;
52   // The function to look up a symbol name.
53   LLVMSymbolLookupCallback SymbolLookUp;
54   //
55   // The objects created and saved by LLVMCreateDisasm() then used by
56   // LLVMDisasmInstruction().
57   //
58   // The LLVM target corresponding to the disassembler.
59   // FIXME: using llvm::OwningPtr<const llvm::Target> causes a malloc error
60   //        when this LLVMDisasmContext is deleted.
61   const Target *TheTarget;
62   // The assembly information for the target architecture.
63   llvm::OwningPtr<const llvm::MCAsmInfo> MAI;
64   // The register information for the target architecture.
65   llvm::OwningPtr<const llvm::MCRegisterInfo> MRI;
66   // The subtarget information for the target architecture.
67   llvm::OwningPtr<const llvm::MCSubtargetInfo> MSI;
68   // The instruction information for the target architecture.
69   llvm::OwningPtr<const llvm::MCInstrInfo> MII;
70   // The assembly context for creating symbols and MCExprs.
71   llvm::OwningPtr<const llvm::MCContext> Ctx;
72   // The disassembler for the target architecture.
73   llvm::OwningPtr<const llvm::MCDisassembler> DisAsm;
74   // The instruction printer for the target architecture.
75   llvm::OwningPtr<llvm::MCInstPrinter> IP;
76 
77 public:
78   // Comment stream and backing vector.
79   SmallString<128> CommentsToEmit;
80   raw_svector_ostream CommentStream;
81 
LLVMDisasmContext(std::string tripleName,void * disInfo,int tagType,LLVMOpInfoCallback getOpInfo,LLVMSymbolLookupCallback symbolLookUp,const Target * theTarget,const MCAsmInfo * mAI,const MCRegisterInfo * mRI,const MCSubtargetInfo * mSI,const MCInstrInfo * mII,llvm::MCContext * ctx,const MCDisassembler * disAsm,MCInstPrinter * iP)82   LLVMDisasmContext(std::string tripleName, void *disInfo, int tagType,
83                     LLVMOpInfoCallback getOpInfo,
84                     LLVMSymbolLookupCallback symbolLookUp,
85                     const Target *theTarget, const MCAsmInfo *mAI,
86                     const MCRegisterInfo *mRI,
87                     const MCSubtargetInfo *mSI,
88                     const MCInstrInfo *mII,
89                     llvm::MCContext *ctx, const MCDisassembler *disAsm,
90                     MCInstPrinter *iP) : TripleName(tripleName),
91                     DisInfo(disInfo), TagType(tagType), GetOpInfo(getOpInfo),
92                     SymbolLookUp(symbolLookUp), TheTarget(theTarget),
93                     CommentStream(CommentsToEmit) {
94     MAI.reset(mAI);
95     MRI.reset(mRI);
96     MSI.reset(mSI);
97     MII.reset(mII);
98     Ctx.reset(ctx);
99     DisAsm.reset(disAsm);
100     IP.reset(iP);
101   }
getTripleName()102   const std::string &getTripleName() const { return TripleName; }
getDisInfo()103   void *getDisInfo() const { return DisInfo; }
getTagType()104   int getTagType() const { return TagType; }
getGetOpInfo()105   LLVMOpInfoCallback getGetOpInfo() const { return GetOpInfo; }
getSymbolLookupCallback()106   LLVMSymbolLookupCallback getSymbolLookupCallback() const {
107     return SymbolLookUp;
108   }
getTarget()109   const Target *getTarget() const { return TheTarget; }
getDisAsm()110   const MCDisassembler *getDisAsm() const { return DisAsm.get(); }
getAsmInfo()111   const MCAsmInfo *getAsmInfo() const { return MAI.get(); }
getInstrInfo()112   const MCInstrInfo *getInstrInfo() const { return MII.get(); }
getRegisterInfo()113   const MCRegisterInfo *getRegisterInfo() const { return MRI.get(); }
getSubtargetInfo()114   const MCSubtargetInfo *getSubtargetInfo() const { return MSI.get(); }
getIP()115   MCInstPrinter *getIP() { return IP.get(); }
setIP(MCInstPrinter * NewIP)116   void setIP(MCInstPrinter *NewIP) { IP.reset(NewIP); }
117 };
118 
119 } // namespace llvm
120 
121 #endif
122