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 "llvm/Support/raw_ostream.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include <algorithm>
  25
  26 namespace llvm {
  27
  28 class Record;
  29 class RecordKeeper;
  30 struct CodeGenRegister;
  31 class CodeGenTarget;
  32
  33 // SelectionDAG node properties.
  34 //  SDNPMemOperand: indicates that a node touches memory and therefore must
  35 //                  have an associated memory operand that describes the access.
  36 enum SDNP {
  37   SDNPCommutative,
  38   SDNPAssociative,
  39   SDNPHasChain,
  40   SDNPOutFlag,
  41   SDNPInFlag,
  42   SDNPOptInFlag,
  43   SDNPMayLoad,
  44   SDNPMayStore,
  45   SDNPSideEffect,
  46   SDNPMemOperand,
  47   SDNPVariadic
  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<CodeGenRegisterClass> RegisterClasses;
  69   mutable std::vector<MVT::SimpleValueType> LegalValueTypes;
  70   void ReadRegisters() 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<CodeGenRegisterClass> &getRegisterClasses() const {
 104     if (RegisterClasses.empty()) ReadRegisterClasses();
 105     return RegisterClasses;
 106   }
 107
 108   const CodeGenRegisterClass &getRegisterClass(Record *R) const {
 109     const std::vector<CodeGenRegisterClass> &RC = getRegisterClasses();
 110     for (unsigned i = 0, e = RC.size(); i != e; ++i)
 111       if (RC[i].TheDef == R)
 112         return RC[i];
 113     assert(0 && "Didn't find the register class");
 114     abort();
 115   }
 116
 117   /// getRegisterClassForRegister - Find the register class that contains the
 118   /// specified physical register.  If the register is not in a register
 119   /// class, return null. If the register is in multiple classes, and the
 120   /// classes have a superset-subset relationship and the same set of
 121   /// types, return the superclass.  Otherwise return null.
 122   const CodeGenRegisterClass *getRegisterClassForRegister(Record *R) const {
 123     const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
 124     const CodeGenRegisterClass *FoundRC = 0;
 125     for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
 126       const CodeGenRegisterClass &RC = RegisterClasses[i];
 127       for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
 128         if (R != RC.Elements[ei])
 129           continue;
 130
 131         // If a register's classes have different types, return null.
 132         if (FoundRC && RC.getValueTypes() != FoundRC->getValueTypes())
 133           return 0;
 134
 135         // If this is the first class that contains the register,
 136         // make a note of it and go on to the next class.
 137         if (!FoundRC) {
 138           FoundRC = &RC;
 139           break;
 140         }
 141
 142         std::vector<Record *> Elements(RC.Elements);
 143         std::vector<Record *> FoundElements(FoundRC->Elements);
 144         std::sort(Elements.begin(), Elements.end());
 145         std::sort(FoundElements.begin(), FoundElements.end());
 146
 147         // Check to see if the previously found class that contains
 148         // the register is a subclass of the current class. If so,
 149         // prefer the superclass.
 150         if (std::includes(Elements.begin(), Elements.end(),
 151                           FoundElements.begin(), FoundElements.end())) {
 152           FoundRC = &RC;
 153           break;
 154         }
 155
 156         // Check to see if the previously found class that contains
 157         // the register is a superclass of the current class. If so,
 158         // prefer the superclass.
 159         if (std::includes(FoundElements.begin(), FoundElements.end(),
 160                           Elements.begin(), Elements.end()))
 161           break;
 162
 163         // Multiple classes, and neither is a superclass of the other.
 164         // Return null.
 165         return 0;
 166       }
 167     }
 168     return FoundRC;
 169   }
 170
 171   /// getRegisterVTs - Find the union of all possible SimpleValueTypes for the
 172   /// specified physical register.
 173   std::vector<MVT::SimpleValueType> getRegisterVTs(Record *R) const;
 174
 175   const std::vector<MVT::SimpleValueType> &getLegalValueTypes() const {
 176     if (LegalValueTypes.empty()) ReadLegalValueTypes();
 177     return LegalValueTypes;
 178   }
 179
 180   /// isLegalValueType - Return true if the specified value type is natively
 181   /// supported by the target (i.e. there are registers that directly hold it).
 182   bool isLegalValueType(MVT::SimpleValueType VT) const {
 183     const std::vector<MVT::SimpleValueType> &LegalVTs = getLegalValueTypes();
 184     for (unsigned i = 0, e = LegalVTs.size(); i != e; ++i)
 185       if (LegalVTs[i] == VT) return true;
 186     return false;
 187   }
 188
 189 private:
 190   DenseMap<const Record*, CodeGenInstruction*> &getInstructions() const {
 191     if (Instructions.empty()) ReadInstructions();
 192     return Instructions;
 193   }
 194 public:
 195
 196   CodeGenInstruction &getInstruction(const Record *InstRec) const {
 197     if (Instructions.empty()) ReadInstructions();
 198     DenseMap<const Record*, CodeGenInstruction*>::iterator I =
 199       Instructions.find(InstRec);
 200     assert(I != Instructions.end() && "Not an instruction");
 201     return *I->second;
 202   }
 203
 204   /// getInstructionsByEnumValue - Return all of the instructions defined by the
 205   /// target, ordered by their enum value.
 206   const std::vector<const CodeGenInstruction*> &
 207   getInstructionsByEnumValue() const {
 208     if (InstrsByEnum.empty()) ComputeInstrsByEnum();
 209     return InstrsByEnum;
 210   }
 211
 212   typedef std::vector<const CodeGenInstruction*>::const_iterator inst_iterator;
 213   inst_iterator inst_begin() const{return getInstructionsByEnumValue().begin();}
 214   inst_iterator inst_end() const { return getInstructionsByEnumValue().end(); }
 215
 216
 217   /// isLittleEndianEncoding - are instruction bit patterns defined as  [0..n]?
 218   ///
 219   bool isLittleEndianEncoding() const;
 220
 221 private:
 222   void ComputeInstrsByEnum() const;
 223 };
 224
 225 /// ComplexPattern - ComplexPattern info, corresponding to the ComplexPattern
 226 /// tablegen class in TargetSelectionDAG.td
 227 class ComplexPattern {
 228   MVT::SimpleValueType Ty;
 229   unsigned NumOperands;
 230   std::string SelectFunc;
 231   std::vector<Record*> RootNodes;
 232   unsigned Properties; // Node properties
 233 public:
 234   ComplexPattern() : NumOperands(0) {}
 235   ComplexPattern(Record *R);
 236
 237   MVT::SimpleValueType getValueType() const { return Ty; }
 238   unsigned getNumOperands() const { return NumOperands; }
 239   const std::string &getSelectFunc() const { return SelectFunc; }
 240   const std::vector<Record*> &getRootNodes() const {
 241     return RootNodes;
 242   }
 243   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
 244 };
 245
 246 } // End llvm namespace
 247
 248 #endif