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