utils/TableGen/CodeGenTarget.h

   1 //===- CodeGenTarget.h - Target Class Wrapper -------------------*- 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 wrappers for the Target class and related global
  11 // functionality.  This makes it easier to access the data and provides a single
  12 // place that needs to check it for validity.  All of these classes throw
  13 // exceptions on error conditions.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef CODEGEN_TARGET_H
  18 #define CODEGEN_TARGET_H
  19
  20 #include "CodeGenRegisters.h"
  21 #include "CodeGenInstruction.h"
  22 #include "Record.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include <algorithm>
  25
  26 namespace llvm {
  27
  28 struct CodeGenRegister;
  29 class CodeGenTarget;
  30
  31 // SelectionDAG node properties.
  32 //  SDNPMemOperand: indicates that a node touches memory and therefore must
  33 //                  have an associated memory operand that describes the access.
  34 enum SDNP {
  35   SDNPCommutative,
  36   SDNPAssociative,
  37   SDNPHasChain,
  38   SDNPOutGlue,
  39   SDNPInGlue,
  40   SDNPOptInGlue,
  41   SDNPMayLoad,
  42   SDNPMayStore,
  43   SDNPSideEffect,
  44   SDNPMemOperand,
  45   SDNPVariadic,
  46   SDNPWantRoot,
  47   SDNPWantParent
  48 };
  49
  50 /// getValueType - Return the MVT::SimpleValueType that the specified TableGen
  51 /// record corresponds to.
  52 MVT::SimpleValueType getValueType(Record *Rec);
  53
  54 std::string getName(MVT::SimpleValueType T);
  55 std::string getEnumName(MVT::SimpleValueType T);
  56
  57 /// getQualifiedName - Return the name of the specified record, with a
  58 /// namespace qualifier if the record contains one.
  59 std::string getQualifiedName(const Record *R);
  60
  61 /// CodeGenTarget - This class corresponds to the Target class in the .td files.
  62 ///
  63 class CodeGenTarget {
  64   RecordKeeper &Records;
  65   Record *TargetRec;
  66
  67   mutable DenseMap<const Record*, CodeGenInstruction*> Instructions;
  68   mutable CodeGenRegBank *RegBank;
  69   mutable std::vector<MVT::SimpleValueType> LegalValueTypes;
  70   void ReadInstructions() const;
  71   void ReadLegalValueTypes() const;
  72
  73   mutable std::vector<const CodeGenInstruction*> InstrsByEnum;
  74 public:
  75   CodeGenTarget(RecordKeeper &Records);
  76
  77   Record *getTargetRecord() const { return TargetRec; }
  78   const std::string &getName() const;
  79
  80   /// getInstNamespace - Return the target-specific instruction namespace.
  81   ///
  82   std::string getInstNamespace() const;
  83
  84   /// getInstructionSet - Return the InstructionSet object.
  85   ///
  86   Record *getInstructionSet() const;
  87
  88   /// getAsmParser - Return the AssemblyParser definition for this target.
  89   ///
  90   Record *getAsmParser() const;
  91
  92   /// getAsmWriter - Return the AssemblyWriter definition for this target.
  93   ///
  94   Record *getAsmWriter() const;
  95
  96   /// getRegBank - Return the register bank description.
  97   CodeGenRegBank &getRegBank() const;
  98
  99   const std::vector<CodeGenRegister> &getRegisters() const {
 100     return getRegBank().getRegisters();
 101   }
 102
 103   /// getRegisterByName - If there is a register with the specific AsmName,
 104   /// return it.
 105   const CodeGenRegister *getRegisterByName(StringRef Name) const;
 106
 107   const std::vector<CodeGenRegisterClass> &getRegisterClasses() const {
 108     return getRegBank().getRegClasses();
 109   }
 110
 111   const CodeGenRegisterClass &getRegisterClass(Record *R) const {
 112     return *getRegBank().getRegClass(R);
 113   }
 114
 115   /// getRegisterVTs - Find the union of all possible SimpleValueTypes for the
 116   /// specified physical register.
 117   std::vector<MVT::SimpleValueType> getRegisterVTs(Record *R) const;
 118
 119   const std::vector<MVT::SimpleValueType> &getLegalValueTypes() const {
 120     if (LegalValueTypes.empty()) ReadLegalValueTypes();
 121     return LegalValueTypes;
 122   }
 123
 124   /// isLegalValueType - Return true if the specified value type is natively
 125   /// supported by the target (i.e. there are registers that directly hold it).
 126   bool isLegalValueType(MVT::SimpleValueType VT) const {
 127     const std::vector<MVT::SimpleValueType> &LegalVTs = getLegalValueTypes();
 128     for (unsigned i = 0, e = LegalVTs.size(); i != e; ++i)
 129       if (LegalVTs[i] == VT) return true;
 130     return false;
 131   }
 132
 133 private:
 134   DenseMap<const Record*, CodeGenInstruction*> &getInstructions() const {
 135     if (Instructions.empty()) ReadInstructions();
 136     return Instructions;
 137   }
 138 public:
 139
 140   CodeGenInstruction &getInstruction(const Record *InstRec) const {
 141     if (Instructions.empty()) ReadInstructions();
 142     DenseMap<const Record*, CodeGenInstruction*>::iterator I =
 143       Instructions.find(InstRec);
 144     assert(I != Instructions.end() && "Not an instruction");
 145     return *I->second;
 146   }
 147
 148   /// getInstructionsByEnumValue - Return all of the instructions defined by the
 149   /// target, ordered by their enum value.
 150   const std::vector<const CodeGenInstruction*> &
 151   getInstructionsByEnumValue() const {
 152     if (InstrsByEnum.empty()) ComputeInstrsByEnum();
 153     return InstrsByEnum;
 154   }
 155
 156   typedef std::vector<const CodeGenInstruction*>::const_iterator inst_iterator;
 157   inst_iterator inst_begin() const{return getInstructionsByEnumValue().begin();}
 158   inst_iterator inst_end() const { return getInstructionsByEnumValue().end(); }
 159
 160
 161   /// isLittleEndianEncoding - are instruction bit patterns defined as  [0..n]?
 162   ///
 163   bool isLittleEndianEncoding() const;
 164
 165 private:
 166   void ComputeInstrsByEnum() const;
 167 };
 168
 169 /// ComplexPattern - ComplexPattern info, corresponding to the ComplexPattern
 170 /// tablegen class in TargetSelectionDAG.td
 171 class ComplexPattern {
 172   MVT::SimpleValueType Ty;
 173   unsigned NumOperands;
 174   std::string SelectFunc;
 175   std::vector<Record*> RootNodes;
 176   unsigned Properties; // Node properties
 177 public:
 178   ComplexPattern() : NumOperands(0) {}
 179   ComplexPattern(Record *R);
 180
 181   MVT::SimpleValueType getValueType() const { return Ty; }
 182   unsigned getNumOperands() const { return NumOperands; }
 183   const std::string &getSelectFunc() const { return SelectFunc; }
 184   const std::vector<Record*> &getRootNodes() const {
 185     return RootNodes;
 186   }
 187   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
 188 };
 189
 190 } // End llvm namespace
 191
 192 #endif