lib/MC/MCDisassembler/EDDisassembler.h

   1 //===-- EDDisassembler.h - LLVM Enhanced 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 Enhanced Disassembly library's
  11 // disassembler class.  The disassembler is responsible for vending individual
  12 // instructions according to a given architecture and disassembly syntax.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_EDDISASSEMBLER_H
  17 #define LLVM_EDDISASSEMBLER_H
  18
  19 #include "EDInfo.h"
  20
  21 #include "llvm/ADT/OwningPtr.h"
  22 #include "llvm/ADT/Triple.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include "llvm/Support/Mutex.h"
  25
  26 #include <map>
  27 #include <set>
  28 #include <vector>
  29
  30 namespace llvm {
  31 class AsmLexer;
  32 class AsmToken;
  33 class MCContext;
  34 class MCAsmInfo;
  35 class MCAsmLexer;
  36 class AsmParser;
  37 class TargetAsmLexer;
  38 class TargetAsmParser;
  39 class MCDisassembler;
  40 class MCInstPrinter;
  41 class MCInst;
  42 class MCParsedAsmOperand;
  43 class MCStreamer;
  44 template <typename T> class SmallVectorImpl;
  45 class SourceMgr;
  46 class Target;
  47 class TargetMachine;
  48 class TargetRegisterInfo;
  49
  50 struct EDInstInfo;
  51 struct EDInst;
  52 struct EDOperand;
  53 struct EDToken;
  54
  55 typedef int (*EDByteReaderCallback)(uint8_t *byte, uint64_t address, void *arg);
  56
  57 /// EDDisassembler - Encapsulates a disassembler for a single architecture and
  58 ///   disassembly syntax.  Also manages the static disassembler registry.
  59 struct EDDisassembler {
  60   typedef enum {
  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
  66   } AssemblySyntax;
  67
  68
  69   ////////////////////
  70   // Static members //
  71   ////////////////////
  72
  73   /// CPUKey - Encapsulates the descriptor of an architecture/disassembly-syntax
  74   ///   pair
  75   struct CPUKey {
  76     /// The architecture type
  77     llvm::Triple::ArchType Arch;
  78
  79     /// The assembly syntax
  80     AssemblySyntax Syntax;
  81
  82     /// operator== - Equality operator
  83     bool operator==(const CPUKey &key) const {
  84       return (Arch == key.Arch &&
  85               Syntax == key.Syntax);
  86     }
  87
  88     /// operator< - Less-than operator
  89     bool operator<(const CPUKey &key) const {
  90       return ((Arch < key.Arch) ||
  91               ((Arch == key.Arch) && Syntax < (key.Syntax)));
  92     }
  93   };
  94
  95   typedef std::map<CPUKey, EDDisassembler*> DisassemblerMap_t;
  96
  97   /// True if the disassembler registry has been initialized; false if not
  98   static bool sInitialized;
  99   /// A map from disassembler specifications to disassemblers.  Populated
 100   ///   lazily.
 101   static DisassemblerMap_t sDisassemblers;
 102
 103   /// getDisassembler - Returns the specified disassemble, or NULL on failure
 104   ///
 105   /// @arg arch   - The desired architecture
 106   /// @arg syntax - The desired disassembly syntax
 107   static EDDisassembler *getDisassembler(llvm::Triple::ArchType arch,
 108                                          AssemblySyntax syntax);
 109
 110   /// getDisassembler - Returns the disassembler for a given combination of
 111   ///   CPU type, CPU subtype, and assembly syntax, or NULL on failure
 112   ///
 113   /// @arg str    - The string representation of the architecture triple, e.g.,
 114   ///               "x86_64-apple-darwin"
 115   /// @arg syntax - The disassembly syntax for the required disassembler
 116   static EDDisassembler *getDisassembler(llvm::StringRef str,
 117                                          AssemblySyntax syntax);
 118
 119   /// initialize - Initializes the disassembler registry and the LLVM backend
 120   static void initialize();
 121
 122   ////////////////////////
 123   // Per-object members //
 124   ////////////////////////
 125
 126   /// True only if the object has been successfully initialized
 127   bool Valid;
 128   /// True if the disassembler can provide semantic information
 129   bool HasSemantics;
 130
 131   /// The stream to write errors to
 132   llvm::raw_ostream &ErrorStream;
 133
 134   /// The architecture/syntax pair for the current architecture
 135   CPUKey Key;
 136   /// The LLVM target corresponding to the disassembler
 137   const llvm::Target *Tgt;
 138   /// The target machine instance.
 139   llvm::OwningPtr<llvm::TargetMachine> TargetMachine;
 140   /// The assembly information for the target architecture
 141   llvm::OwningPtr<const llvm::MCAsmInfo> AsmInfo;
 142   /// The disassembler for the target architecture
 143   llvm::OwningPtr<const llvm::MCDisassembler> Disassembler;
 144   /// The output string for the instruction printer; must be guarded with
 145   ///   PrinterMutex
 146   llvm::OwningPtr<std::string> InstString;
 147   /// The output stream for the disassembler; must be guarded with
 148   ///   PrinterMutex
 149   llvm::OwningPtr<llvm::raw_string_ostream> InstStream;
 150   /// The instruction printer for the target architecture; must be guarded with
 151   ///   PrinterMutex when printing
 152   llvm::OwningPtr<llvm::MCInstPrinter> InstPrinter;
 153   /// The mutex that guards the instruction printer's printing functions, which
 154   ///   use a shared stream
 155   llvm::sys::Mutex PrinterMutex;
 156   /// The array of instruction information provided by the TableGen backend for
 157   ///   the target architecture
 158   const llvm::EDInstInfo *InstInfos;
 159   /// The target-specific lexer for use in tokenizing strings, in
 160   ///   target-independent and target-specific portions
 161   llvm::OwningPtr<llvm::AsmLexer> GenericAsmLexer;
 162   llvm::OwningPtr<llvm::TargetAsmLexer> SpecificAsmLexer;
 163   /// The guard for the above
 164   llvm::sys::Mutex ParserMutex;
 165   /// The LLVM number used for the target disassembly syntax variant
 166   int LLVMSyntaxVariant;
 167
 168   typedef std::vector<std::string> regvec_t;
 169   typedef std::map<std::string, unsigned> regrmap_t;
 170
 171   /// A vector of registers for quick mapping from LLVM register IDs to names
 172   regvec_t RegVec;
 173   /// A map of registers for quick mapping from register names to LLVM IDs
 174   regrmap_t RegRMap;
 175
 176   /// A set of register IDs for aliases of the stack pointer for the current
 177   ///   architecture
 178   std::set<unsigned> stackPointers;
 179   /// A set of register IDs for aliases of the program counter for the current
 180   ///   architecture
 181   std::set<unsigned> programCounters;
 182
 183   /// Constructor - initializes a disassembler with all the necessary objects,
 184   ///   which come pre-allocated from the registry accessor function
 185   ///
 186   /// @arg key                - the architecture and disassembly syntax for the
 187   ///                           disassembler
 188   EDDisassembler(CPUKey& key);
 189
 190   /// valid - reports whether there was a failure in the constructor.
 191   bool valid() {
 192     return Valid;
 193   }
 194
 195   /// hasSemantics - reports whether the disassembler can provide operands and
 196   ///   tokens.
 197   bool hasSemantics() {
 198     return HasSemantics;
 199   }
 200
 201   ~EDDisassembler();
 202
 203   /// createInst - creates and returns an instruction given a callback and
 204   ///   memory address, or NULL on failure
 205   ///
 206   /// @arg byteReader - A callback function that provides machine code bytes
 207   /// @arg address    - The address of the first byte of the instruction,
 208   ///                   suitable for passing to byteReader
 209   /// @arg arg        - An opaque argument for byteReader
 210   EDInst *createInst(EDByteReaderCallback byteReader,
 211                      uint64_t address,
 212                      void *arg);
 213
 214   /// initMaps - initializes regVec and regRMap using the provided register
 215   ///   info
 216   ///
 217   /// @arg registerInfo - the register information to use as a source
 218   void initMaps(const llvm::TargetRegisterInfo &registerInfo);
 219   /// nameWithRegisterID - Returns the name (owned by the EDDisassembler) of a
 220   ///   register for a given register ID, or NULL on failure
 221   ///
 222   /// @arg registerID - the ID of the register to be queried
 223   const char *nameWithRegisterID(unsigned registerID) const;
 224   /// registerIDWithName - Returns the ID of a register for a given register
 225   ///   name, or (unsigned)-1 on failure
 226   ///
 227   /// @arg name - The name of the register
 228   unsigned registerIDWithName(const char *name) const;
 229
 230   /// registerIsStackPointer - reports whether a register ID is an alias for the
 231   ///   stack pointer register
 232   ///
 233   /// @arg registerID - The LLVM register ID
 234   bool registerIsStackPointer(unsigned registerID);
 235   /// registerIsStackPointer - reports whether a register ID is an alias for the
 236   ///   stack pointer register
 237   ///
 238   /// @arg registerID - The LLVM register ID
 239   bool registerIsProgramCounter(unsigned registerID);
 240
 241   /// printInst - prints an MCInst to a string, returning 0 on success, or -1
 242   ///   otherwise
 243   ///
 244   /// @arg str  - A reference to a string which is filled in with the string
 245   ///             representation of the instruction
 246   /// @arg inst - A reference to the MCInst to be printed
 247   int printInst(std::string& str,
 248                 llvm::MCInst& inst);
 249
 250   /// parseInst - extracts operands and tokens from a string for use in
 251   ///   tokenizing the string.  Returns 0 on success, or -1 otherwise.
 252   ///
 253   /// @arg operands - A reference to a vector that will be filled in with the
 254   ///                 parsed operands
 255   /// @arg tokens   - A reference to a vector that will be filled in with the
 256   ///                 tokens
 257   /// @arg str      - The string representation of the instruction
 258   int parseInst(llvm::SmallVectorImpl<llvm::MCParsedAsmOperand*> &operands,
 259                 llvm::SmallVectorImpl<llvm::AsmToken> &tokens,
 260                 const std::string &str);
 261
 262   /// llvmSyntaxVariant - returns the LLVM syntax variant for this disassembler
 263   int llvmSyntaxVariant() const;
 264 };
 265
 266 } // end namespace llvm
 267
 268 #endif