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