1 //===-- EDDisassembler.h - LLVM Enhanced Disassembler -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the interface for the Enhanced Disassembly library's
11 // disassembler class. The disassembler is responsible for vending individual
12 // instructions according to a given architecture and disassembly syntax.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_EDDISASSEMBLER_H
17 #define LLVM_EDDISASSEMBLER_H
20 #include "llvm/ADT/OwningPtr.h"
21 #include "llvm/ADT/Triple.h"
22 #include "llvm/Support/Mutex.h"
23 #include "llvm/Support/raw_ostream.h"
40 class MCParsedAsmOperand;
43 class MCSubtargetInfo;
44 class MCTargetAsmLexer;
45 class MCTargetAsmParser;
46 template <typename T> class SmallVectorImpl;
55 typedef int (*EDByteReaderCallback)(uint8_t *byte, uint64_t address, void *arg);
57 /// EDDisassembler - Encapsulates a disassembler for a single architecture and
58 /// disassembly syntax. Also manages the static disassembler registry.
59 struct EDDisassembler {
61 /*! @constant kEDAssemblySyntaxX86Intel Intel syntax for i386 and x86_64. */
62 kEDAssemblySyntaxX86Intel = 0,
63 /*! @constant kEDAssemblySyntaxX86ATT AT&T syntax for i386 and x86_64. */
64 kEDAssemblySyntaxX86ATT = 1,
65 kEDAssemblySyntaxARMUAL = 2
73 /// CPUKey - Encapsulates the descriptor of an architecture/disassembly-syntax
76 /// The architecture type
79 /// The assembly syntax
80 AssemblySyntax Syntax;
82 /// operator== - Equality operator
83 bool operator==(const CPUKey &key) const {
84 return (Triple == key.Triple &&
85 Syntax == key.Syntax);
88 /// operator< - Less-than operator
89 bool operator<(const CPUKey &key) const {
90 return ((Triple < key.Triple) ||
91 ((Triple == key.Triple) && Syntax < (key.Syntax)));
95 typedef std::map<CPUKey, EDDisassembler*> DisassemblerMap_t;
97 /// A map from disassembler specifications to disassemblers. Populated
99 static DisassemblerMap_t sDisassemblers;
101 /// getDisassembler - Returns the specified disassemble, or NULL on failure
103 /// @arg arch - The desired architecture
104 /// @arg syntax - The desired disassembly syntax
105 static EDDisassembler *getDisassembler(llvm::Triple::ArchType arch,
106 AssemblySyntax syntax);
108 /// getDisassembler - Returns the disassembler for a given combination of
109 /// CPU type, CPU subtype, and assembly syntax, or NULL on failure
111 /// @arg str - The string representation of the architecture triple, e.g.,
112 /// "x86_64-apple-darwin"
113 /// @arg syntax - The disassembly syntax for the required disassembler
114 static EDDisassembler *getDisassembler(llvm::StringRef str,
115 AssemblySyntax syntax);
117 ////////////////////////
118 // Per-object members //
119 ////////////////////////
121 /// True only if the object has been successfully initialized
123 /// True if the disassembler can provide semantic information
126 /// The stream to write errors to
127 llvm::raw_ostream &ErrorStream;
129 /// The triple/syntax pair for the current architecture
131 /// The Triple fur the current architecture
133 /// The LLVM target corresponding to the disassembler
134 const llvm::Target *Tgt;
135 /// The assembly information for the target architecture
136 llvm::OwningPtr<const llvm::MCAsmInfo> AsmInfo;
137 /// The subtarget information for the target architecture
138 llvm::OwningPtr<const llvm::MCSubtargetInfo> STI;
139 // The instruction information for the target architecture.
140 llvm::OwningPtr<const llvm::MCInstrInfo> MII;
141 // The register information for the target architecture.
142 llvm::OwningPtr<const llvm::MCRegisterInfo> MRI;
143 /// The disassembler for the target architecture
144 llvm::OwningPtr<const llvm::MCDisassembler> Disassembler;
145 /// The output string for the instruction printer; must be guarded with
147 llvm::OwningPtr<std::string> InstString;
148 /// The output stream for the disassembler; must be guarded with
150 llvm::OwningPtr<llvm::raw_string_ostream> InstStream;
151 /// The instruction printer for the target architecture; must be guarded with
152 /// PrinterMutex when printing
153 llvm::OwningPtr<llvm::MCInstPrinter> InstPrinter;
154 /// The mutex that guards the instruction printer's printing functions, which
155 /// use a shared stream
156 llvm::sys::Mutex PrinterMutex;
157 /// The array of instruction information provided by the TableGen backend for
158 /// the target architecture
159 const llvm::EDInstInfo *InstInfos;
160 /// The target-specific lexer for use in tokenizing strings, in
161 /// target-independent and target-specific portions
162 llvm::OwningPtr<llvm::AsmLexer> GenericAsmLexer;
163 llvm::OwningPtr<llvm::MCTargetAsmLexer> SpecificAsmLexer;
164 /// The guard for the above
165 llvm::sys::Mutex ParserMutex;
166 /// The LLVM number used for the target disassembly syntax variant
167 int LLVMSyntaxVariant;
169 typedef std::vector<std::string> regvec_t;
170 typedef std::map<std::string, unsigned> regrmap_t;
172 /// A vector of registers for quick mapping from LLVM register IDs to names
174 /// A map of registers for quick mapping from register names to LLVM IDs
177 /// A set of register IDs for aliases of the stack pointer for the current
179 std::set<unsigned> stackPointers;
180 /// A set of register IDs for aliases of the program counter for the current
182 std::set<unsigned> programCounters;
184 /// Constructor - initializes a disassembler with all the necessary objects,
185 /// which come pre-allocated from the registry accessor function
187 /// @arg key - the architecture and disassembly syntax for the
189 EDDisassembler(CPUKey& key);
191 /// valid - reports whether there was a failure in the constructor.
196 /// hasSemantics - reports whether the disassembler can provide operands and
198 bool hasSemantics() {
204 /// createInst - creates and returns an instruction given a callback and
205 /// memory address, or NULL on failure
207 /// @arg byteReader - A callback function that provides machine code bytes
208 /// @arg address - The address of the first byte of the instruction,
209 /// suitable for passing to byteReader
210 /// @arg arg - An opaque argument for byteReader
211 EDInst *createInst(EDByteReaderCallback byteReader,
215 /// initMaps - initializes regVec and regRMap using the provided register
218 /// @arg registerInfo - the register information to use as a source
219 void initMaps(const llvm::MCRegisterInfo ®isterInfo);
220 /// nameWithRegisterID - Returns the name (owned by the EDDisassembler) of a
221 /// register for a given register ID, or NULL on failure
223 /// @arg registerID - the ID of the register to be queried
224 const char *nameWithRegisterID(unsigned registerID) const;
225 /// registerIDWithName - Returns the ID of a register for a given register
226 /// name, or (unsigned)-1 on failure
228 /// @arg name - The name of the register
229 unsigned registerIDWithName(const char *name) const;
231 /// registerIsStackPointer - reports whether a register ID is an alias for the
232 /// stack pointer register
234 /// @arg registerID - The LLVM register ID
235 bool registerIsStackPointer(unsigned registerID);
236 /// registerIsStackPointer - reports whether a register ID is an alias for the
237 /// stack pointer register
239 /// @arg registerID - The LLVM register ID
240 bool registerIsProgramCounter(unsigned registerID);
242 /// printInst - prints an MCInst to a string, returning 0 on success, or -1
245 /// @arg str - A reference to a string which is filled in with the string
246 /// representation of the instruction
247 /// @arg inst - A reference to the MCInst to be printed
248 int printInst(std::string& str,
251 /// parseInst - extracts operands and tokens from a string for use in
252 /// tokenizing the string. Returns 0 on success, or -1 otherwise.
254 /// @arg operands - A reference to a vector that will be filled in with the
256 /// @arg tokens - A reference to a vector that will be filled in with the
258 /// @arg str - The string representation of the instruction
259 int parseInst(llvm::SmallVectorImpl<llvm::MCParsedAsmOperand*> &operands,
260 llvm::SmallVectorImpl<llvm::AsmToken> &tokens,
261 const std::string &str);
263 /// llvmSyntaxVariant - returns the LLVM syntax variant for this disassembler
264 int llvmSyntaxVariant() const;
267 } // end namespace llvm