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   SDNPOutFlag,
  39   SDNPInFlag,
  40   SDNPOptInFlag,
  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   Record *TargetRec;
  65
  66   mutable DenseMap<const Record*, CodeGenInstruction*> Instructions;
  67   mutable std::vector<CodeGenRegister> Registers;
  68   mutable std::vector<Record*> SubRegIndices;
  69   mutable std::vector<CodeGenRegisterClass> RegisterClasses;
  70   mutable std::vector<MVT::SimpleValueType> LegalValueTypes;
  71   void ReadRegisters() const;
  72   void ReadSubRegIndices() const;
  73   void ReadRegisterClasses() const;
  74   void ReadInstructions() const;
  75   void ReadLegalValueTypes() const;
  76
  77   mutable std::vector<const CodeGenInstruction*> InstrsByEnum;
  78 public:
  79   CodeGenTarget();
  80
  81   Record *getTargetRecord() const { return TargetRec; }
  82   const std::string &getName() const;
  83
  84   /// getInstNamespace - Return the target-specific instruction namespace.
  85   ///
  86   std::string getInstNamespace() const;
  87
  88   /// getInstructionSet - Return the InstructionSet object.
  89   ///
  90   Record *getInstructionSet() const;
  91
  92   /// getAsmParser - Return the AssemblyParser definition for this target.
  93   ///
  94   Record *getAsmParser() const;
  95
  96   /// getAsmWriter - Return the AssemblyWriter definition for this target.
  97   ///
  98   Record *getAsmWriter() const;
  99
 100   const std::vector<CodeGenRegister> &getRegisters() const {
 101     if (Registers.empty()) ReadRegisters();
 102     return Registers;
 103   }
 104
 105   /// getRegisterByName - If there is a register with the specific AsmName,
 106   /// return it.
 107   const CodeGenRegister *getRegisterByName(StringRef Name) const;
 108
 109   const std::vector<Record*> &getSubRegIndices() const {
 110     if (SubRegIndices.empty()) ReadSubRegIndices();
 111     return SubRegIndices;
 112   }
 113
 114   // Map a SubRegIndex Record to its number.
 115   unsigned getSubRegIndexNo(Record *idx) const {
 116     if (SubRegIndices.empty()) ReadSubRegIndices();
 117     std::vector<Record*>::const_iterator i =
 118       std::find(SubRegIndices.begin(), SubRegIndices.end(), idx);
 119     assert(i != SubRegIndices.end() && "Not a SubRegIndex");
 120     return (i - SubRegIndices.begin()) + 1;
 121   }
 122
 123   const std::vector<CodeGenRegisterClass> &getRegisterClasses() const {
 124     if (RegisterClasses.empty()) ReadRegisterClasses();
 125     return RegisterClasses;
 126   }
 127
 128   const CodeGenRegisterClass &getRegisterClass(Record *R) const {
 129     const std::vector<CodeGenRegisterClass> &RC = getRegisterClasses();
 130     for (unsigned i = 0, e = RC.size(); i != e; ++i)
 131       if (RC[i].TheDef == R)
 132         return RC[i];
 133     assert(0 && "Didn't find the register class");
 134     abort();
 135   }
 136
 137   /// getRegisterClassForRegister - Find the register class that contains the
 138   /// specified physical register.  If the register is not in a register
 139   /// class, return null. If the register is in multiple classes, and the
 140   /// classes have a superset-subset relationship and the same set of
 141   /// types, return the superclass.  Otherwise return null.
 142   const CodeGenRegisterClass *getRegisterClassForRegister(Record *R) const {
 143     const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
 144     const CodeGenRegisterClass *FoundRC = 0;
 145     for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 146       const CodeGenRegisterClass &RC = RegisterClasses[i];
 147       for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
 148         if (R != RC.Elements[ei])
 149           continue;
 150
 151         // If a register's classes have different types, return null.
 152         if (FoundRC && RC.getValueTypes() != FoundRC->getValueTypes())
 153           return 0;
 154
 155         // If this is the first class that contains the register,
 156         // make a note of it and go on to the next class.
 157         if (!FoundRC) {
 158           FoundRC = &RC;
 159           break;
 160         }
 161
 162         std::vector<Record *> Elements(RC.Elements);
 163         std::vector<Record *> FoundElements(FoundRC->Elements);
 164         std::sort(Elements.begin(), Elements.end());
 165         std::sort(FoundElements.begin(), FoundElements.end());
 166
 167         // Check to see if the previously found class that contains
 168         // the register is a subclass of the current class. If so,
 169         // prefer the superclass.
 170         if (std::includes(Elements.begin(), Elements.end(),
 171                           FoundElements.begin(), FoundElements.end())) {
 172           FoundRC = &RC;
 173           break;
 174         }
 175
 176         // Check to see if the previously found class that contains
 177         // the register is a superclass of the current class. If so,
 178         // prefer the superclass.
 179         if (std::includes(FoundElements.begin(), FoundElements.end(),
 180                           Elements.begin(), Elements.end()))
 181           break;
 182
 183         // Multiple classes, and neither is a superclass of the other.
 184         // Return null.
 185         return 0;
 186       }
 187     }
 188     return FoundRC;
 189   }
 190
 191   /// getRegisterVTs - Find the union of all possible SimpleValueTypes for the
 192   /// specified physical register.
 193   std::vector<MVT::SimpleValueType> getRegisterVTs(Record *R) const;
 194
 195   const std::vector<MVT::SimpleValueType> &getLegalValueTypes() const {
 196     if (LegalValueTypes.empty()) ReadLegalValueTypes();
 197     return LegalValueTypes;
 198   }
 199
 200   /// isLegalValueType - Return true if the specified value type is natively
 201   /// supported by the target (i.e. there are registers that directly hold it).
 202   bool isLegalValueType(MVT::SimpleValueType VT) const {
 203     const std::vector<MVT::SimpleValueType> &LegalVTs = getLegalValueTypes();
 204     for (unsigned i = 0, e = LegalVTs.size(); i != e; ++i)
 205       if (LegalVTs[i] == VT) return true;
 206     return false;
 207   }
 208
 209 private:
 210   DenseMap<const Record*, CodeGenInstruction*> &getInstructions() const {
 211     if (Instructions.empty()) ReadInstructions();
 212     return Instructions;
 213   }
 214 public:
 215
 216   CodeGenInstruction &getInstruction(const Record *InstRec) const {
 217     if (Instructions.empty()) ReadInstructions();
 218     DenseMap<const Record*, CodeGenInstruction*>::iterator I =
 219       Instructions.find(InstRec);
 220     assert(I != Instructions.end() && "Not an instruction");
 221     return *I->second;
 222   }
 223
 224   /// getInstructionsByEnumValue - Return all of the instructions defined by the
 225   /// target, ordered by their enum value.
 226   const std::vector<const CodeGenInstruction*> &
 227   getInstructionsByEnumValue() const {
 228     if (InstrsByEnum.empty()) ComputeInstrsByEnum();
 229     return InstrsByEnum;
 230   }
 231
 232   typedef std::vector<const CodeGenInstruction*>::const_iterator inst_iterator;
 233   inst_iterator inst_begin() const{return getInstructionsByEnumValue().begin();}
 234   inst_iterator inst_end() const { return getInstructionsByEnumValue().end(); }
 235
 236
 237   /// isLittleEndianEncoding - are instruction bit patterns defined as  [0..n]?
 238   ///
 239   bool isLittleEndianEncoding() const;
 240
 241 private:
 242   void ComputeInstrsByEnum() const;
 243 };
 244
 245 /// ComplexPattern - ComplexPattern info, corresponding to the ComplexPattern
 246 /// tablegen class in TargetSelectionDAG.td
 247 class ComplexPattern {
 248   MVT::SimpleValueType Ty;
 249   unsigned NumOperands;
 250   std::string SelectFunc;
 251   std::vector<Record*> RootNodes;
 252   unsigned Properties; // Node properties
 253 public:
 254   ComplexPattern() : NumOperands(0) {}
 255   ComplexPattern(Record *R);
 256
 257   MVT::SimpleValueType getValueType() const { return Ty; }
 258   unsigned getNumOperands() const { return NumOperands; }
 259   const std::string &getSelectFunc() const { return SelectFunc; }
 260   const std::vector<Record*> &getRootNodes() const {
 261     return RootNodes;
 262   }
 263   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
 264 };
 265
 266 } // End llvm namespace
 267
 268 #endif