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