Move instruction flag inference out of InstrInfoEmitter and into
[oota-llvm.git] / 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 <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 {
34   SDNPCommutative, 
35   SDNPAssociative, 
36   SDNPHasChain,
37   SDNPOutFlag,
38   SDNPInFlag,
39   SDNPOptInFlag,
40   SDNPMayLoad,
41   SDNPMayStore,
42   SDNPSideEffect
43 };
44
45 // ComplexPattern attributes.
46 enum CPAttr { CPAttrParentAsRoot };
47
48 /// getValueType - Return the MVT::ValueType that the specified TableGen record
49 /// corresponds to.
50 MVT::ValueType getValueType(Record *Rec);
51
52 std::string getName(MVT::ValueType T);
53 std::string getEnumName(MVT::ValueType 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 std::map<std::string, CodeGenInstruction> Instructions;
65   mutable std::vector<CodeGenRegister> Registers;
66   mutable std::vector<CodeGenRegisterClass> RegisterClasses;
67   mutable std::vector<MVT::ValueType> LegalValueTypes;
68   void ReadRegisters() const;
69   void ReadRegisterClasses() const;
70   void ReadInstructions() const;
71   void ReadLegalValueTypes() const;
72 public:
73   CodeGenTarget();
74
75   Record *getTargetRecord() const { return TargetRec; }
76   const std::string &getName() const;
77
78   /// getInstructionSet - Return the InstructionSet object.
79   ///
80   Record *getInstructionSet() const;
81
82   /// getAsmWriter - Return the AssemblyWriter definition for this target.
83   ///
84   Record *getAsmWriter() const;
85
86   const std::vector<CodeGenRegister> &getRegisters() const {
87     if (Registers.empty()) ReadRegisters();
88     return Registers;
89   }
90
91   const std::vector<CodeGenRegisterClass> &getRegisterClasses() const {
92     if (RegisterClasses.empty()) ReadRegisterClasses();
93     return RegisterClasses;
94   }
95   
96   const CodeGenRegisterClass &getRegisterClass(Record *R) const {
97     const std::vector<CodeGenRegisterClass> &RC = getRegisterClasses();
98     for (unsigned i = 0, e = RC.size(); i != e; ++i)
99       if (RC[i].TheDef == R)
100         return RC[i];
101     assert(0 && "Didn't find the register class");
102     abort();
103   }
104   
105   /// getRegisterClassForRegister - Find the register class that contains the
106   /// specified physical register.  If there register exists in multiple
107   /// register classes or is not in a register class, return null.
108   const CodeGenRegisterClass *getRegisterClassForRegister(Record *R) const {
109     const std::vector<CodeGenRegisterClass> &RCs = getRegisterClasses();
110     const CodeGenRegisterClass *FoundRC = 0;
111     for (unsigned i = 0, e = RCs.size(); i != e; ++i) {
112       const CodeGenRegisterClass &RC = RegisterClasses[i];
113       for (unsigned ei = 0, ee = RC.Elements.size(); ei != ee; ++ei) {
114         if (R == RC.Elements[ei]) {
115           if (FoundRC) return 0;  // In multiple RC's
116           FoundRC = &RC;
117           break;
118         }
119       }
120     }
121     return FoundRC;
122   }
123
124   /// getRegisterVTs - Find the union of all possible ValueTypes for the
125   /// specified physical register.
126   std::vector<unsigned char> getRegisterVTs(Record *R) const;
127   
128   const std::vector<MVT::ValueType> &getLegalValueTypes() const {
129     if (LegalValueTypes.empty()) ReadLegalValueTypes();
130     return LegalValueTypes;
131   }
132   
133   /// isLegalValueType - Return true if the specified value type is natively
134   /// supported by the target (i.e. there are registers that directly hold it).
135   bool isLegalValueType(MVT::ValueType VT) const {
136     const std::vector<MVT::ValueType> &LegalVTs = getLegalValueTypes();
137     for (unsigned i = 0, e = LegalVTs.size(); i != e; ++i)
138       if (LegalVTs[i] == VT) return true;
139     return false;    
140   }
141
142   /// getInstructions - Return all of the instructions defined for this target.
143   ///
144   const std::map<std::string, CodeGenInstruction> &getInstructions() const {
145     if (Instructions.empty()) ReadInstructions();
146     return Instructions;
147   }
148   std::map<std::string, CodeGenInstruction> &getInstructions() {
149     if (Instructions.empty()) ReadInstructions();
150     return Instructions;
151   }
152
153   CodeGenInstruction &getInstruction(const std::string &Name) const {
154     const std::map<std::string, CodeGenInstruction> &Insts = getInstructions();
155     assert(Insts.count(Name) && "Not an instruction!");
156     return const_cast<CodeGenInstruction&>(Insts.find(Name)->second);
157   }
158
159   typedef std::map<std::string,
160                    CodeGenInstruction>::const_iterator inst_iterator;
161   inst_iterator inst_begin() const { return getInstructions().begin(); }
162   inst_iterator inst_end() const { return Instructions.end(); }
163
164   /// getInstructionsByEnumValue - Return all of the instructions defined by the
165   /// target, ordered by their enum value.
166   void getInstructionsByEnumValue(std::vector<const CodeGenInstruction*>
167                                                 &NumberedInstructions);
168
169
170   /// isLittleEndianEncoding - are instruction bit patterns defined as  [0..n]?
171   ///
172   bool isLittleEndianEncoding() const;
173 };
174
175 /// ComplexPattern - ComplexPattern info, corresponding to the ComplexPattern
176 /// tablegen class in TargetSelectionDAG.td
177 class ComplexPattern {
178   MVT::ValueType Ty;
179   unsigned NumOperands;
180   std::string SelectFunc;
181   std::vector<Record*> RootNodes;
182   unsigned Properties; // Node properties
183   unsigned Attributes; // Pattern attributes
184 public:
185   ComplexPattern() : NumOperands(0) {};
186   ComplexPattern(Record *R);
187
188   MVT::ValueType getValueType() const { return Ty; }
189   unsigned getNumOperands() const { return NumOperands; }
190   const std::string &getSelectFunc() const { return SelectFunc; }
191   const std::vector<Record*> &getRootNodes() const {
192     return RootNodes;
193   }
194   bool hasProperty(enum SDNP Prop) const { return Properties & (1 << Prop); }
195   bool hasAttribute(enum CPAttr Attr) const { return Attributes & (1 << Attr); }
196 };
197
198 } // End llvm namespace
199
200 #endif