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