Adjust to changes in getRegForInlineAsmConstraint prototype
[oota-llvm.git] / lib / Target / Target.td
1 //===- Target.td - Target Independent TableGen interface ---*- tablegen -*-===//
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 the target-independent interfaces which should be
11 // implemented by each target which is using a TableGen based code generator.
12 //
13 //===----------------------------------------------------------------------===//
14
15
16 //===----------------------------------------------------------------------===//
17 //
18 // Value types - These values correspond to the register types defined in the
19 // ValueTypes.h file.  If you update anything here, you must update it there as
20 // well!
21 //
22 class ValueType<int size, int value> {
23   string Namespace = "MVT";
24   int Size = size;
25   int Value = value;
26 }
27
28 def OtherVT: ValueType<0  ,  0>;   // "Other" value
29 def i1     : ValueType<1  ,  1>;   // One bit boolean value
30 def i8     : ValueType<8  ,  2>;   // 8-bit integer value
31 def i16    : ValueType<16 ,  3>;   // 16-bit integer value
32 def i32    : ValueType<32 ,  4>;   // 32-bit integer value
33 def i64    : ValueType<64 ,  5>;   // 64-bit integer value
34 def i128   : ValueType<128,  6>;   // 128-bit integer value
35 def f32    : ValueType<32 ,  7>;   // 32-bit floating point value
36 def f64    : ValueType<64 ,  8>;   // 64-bit floating point value
37 def f80    : ValueType<80 ,  9>;   // 80-bit floating point value
38 def f128   : ValueType<128, 10>;   // 128-bit floating point value
39 def FlagVT : ValueType<0  , 11>;   // Condition code or machine flag
40 def isVoid : ValueType<0  , 12>;   // Produces no value
41 def Vector : ValueType<0  , 13>;   // Abstract vector value
42 def v8i8   : ValueType<64 , 14>;   //  8 x i8  vector value
43 def v4i16  : ValueType<64 , 15>;   //  4 x i16 vector value
44 def v2i32  : ValueType<64 , 16>;   //  2 x i32 vector value
45 def v16i8  : ValueType<128, 17>;   // 16 x i8  vector value
46 def v8i16  : ValueType<128, 18>;   //  8 x i16 vector value
47 def v4i32  : ValueType<128, 19>;   //  4 x i32 vector value
48 def v2i64  : ValueType<128, 20>;   //  2 x i64 vector value
49 def v4f32  : ValueType<128, 21>;   //  4 x f32 vector value
50 def v2f64  : ValueType<128, 22>;   //  2 x f64 vector value
51
52 //===----------------------------------------------------------------------===//
53 // Register file description - These classes are used to fill in the target
54 // description classes.
55
56 class RegisterClass; // Forward def
57
58 // Register - You should define one instance of this class for each register
59 // in the target machine.  String n will become the "name" of the register.
60 class Register<string n> {
61   string Namespace = "";
62   string Name = n;
63
64   // SpillSize - If this value is set to a non-zero value, it is the size in
65   // bits of the spill slot required to hold this register.  If this value is
66   // set to zero, the information is inferred from any register classes the
67   // register belongs to.
68   int SpillSize = 0;
69
70   // SpillAlignment - This value is used to specify the alignment required for
71   // spilling the register.  Like SpillSize, this should only be explicitly
72   // specified if the register is not in a register class.
73   int SpillAlignment = 0;
74
75   // Aliases - A list of registers that this register overlaps with.  A read or
76   // modification of this register can potentially read or modifie the aliased
77   // registers.
78   //
79   list<Register> Aliases = [];
80 }
81
82 // RegisterGroup - This can be used to define instances of Register which
83 // need to specify aliases.
84 // List "aliases" specifies which registers are aliased to this one.  This
85 // allows the code generator to be careful not to put two values with 
86 // overlapping live ranges into registers which alias.
87 class RegisterGroup<string n, list<Register> aliases> : Register<n> {
88   let Aliases = aliases;
89 }
90
91 // RegisterClass - Now that all of the registers are defined, and aliases
92 // between registers are defined, specify which registers belong to which
93 // register classes.  This also defines the default allocation order of
94 // registers by register allocators.
95 //
96 class RegisterClass<string namespace, list<ValueType> regTypes, int alignment,
97                     list<Register> regList> {
98   string Namespace = namespace;
99
100   // RegType - Specify the ValueType of the registers in this register class.
101   // Note that all registers in a register class must have the same ValueType.
102   //
103   list<ValueType> RegTypes = regTypes;
104
105   // Size - Specify the spill size in bits of the registers.  A default value of
106   // zero lets tablgen pick an appropriate size.
107   int Size = 0;
108
109   // Alignment - Specify the alignment required of the registers when they are
110   // stored or loaded to memory.
111   //
112   int Alignment = alignment;
113
114   // MemberList - Specify which registers are in this class.  If the
115   // allocation_order_* method are not specified, this also defines the order of
116   // allocation used by the register allocator.
117   //
118   list<Register> MemberList = regList;
119
120   // MethodProtos/MethodBodies - These members can be used to insert arbitrary
121   // code into a generated register class.   The normal usage of this is to 
122   // overload virtual methods.
123   code MethodProtos = [{}];
124   code MethodBodies = [{}];
125 }
126
127
128 //===----------------------------------------------------------------------===//
129 // Pull in the common support for scheduling
130 //
131 include "../TargetSchedule.td"
132
133 class Predicate; // Forward def
134
135 //===----------------------------------------------------------------------===//
136 // Instruction set description - These classes correspond to the C++ classes in
137 // the Target/TargetInstrInfo.h file.
138 //
139 class Instruction {
140   string Name = "";         // The opcode string for this instruction
141   string Namespace = "";
142
143   dag OperandList;          // An dag containing the MI operand list.
144   string AsmString = "";    // The .s format to print the instruction with.
145
146   // Pattern - Set to the DAG pattern for this instruction, if we know of one,
147   // otherwise, uninitialized.
148   list<dag> Pattern;
149
150   // The follow state will eventually be inferred automatically from the
151   // instruction pattern.
152
153   list<Register> Uses = []; // Default to using no non-operand registers
154   list<Register> Defs = []; // Default to modifying no non-operand registers
155
156   // Predicates - List of predicates which will be turned into isel matching
157   // code.
158   list<Predicate> Predicates = [];
159
160   // These bits capture information about the high-level semantics of the
161   // instruction.
162   bit isReturn     = 0;     // Is this instruction a return instruction?
163   bit isBranch     = 0;     // Is this instruction a branch instruction?
164   bit isBarrier    = 0;     // Can control flow fall through this instruction?
165   bit isCall       = 0;     // Is this instruction a call instruction?
166   bit isLoad       = 0;     // Is this instruction a load instruction?
167   bit isStore      = 0;     // Is this instruction a store instruction?
168   bit isTwoAddress = 0;     // Is this a two address instruction?
169   bit isConvertibleToThreeAddress = 0;  // Can this 2-addr instruction promote?
170   bit isCommutable = 0;     // Is this 3 operand instruction commutable?
171   bit isTerminator = 0;     // Is this part of the terminator for a basic block?
172   bit hasDelaySlot = 0;     // Does this instruction have an delay slot?
173   bit usesCustomDAGSchedInserter = 0; // Pseudo instr needing special help.
174   bit hasCtrlDep   = 0;     // Does this instruction r/w ctrl-flow chains?
175   bit noResults    = 0;     // Does this instruction produce no results?
176   
177   InstrItinClass Itinerary = NoItinerary;// Execution steps used for scheduling.
178 }
179
180 /// Predicates - These are extra conditionals which are turned into instruction
181 /// selector matching code. Currently each predicate is just a string.
182 class Predicate<string cond> {
183   string CondString = cond;
184 }
185
186 class Requires<list<Predicate> preds> {
187   list<Predicate> Predicates = preds;
188 }
189
190 /// ops definition - This is just a simple marker used to identify the operands
191 /// list for an instruction.  This should be used like this:
192 ///     (ops R32:$dst, R32:$src) or something similar.
193 def ops;
194
195 /// variable_ops definition - Mark this instruction as taking a variable number
196 /// of operands.
197 def variable_ops;
198
199 /// Operand Types - These provide the built-in operand types that may be used
200 /// by a target.  Targets can optionally provide their own operand types as
201 /// needed, though this should not be needed for RISC targets.
202 class Operand<ValueType ty> {
203   ValueType Type = ty;
204   string PrintMethod = "printOperand";
205   int NumMIOperands = 1;
206   dag MIOperandInfo = (ops);
207 }
208
209 def i1imm  : Operand<i1>;
210 def i8imm  : Operand<i8>;
211 def i16imm : Operand<i16>;
212 def i32imm : Operand<i32>;
213 def i64imm : Operand<i64>;
214
215 // InstrInfo - This class should only be instantiated once to provide parameters
216 // which are global to the the target machine.
217 //
218 class InstrInfo {
219   // If the target wants to associate some target-specific information with each
220   // instruction, it should provide these two lists to indicate how to assemble
221   // the target specific information into the 32 bits available.
222   //
223   list<string> TSFlagsFields = [];
224   list<int>    TSFlagsShifts = [];
225
226   // Target can specify its instructions in either big or little-endian formats.
227   // For instance, while both Sparc and PowerPC are big-endian platforms, the
228   // Sparc manual specifies its instructions in the format [31..0] (big), while
229   // PowerPC specifies them using the format [0..31] (little).
230   bit isLittleEndianEncoding = 0;
231 }
232
233 // Standard Instructions.
234 def PHI : Instruction {
235   let OperandList = (ops variable_ops);
236   let AsmString = "PHINODE";
237 }
238 def INLINEASM : Instruction {
239   let OperandList = (ops variable_ops);
240   let AsmString = "";
241 }
242
243 //===----------------------------------------------------------------------===//
244 // AsmWriter - This class can be implemented by targets that need to customize
245 // the format of the .s file writer.
246 //
247 // Subtargets can have multiple different asmwriters (e.g. AT&T vs Intel syntax
248 // on X86 for example).
249 //
250 class AsmWriter {
251   // AsmWriterClassName - This specifies the suffix to use for the asmwriter
252   // class.  Generated AsmWriter classes are always prefixed with the target
253   // name.
254   string AsmWriterClassName  = "AsmPrinter";
255
256   // InstFormatName - AsmWriters can specify the name of the format string to
257   // print instructions with.
258   string InstFormatName = "AsmString";
259
260   // Variant - AsmWriters can be of multiple different variants.  Variants are
261   // used to support targets that need to emit assembly code in ways that are
262   // mostly the same for different targets, but have minor differences in
263   // syntax.  If the asmstring contains {|} characters in them, this integer
264   // will specify which alternative to use.  For example "{x|y|z}" with Variant
265   // == 1, will expand to "y".
266   int Variant = 0;
267 }
268 def DefaultAsmWriter : AsmWriter;
269
270
271 //===----------------------------------------------------------------------===//
272 // Target - This class contains the "global" target information
273 //
274 class Target {
275   // CalleeSavedRegisters - As you might guess, this is a list of the callee
276   // saved registers for a target.
277   list<Register> CalleeSavedRegisters = [];
278   
279   // PointerType - Specify the value type to be used to represent pointers in
280   // this target.  Typically this is an i32 or i64 type.
281   ValueType PointerType;
282
283   // InstructionSet - Instruction set description for this target.
284   InstrInfo InstructionSet;
285
286   // AssemblyWriters - The AsmWriter instances available for this target.
287   list<AsmWriter> AssemblyWriters = [DefaultAsmWriter];
288 }
289
290 //===----------------------------------------------------------------------===//
291 // SubtargetFeature - A characteristic of the chip set.
292 //
293 class SubtargetFeature<string n, string a,  string v, string d> {
294   // Name - Feature name.  Used by command line (-mattr=) to determine the
295   // appropriate target chip.
296   //
297   string Name = n;
298   
299   // Attribute - Attribute to be set by feature.
300   //
301   string Attribute = a;
302   
303   // Value - Value the attribute to be set to by feature.
304   //
305   string Value = v;
306   
307   // Desc - Feature description.  Used by command line (-mattr=) to display help
308   // information.
309   //
310   string Desc = d;
311 }
312
313 //===----------------------------------------------------------------------===//
314 // Processor chip sets - These values represent each of the chip sets supported
315 // by the scheduler.  Each Processor definition requires corresponding
316 // instruction itineraries.
317 //
318 class Processor<string n, ProcessorItineraries pi, list<SubtargetFeature> f> {
319   // Name - Chip set name.  Used by command line (-mcpu=) to determine the
320   // appropriate target chip.
321   //
322   string Name = n;
323   
324   // ProcItin - The scheduling information for the target processor.
325   //
326   ProcessorItineraries ProcItin = pi;
327   
328   // Features - list of 
329   list<SubtargetFeature> Features = f;
330 }
331
332 //===----------------------------------------------------------------------===//
333 // Pull in the common support for DAG isel generation
334 //
335 include "../TargetSelectionDAG.td"