1 //===- Target.td - Target Independent TableGen interface ---*- tablegen -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the target-independent interfaces which should be
11 // implemented by each target which is using a TableGen based code generator.
13 //===----------------------------------------------------------------------===//
15 // Include all information about LLVM intrinsics.
16 include "llvm/Intrinsics.td"
18 //===----------------------------------------------------------------------===//
19 // Register file description - These classes are used to fill in the target
20 // description classes.
22 class RegisterClass; // Forward def
24 // SubRegIndex - Use instances of SubRegIndex to identify subregisters.
26 string Namespace = "";
29 // Register - You should define one instance of this class for each register
30 // in the target machine. String n will become the "name" of the register.
31 class Register<string n> {
32 string Namespace = "";
35 // SpillSize - If this value is set to a non-zero value, it is the size in
36 // bits of the spill slot required to hold this register. If this value is
37 // set to zero, the information is inferred from any register classes the
38 // register belongs to.
41 // SpillAlignment - This value is used to specify the alignment required for
42 // spilling the register. Like SpillSize, this should only be explicitly
43 // specified if the register is not in a register class.
44 int SpillAlignment = 0;
46 // Aliases - A list of registers that this register overlaps with. A read or
47 // modification of this register can potentially read or modify the aliased
49 list<Register> Aliases = [];
51 // SubRegs - A list of registers that are parts of this register. Note these
52 // are "immediate" sub-registers and the registers within the list do not
53 // themselves overlap. e.g. For X86, EAX's SubRegs list contains only [AX],
55 list<Register> SubRegs = [];
57 // SubRegIndices - For each register in SubRegs, specify the SubRegIndex used
58 // to address it. Sub-sub-register indices are automatically inherited from
60 list<SubRegIndex> SubRegIndices = [];
62 // CompositeIndices - Specify subreg indices that don't correspond directly to
63 // a register in SubRegs and are not inherited. The following formats are
66 // (a) Identity - Reg:a == Reg
67 // (a b) Alias - Reg:a == Reg:b
68 // (a b,c) Composite - Reg:a == (Reg:b):c
70 // This can be used to disambiguate a sub-sub-register that exists in more
71 // than one subregister and other weird stuff.
72 list<dag> CompositeIndices = [];
74 // DwarfNumbers - Numbers used internally by gcc/gdb to identify the register.
75 // These values can be determined by locating the <target>.h file in the
76 // directory llvmgcc/gcc/config/<target>/ and looking for REGISTER_NAMES. The
77 // order of these names correspond to the enumeration used by gcc. A value of
78 // -1 indicates that the gcc number is undefined and -2 that register number
79 // is invalid for this mode/flavour.
80 list<int> DwarfNumbers = [];
83 // RegisterWithSubRegs - This can be used to define instances of Register which
84 // need to specify sub-registers.
85 // List "subregs" specifies which registers are sub-registers to this one. This
86 // is used to populate the SubRegs and AliasSet fields of TargetRegisterDesc.
87 // This allows the code generator to be careful not to put two values with
88 // overlapping live ranges into registers which alias.
89 class RegisterWithSubRegs<string n, list<Register> subregs> : Register<n> {
90 let SubRegs = subregs;
93 // RegisterClass - Now that all of the registers are defined, and aliases
94 // between registers are defined, specify which registers belong to which
95 // register classes. This also defines the default allocation order of
96 // registers by register allocators.
98 class RegisterClass<string namespace, list<ValueType> regTypes, int alignment,
99 list<Register> regList> {
100 string Namespace = namespace;
102 // RegType - Specify the list ValueType of the registers in this register
103 // class. Note that all registers in a register class must have the same
104 // ValueTypes. This is a list because some targets permit storing different
105 // types in same register, for example vector values with 128-bit total size,
106 // but different count/size of items, like SSE on x86.
108 list<ValueType> RegTypes = regTypes;
110 // Size - Specify the spill size in bits of the registers. A default value of
111 // zero lets tablgen pick an appropriate size.
114 // Alignment - Specify the alignment required of the registers when they are
115 // stored or loaded to memory.
117 int Alignment = alignment;
119 // CopyCost - This value is used to specify the cost of copying a value
120 // between two registers in this register class. The default value is one
121 // meaning it takes a single instruction to perform the copying. A negative
122 // value means copying is extremely expensive or impossible.
125 // MemberList - Specify which registers are in this class. If the
126 // allocation_order_* method are not specified, this also defines the order of
127 // allocation used by the register allocator.
129 list<Register> MemberList = regList;
131 // SubRegClasses - Specify the register class of subregisters as a list of
132 // dags: (RegClass SubRegIndex, SubRegindex, ...)
133 list<dag> SubRegClasses = [];
135 // MethodProtos/MethodBodies - These members can be used to insert arbitrary
136 // code into a generated register class. The normal usage of this is to
137 // overload virtual methods.
138 code MethodProtos = [{}];
139 code MethodBodies = [{}];
143 //===----------------------------------------------------------------------===//
144 // DwarfRegNum - This class provides a mapping of the llvm register enumeration
145 // to the register numbering used by gcc and gdb. These values are used by a
146 // debug information writer to describe where values may be located during
148 class DwarfRegNum<list<int> Numbers> {
149 // DwarfNumbers - Numbers used internally by gcc/gdb to identify the register.
150 // These values can be determined by locating the <target>.h file in the
151 // directory llvmgcc/gcc/config/<target>/ and looking for REGISTER_NAMES. The
152 // order of these names correspond to the enumeration used by gcc. A value of
153 // -1 indicates that the gcc number is undefined and -2 that register number
154 // is invalid for this mode/flavour.
155 list<int> DwarfNumbers = Numbers;
158 //===----------------------------------------------------------------------===//
159 // Pull in the common support for scheduling
161 include "llvm/Target/TargetSchedule.td"
163 class Predicate; // Forward def
165 //===----------------------------------------------------------------------===//
166 // Instruction set description - These classes correspond to the C++ classes in
167 // the Target/TargetInstrInfo.h file.
170 string Namespace = "";
172 dag OutOperandList; // An dag containing the MI def operand list.
173 dag InOperandList; // An dag containing the MI use operand list.
174 string AsmString = ""; // The .s format to print the instruction with.
176 // Pattern - Set to the DAG pattern for this instruction, if we know of one,
177 // otherwise, uninitialized.
180 // The follow state will eventually be inferred automatically from the
181 // instruction pattern.
183 list<Register> Uses = []; // Default to using no non-operand registers
184 list<Register> Defs = []; // Default to modifying no non-operand registers
186 // Predicates - List of predicates which will be turned into isel matching
188 list<Predicate> Predicates = [];
193 // Added complexity passed onto matching pattern.
194 int AddedComplexity = 0;
196 // These bits capture information about the high-level semantics of the
198 bit isReturn = 0; // Is this instruction a return instruction?
199 bit isBranch = 0; // Is this instruction a branch instruction?
200 bit isIndirectBranch = 0; // Is this instruction an indirect branch?
201 bit isCompare = 0; // Is this instruction a comparison instruction?
202 bit isBarrier = 0; // Can control flow fall through this instruction?
203 bit isCall = 0; // Is this instruction a call instruction?
204 bit canFoldAsLoad = 0; // Can this be folded as a simple memory operand?
205 bit mayLoad = 0; // Is it possible for this inst to read memory?
206 bit mayStore = 0; // Is it possible for this inst to write memory?
207 bit isConvertibleToThreeAddress = 0; // Can this 2-addr instruction promote?
208 bit isCommutable = 0; // Is this 3 operand instruction commutable?
209 bit isTerminator = 0; // Is this part of the terminator for a basic block?
210 bit isReMaterializable = 0; // Is this instruction re-materializable?
211 bit isPredicable = 0; // Is this instruction predicable?
212 bit hasDelaySlot = 0; // Does this instruction have an delay slot?
213 bit usesCustomInserter = 0; // Pseudo instr needing special help.
214 bit hasCtrlDep = 0; // Does this instruction r/w ctrl-flow chains?
215 bit isNotDuplicable = 0; // Is it unsafe to duplicate this instruction?
216 bit isAsCheapAsAMove = 0; // As cheap (or cheaper) than a move instruction.
217 bit hasExtraSrcRegAllocReq = 0; // Sources have special regalloc requirement?
218 bit hasExtraDefRegAllocReq = 0; // Defs have special regalloc requirement?
220 // Side effect flags - When set, the flags have these meanings:
222 // hasSideEffects - The instruction has side effects that are not
223 // captured by any operands of the instruction or other flags.
225 // neverHasSideEffects - Set on an instruction with no pattern if it has no
227 bit hasSideEffects = 0;
228 bit neverHasSideEffects = 0;
230 // Is this instruction a "real" instruction (with a distinct machine
231 // encoding), or is it a pseudo instruction used for codegen modeling
233 bit isCodeGenOnly = 0;
235 // Is this instruction a pseudo instruction for use by the assembler parser.
236 bit isAsmParserOnly = 0;
238 InstrItinClass Itinerary = NoItinerary;// Execution steps used for scheduling.
240 string Constraints = ""; // OperandConstraint, e.g. $src = $dst.
242 /// DisableEncoding - List of operand names (e.g. "$op1,$op2") that should not
243 /// be encoded into the output machineinstr.
244 string DisableEncoding = "";
246 string PostEncoderMethod = "";
248 /// Target-specific flags. This becomes the TSFlags field in TargetInstrDesc.
249 bits<64> TSFlags = 0;
252 /// Predicates - These are extra conditionals which are turned into instruction
253 /// selector matching code. Currently each predicate is just a string.
254 class Predicate<string cond> {
255 string CondString = cond;
257 /// AssemblerMatcherPredicate - If this feature can be used by the assembler
258 /// matcher, this is true. Targets should set this by inheriting their
259 /// feature from the AssemblerPredicate class in addition to Predicate.
260 bit AssemblerMatcherPredicate = 0;
263 /// NoHonorSignDependentRounding - This predicate is true if support for
264 /// sign-dependent-rounding is not enabled.
265 def NoHonorSignDependentRounding
266 : Predicate<"!HonorSignDependentRoundingFPMath()">;
268 class Requires<list<Predicate> preds> {
269 list<Predicate> Predicates = preds;
272 /// ops definition - This is just a simple marker used to identify the operand
273 /// list for an instruction. outs and ins are identical both syntactically and
274 /// semanticallyr; they are used to define def operands and use operands to
275 /// improve readibility. This should be used like this:
276 /// (outs R32:$dst), (ins R32:$src1, R32:$src2) or something similar.
281 /// variable_ops definition - Mark this instruction as taking a variable number
286 /// PointerLikeRegClass - Values that are designed to have pointer width are
287 /// derived from this. TableGen treats the register class as having a symbolic
288 /// type that it doesn't know, and resolves the actual regclass to use by using
289 /// the TargetRegisterInfo::getPointerRegClass() hook at codegen time.
290 class PointerLikeRegClass<int Kind> {
291 int RegClassKind = Kind;
295 /// ptr_rc definition - Mark this operand as being a pointer value whose
296 /// register class is resolved dynamically via a callback to TargetInstrInfo.
297 /// FIXME: We should probably change this to a class which contain a list of
298 /// flags. But currently we have but one flag.
299 def ptr_rc : PointerLikeRegClass<0>;
301 /// unknown definition - Mark this operand as being of unknown type, causing
302 /// it to be resolved by inference in the context it is used.
305 /// AsmOperandClass - Representation for the kinds of operands which the target
306 /// specific parser can create and the assembly matcher may need to distinguish.
308 /// Operand classes are used to define the order in which instructions are
309 /// matched, to ensure that the instruction which gets matched for any
310 /// particular list of operands is deterministic.
312 /// The target specific parser must be able to classify a parsed operand into a
313 /// unique class which does not partially overlap with any other classes. It can
314 /// match a subset of some other class, in which case the super class field
315 /// should be defined.
316 class AsmOperandClass {
317 /// The name to use for this class, which should be usable as an enum value.
320 /// The super classes of this operand.
321 list<AsmOperandClass> SuperClasses = [];
323 /// The name of the method on the target specific operand to call to test
324 /// whether the operand is an instance of this class. If not set, this will
325 /// default to "isFoo", where Foo is the AsmOperandClass name. The method
326 /// signature should be:
327 /// bool isFoo() const;
328 string PredicateMethod = ?;
330 /// The name of the method on the target specific operand to call to add the
331 /// target specific operand to an MCInst. If not set, this will default to
332 /// "addFooOperands", where Foo is the AsmOperandClass name. The method
333 /// signature should be:
334 /// void addFooOperands(MCInst &Inst, unsigned N) const;
335 string RenderMethod = ?;
338 def ImmAsmOperand : AsmOperandClass {
342 /// Operand Types - These provide the built-in operand types that may be used
343 /// by a target. Targets can optionally provide their own operand types as
344 /// needed, though this should not be needed for RISC targets.
345 class Operand<ValueType ty> {
347 string PrintMethod = "printOperand";
348 string EncoderMethod = "";
349 string AsmOperandLowerMethod = ?;
350 dag MIOperandInfo = (ops);
352 // ParserMatchClass - The "match class" that operands of this type fit
353 // in. Match classes are used to define the order in which instructions are
354 // match, to ensure that which instructions gets matched is deterministic.
356 // The target specific parser must be able to classify an parsed operand into
357 // a unique class, which does not partially overlap with any other classes. It
358 // can match a subset of some other class, in which case the AsmOperandClass
359 // should declare the other operand as one of its super classes.
360 AsmOperandClass ParserMatchClass = ImmAsmOperand;
363 def i1imm : Operand<i1>;
364 def i8imm : Operand<i8>;
365 def i16imm : Operand<i16>;
366 def i32imm : Operand<i32>;
367 def i64imm : Operand<i64>;
369 def f32imm : Operand<f32>;
370 def f64imm : Operand<f64>;
372 /// zero_reg definition - Special node to stand for the zero register.
376 /// PredicateOperand - This can be used to define a predicate operand for an
377 /// instruction. OpTypes specifies the MIOperandInfo for the operand, and
378 /// AlwaysVal specifies the value of this predicate when set to "always
380 class PredicateOperand<ValueType ty, dag OpTypes, dag AlwaysVal>
382 let MIOperandInfo = OpTypes;
383 dag DefaultOps = AlwaysVal;
386 /// OptionalDefOperand - This is used to define a optional definition operand
387 /// for an instruction. DefaultOps is the register the operand represents if
388 /// none is supplied, e.g. zero_reg.
389 class OptionalDefOperand<ValueType ty, dag OpTypes, dag defaultops>
391 let MIOperandInfo = OpTypes;
392 dag DefaultOps = defaultops;
396 // InstrInfo - This class should only be instantiated once to provide parameters
397 // which are global to the target machine.
400 // Target can specify its instructions in either big or little-endian formats.
401 // For instance, while both Sparc and PowerPC are big-endian platforms, the
402 // Sparc manual specifies its instructions in the format [31..0] (big), while
403 // PowerPC specifies them using the format [0..31] (little).
404 bit isLittleEndianEncoding = 0;
407 // Standard Pseudo Instructions.
408 // This list must match TargetOpcodes.h and CodeGenTarget.cpp.
409 // Only these instructions are allowed in the TargetOpcode namespace.
410 let isCodeGenOnly = 1, Namespace = "TargetOpcode" in {
411 def PHI : Instruction {
412 let OutOperandList = (outs);
413 let InOperandList = (ins variable_ops);
414 let AsmString = "PHINODE";
416 def INLINEASM : Instruction {
417 let OutOperandList = (outs);
418 let InOperandList = (ins variable_ops);
421 def PROLOG_LABEL : Instruction {
422 let OutOperandList = (outs);
423 let InOperandList = (ins i32imm:$id);
426 let isNotDuplicable = 1;
428 def EH_LABEL : Instruction {
429 let OutOperandList = (outs);
430 let InOperandList = (ins i32imm:$id);
433 let isNotDuplicable = 1;
435 def GC_LABEL : Instruction {
436 let OutOperandList = (outs);
437 let InOperandList = (ins i32imm:$id);
440 let isNotDuplicable = 1;
442 def KILL : Instruction {
443 let OutOperandList = (outs);
444 let InOperandList = (ins variable_ops);
446 let neverHasSideEffects = 1;
448 def EXTRACT_SUBREG : Instruction {
449 let OutOperandList = (outs unknown:$dst);
450 let InOperandList = (ins unknown:$supersrc, i32imm:$subidx);
452 let neverHasSideEffects = 1;
454 def INSERT_SUBREG : Instruction {
455 let OutOperandList = (outs unknown:$dst);
456 let InOperandList = (ins unknown:$supersrc, unknown:$subsrc, i32imm:$subidx);
458 let neverHasSideEffects = 1;
459 let Constraints = "$supersrc = $dst";
461 def IMPLICIT_DEF : Instruction {
462 let OutOperandList = (outs unknown:$dst);
463 let InOperandList = (ins);
465 let neverHasSideEffects = 1;
466 let isReMaterializable = 1;
467 let isAsCheapAsAMove = 1;
469 def SUBREG_TO_REG : Instruction {
470 let OutOperandList = (outs unknown:$dst);
471 let InOperandList = (ins unknown:$implsrc, unknown:$subsrc, i32imm:$subidx);
473 let neverHasSideEffects = 1;
475 def COPY_TO_REGCLASS : Instruction {
476 let OutOperandList = (outs unknown:$dst);
477 let InOperandList = (ins unknown:$src, i32imm:$regclass);
479 let neverHasSideEffects = 1;
480 let isAsCheapAsAMove = 1;
482 def DBG_VALUE : Instruction {
483 let OutOperandList = (outs);
484 let InOperandList = (ins variable_ops);
485 let AsmString = "DBG_VALUE";
486 let isAsCheapAsAMove = 1;
488 def REG_SEQUENCE : Instruction {
489 let OutOperandList = (outs unknown:$dst);
490 let InOperandList = (ins variable_ops);
492 let neverHasSideEffects = 1;
493 let isAsCheapAsAMove = 1;
495 def COPY : Instruction {
496 let OutOperandList = (outs unknown:$dst);
497 let InOperandList = (ins unknown:$src);
499 let neverHasSideEffects = 1;
500 let isAsCheapAsAMove = 1;
504 //===----------------------------------------------------------------------===//
505 // AsmParser - This class can be implemented by targets that wish to implement
508 // Subtargets can have multiple different assembly parsers (e.g. AT&T vs Intel
509 // syntax on X86 for example).
512 // AsmParserClassName - This specifies the suffix to use for the asmparser
513 // class. Generated AsmParser classes are always prefixed with the target
515 string AsmParserClassName = "AsmParser";
517 // AsmParserInstCleanup - If non-empty, this is the name of a custom member
518 // function of the AsmParser class to call on every matched instruction.
519 // This can be used to perform target specific instruction post-processing.
520 string AsmParserInstCleanup = "";
522 // Variant - AsmParsers can be of multiple different variants. Variants are
523 // used to support targets that need to parser multiple formats for the
524 // assembly language.
527 // CommentDelimiter - If given, the delimiter string used to recognize
528 // comments which are hard coded in the .td assembler strings for individual
530 string CommentDelimiter = "";
532 // RegisterPrefix - If given, the token prefix which indicates a register
533 // token. This is used by the matcher to automatically recognize hard coded
534 // register tokens as constrained registers, instead of tokens, for the
535 // purposes of matching.
536 string RegisterPrefix = "";
538 def DefaultAsmParser : AsmParser;
540 /// AssemblerPredicate - This is a Predicate that can be used when the assembler
541 /// matches instructions and aliases.
542 class AssemblerPredicate {
543 bit AssemblerMatcherPredicate = 1;
548 /// MnemonicAlias - This class allows targets to define assembler mnemonic
549 /// aliases. This should be used when all forms of one mnemonic are accepted
550 /// with a different mnemonic. For example, X86 allows:
551 /// sal %al, 1 -> shl %al, 1
552 /// sal %ax, %cl -> shl %ax, %cl
553 /// sal %eax, %cl -> shl %eax, %cl
554 /// etc. Though "sal" is accepted with many forms, all of them are directly
555 /// translated to a shl, so it can be handled with (in the case of X86, it
556 /// actually has one for each suffix as well):
557 /// def : MnemonicAlias<"sal", "shl">;
559 /// Mnemonic aliases are mapped before any other translation in the match phase,
560 /// and do allow Requires predicates, e.g.:
562 /// def : MnemonicAlias<"pushf", "pushfq">, Requires<[In64BitMode]>;
563 /// def : MnemonicAlias<"pushf", "pushfl">, Requires<[In32BitMode]>;
565 class MnemonicAlias<string From, string To> {
566 string FromMnemonic = From;
567 string ToMnemonic = To;
569 // Predicates - Predicates that must be true for this remapping to happen.
570 list<Predicate> Predicates = [];
573 /// InstAlias - This defines an alternate assembly syntax that is allowed to
574 /// match an instruction that has a different (more canonical) assembly
576 class InstAlias<string Asm, dag Result> {
577 string AsmString = Asm; // The .s format to match the instruction with.
578 dag ResultInst = Result; // The MCInst to generate.
580 // Predicates - Predicates that must be true for this to match.
581 list<Predicate> Predicates = [];
584 //===----------------------------------------------------------------------===//
585 // AsmWriter - This class can be implemented by targets that need to customize
586 // the format of the .s file writer.
588 // Subtargets can have multiple different asmwriters (e.g. AT&T vs Intel syntax
589 // on X86 for example).
592 // AsmWriterClassName - This specifies the suffix to use for the asmwriter
593 // class. Generated AsmWriter classes are always prefixed with the target
595 string AsmWriterClassName = "AsmPrinter";
597 // Variant - AsmWriters can be of multiple different variants. Variants are
598 // used to support targets that need to emit assembly code in ways that are
599 // mostly the same for different targets, but have minor differences in
600 // syntax. If the asmstring contains {|} characters in them, this integer
601 // will specify which alternative to use. For example "{x|y|z}" with Variant
602 // == 1, will expand to "y".
606 // FirstOperandColumn/OperandSpacing - If the assembler syntax uses a columnar
607 // layout, the asmwriter can actually generate output in this columns (in
608 // verbose-asm mode). These two values indicate the width of the first column
609 // (the "opcode" area) and the width to reserve for subsequent operands. When
610 // verbose asm mode is enabled, operands will be indented to respect this.
611 int FirstOperandColumn = -1;
613 // OperandSpacing - Space between operand columns.
614 int OperandSpacing = -1;
616 // isMCAsmWriter - Is this assembly writer for an MC emitter? This controls
617 // generation of the printInstruction() method. For MC printers, it takes
618 // an MCInstr* operand, otherwise it takes a MachineInstr*.
619 bit isMCAsmWriter = 0;
621 def DefaultAsmWriter : AsmWriter;
624 //===----------------------------------------------------------------------===//
625 // Target - This class contains the "global" target information
628 // InstructionSet - Instruction set description for this target.
629 InstrInfo InstructionSet;
631 // AssemblyParsers - The AsmParser instances available for this target.
632 list<AsmParser> AssemblyParsers = [DefaultAsmParser];
634 // AssemblyWriters - The AsmWriter instances available for this target.
635 list<AsmWriter> AssemblyWriters = [DefaultAsmWriter];
638 //===----------------------------------------------------------------------===//
639 // SubtargetFeature - A characteristic of the chip set.
641 class SubtargetFeature<string n, string a, string v, string d,
642 list<SubtargetFeature> i = []> {
643 // Name - Feature name. Used by command line (-mattr=) to determine the
644 // appropriate target chip.
648 // Attribute - Attribute to be set by feature.
650 string Attribute = a;
652 // Value - Value the attribute to be set to by feature.
656 // Desc - Feature description. Used by command line (-mattr=) to display help
661 // Implies - Features that this feature implies are present. If one of those
662 // features isn't set, then this one shouldn't be set either.
664 list<SubtargetFeature> Implies = i;
667 //===----------------------------------------------------------------------===//
668 // Processor chip sets - These values represent each of the chip sets supported
669 // by the scheduler. Each Processor definition requires corresponding
670 // instruction itineraries.
672 class Processor<string n, ProcessorItineraries pi, list<SubtargetFeature> f> {
673 // Name - Chip set name. Used by command line (-mcpu=) to determine the
674 // appropriate target chip.
678 // ProcItin - The scheduling information for the target processor.
680 ProcessorItineraries ProcItin = pi;
682 // Features - list of
683 list<SubtargetFeature> Features = f;
686 //===----------------------------------------------------------------------===//
687 // Pull in the common support for calling conventions.
689 include "llvm/Target/TargetCallingConv.td"
691 //===----------------------------------------------------------------------===//
692 // Pull in the common support for DAG isel generation.
694 include "llvm/Target/TargetSelectionDAG.td"