Added properties such as SDNPHasChain to ComplexPattern.
[oota-llvm.git] / utils / TableGen / CodeGenTarget.h
1 //===- CodeGenTarget.h - Target Class Wrapper -------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 <iosfwd>
23 #include <map>
24
25 namespace llvm {
26
27 class Record;
28 class RecordKeeper;
29 struct CodeGenRegister;
30 class CodeGenTarget;
31
32 // SelectionDAG node properties.
33 enum SDNP { SDNPCommutative, SDNPAssociative, SDNPHasChain,
34             SDNPOutFlag, SDNPInFlag, SDNPOptInFlag  };
35
36 /// getValueType - Return the MVT::ValueType that the specified TableGen record
37 /// corresponds to.
38 MVT::ValueType getValueType(Record *Rec, const CodeGenTarget *CGT = 0);
39
40 std::ostream &operator<<(std::ostream &OS, MVT::ValueType T);
41 std::string getName(MVT::ValueType T);
42 std::string getEnumName(MVT::ValueType T);
43
44
45 /// CodeGenTarget - This class corresponds to the Target class in the .td files.
46 ///
47 class CodeGenTarget {
48   Record *TargetRec;
49
50   mutable std::map<std::string, CodeGenInstruction> Instructions;
51   mutable std::vector<CodeGenRegister> Registers;
52   mutable std::vector<CodeGenRegisterClass> RegisterClasses;
53   mutable std::vector<MVT::ValueType> LegalValueTypes;
54   void ReadRegisters() const;
55   void ReadRegisterClasses() const;
56   void ReadInstructions() const;
57   void ReadLegalValueTypes() const;
58 public:
59   CodeGenTarget();
60
61   Record *getTargetRecord() const { return TargetRec; }
62   const std::string &getName() const;
63
64   /// getInstructionSet - Return the InstructionSet object.
65   ///
66   Record *getInstructionSet() const;
67
68   /// getAsmWriter - Return the AssemblyWriter definition for this target.
69   ///
70   Record *getAsmWriter() const;
71
72   const std::vector<CodeGenRegister> &getRegisters() const {
73     if (Registers.empty()) ReadRegisters();
74     return Registers;
75   }
76
77   const std::vector<CodeGenRegisterClass> &getRegisterClasses() const {
78     if (RegisterClasses.empty()) ReadRegisterClasses();
79     return RegisterClasses;
80   }
81   
82   const CodeGenRegisterClass &getRegisterClass(Record *R) const {
83     const std::vector<CodeGenRegisterClass> &RC = getRegisterClasses();
84     for (unsigned i = 0, e = RC.size(); i != e; ++i)
85       if (RC[i].TheDef == R)
86         return RC[i];
87     assert(0 && "Didn't find the register class");
88     abort();
89   }
90   
91   /// getRegisterClassForRegister - Find the register class that contains the
92   /// specified physical register.  If there register exists in multiple
93   /// register classes or is not in a register class, return null.
94   const CodeGenRegisterClass *getRegisterClassForRegister(Record *R) const {
95     const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
96     const CodeGenRegisterClass *FoundRC = 0;
97     for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
98       const CodeGenRegisterClass &RC = RegisterClasses[i];
99       for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
100         if (R == RC.Elements[ei]) {
101           if (FoundRC) return 0;  // In multiple RC's
102           FoundRC = &RC;
103           break;
104         }
105       }
106     }
107     return FoundRC;
108   }
109
110   /// getRegisterVTs - Find the union of all possible ValueTypes for the
111   /// specified physical register.
112   std::vector<unsigned char> getRegisterVTs(Record *R) const;
113   
114   const std::vector<MVT::ValueType> &getLegalValueTypes() const {
115     if (LegalValueTypes.empty()) ReadLegalValueTypes();
116     return LegalValueTypes;
117   }
118   
119   /// isLegalValueType - Return true if the specified value type is natively
120   /// supported by the target (i.e. there are registers that directly hold it).
121   bool isLegalValueType(MVT::ValueType VT) const {
122     const std::vector<MVT::ValueType> &LegalVTs = getLegalValueTypes();
123     for (unsigned i = 0, e = LegalVTs.size(); i != e; ++i)
124       if (LegalVTs[i] == VT) return true;
125     return false;    
126   }
127
128   /// getInstructions - Return all of the instructions defined for this target.
129   ///
130   const std::map<std::string, CodeGenInstruction> &getInstructions() const {
131     if (Instructions.empty()) ReadInstructions();
132     return Instructions;
133   }
134
135   CodeGenInstruction &getInstruction(const std::string &Name) const {
136     const std::map<std::string, CodeGenInstruction> &Insts = getInstructions();
137     assert(Insts.count(Name) && "Not an instruction!");
138     return const_cast<CodeGenInstruction&>(Insts.find(Name)->second);
139   }
140
141   typedef std::map<std::string,
142                    CodeGenInstruction>::const_iterator inst_iterator;
143   inst_iterator inst_begin() const { return getInstructions().begin(); }
144   inst_iterator inst_end() const { return Instructions.end(); }
145
146   /// getInstructionsByEnumValue - Return all of the instructions defined by the
147   /// target, ordered by their enum value.
148   void getInstructionsByEnumValue(std::vector<const CodeGenInstruction*>
149                                                 &NumberedInstructions);
150
151
152   /// isLittleEndianEncoding - are instruction bit patterns defined as  [0..n]?
153   ///
154   bool isLittleEndianEncoding() const;
155 };
156
157 /// ComplexPattern - ComplexPattern info, corresponding to the ComplexPattern
158 /// tablegen class in TargetSelectionDAG.td
159 class ComplexPattern {
160   MVT::ValueType Ty;
161   unsigned NumOperands;
162   std::string SelectFunc;
163   std::vector<Record*> RootNodes;
164   unsigned Properties;
165 public:
166   ComplexPattern() : NumOperands(0) {};
167   ComplexPattern(Record *R);
168
169   MVT::ValueType getValueType() const { return Ty; }
170   unsigned getNumOperands() const { return NumOperands; }
171   const std::string &getSelectFunc() const { return SelectFunc; }
172   const std::vector<Record*> &getRootNodes() const {
173     return RootNodes;
174   }
175   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
176
177 };
178
179 } // End llvm namespace
180
181 #endif