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/IR/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.
25 class SubRegIndex<int size, int offset = 0> {
26 string Namespace = "";
28 // Size - Size (in bits) of the sub-registers represented by this index.
31 // Offset - Offset of the first bit that is part of this sub-register index.
32 // Set it to -1 if the same index is used to represent sub-registers that can
33 // be at different offsets (for example when using an index to access an
34 // element in a register tuple).
37 // ComposedOf - A list of two SubRegIndex instances, [A, B].
38 // This indicates that this SubRegIndex is the result of composing A and B.
39 // See ComposedSubRegIndex.
40 list<SubRegIndex> ComposedOf = [];
42 // CoveringSubRegIndices - A list of two or more sub-register indexes that
43 // cover this sub-register.
45 // This field should normally be left blank as TableGen can infer it.
47 // TableGen automatically detects sub-registers that straddle the registers
48 // in the SubRegs field of a Register definition. For example:
50 // Q0 = dsub_0 -> D0, dsub_1 -> D1
51 // Q1 = dsub_0 -> D2, dsub_1 -> D3
52 // D1_D2 = dsub_0 -> D1, dsub_1 -> D2
53 // QQ0 = qsub_0 -> Q0, qsub_1 -> Q1
55 // TableGen will infer that D1_D2 is a sub-register of QQ0. It will be given
56 // the synthetic index dsub_1_dsub_2 unless some SubRegIndex is defined with
57 // CoveringSubRegIndices = [dsub_1, dsub_2].
58 list<SubRegIndex> CoveringSubRegIndices = [];
61 // ComposedSubRegIndex - A sub-register that is the result of composing A and B.
62 // Offset is set to the sum of A and B's Offsets. Size is set to B's Size.
63 class ComposedSubRegIndex<SubRegIndex A, SubRegIndex B>
64 : SubRegIndex<B.Size, !if(!eq(A.Offset, -1), -1,
65 !if(!eq(B.Offset, -1), -1,
66 !add(A.Offset, B.Offset)))> {
68 let ComposedOf = [A, B];
71 // RegAltNameIndex - The alternate name set to use for register operands of
72 // this register class when printing.
73 class RegAltNameIndex {
74 string Namespace = "";
76 def NoRegAltName : RegAltNameIndex;
78 // Register - You should define one instance of this class for each register
79 // in the target machine. String n will become the "name" of the register.
80 class Register<string n, list<string> altNames = []> {
81 string Namespace = "";
83 list<string> AltNames = altNames;
85 // Aliases - A list of registers that this register overlaps with. A read or
86 // modification of this register can potentially read or modify the aliased
88 list<Register> Aliases = [];
90 // SubRegs - A list of registers that are parts of this register. Note these
91 // are "immediate" sub-registers and the registers within the list do not
92 // themselves overlap. e.g. For X86, EAX's SubRegs list contains only [AX],
94 list<Register> SubRegs = [];
96 // SubRegIndices - For each register in SubRegs, specify the SubRegIndex used
97 // to address it. Sub-sub-register indices are automatically inherited from
99 list<SubRegIndex> SubRegIndices = [];
101 // RegAltNameIndices - The alternate name indices which are valid for this
103 list<RegAltNameIndex> RegAltNameIndices = [];
105 // DwarfNumbers - Numbers used internally by gcc/gdb to identify the register.
106 // These values can be determined by locating the <target>.h file in the
107 // directory llvmgcc/gcc/config/<target>/ and looking for REGISTER_NAMES. The
108 // order of these names correspond to the enumeration used by gcc. A value of
109 // -1 indicates that the gcc number is undefined and -2 that register number
110 // is invalid for this mode/flavour.
111 list<int> DwarfNumbers = [];
113 // CostPerUse - Additional cost of instructions using this register compared
114 // to other registers in its class. The register allocator will try to
115 // minimize the number of instructions using a register with a CostPerUse.
116 // This is used by the x86-64 and ARM Thumb targets where some registers
117 // require larger instruction encodings.
120 // CoveredBySubRegs - When this bit is set, the value of this register is
121 // completely determined by the value of its sub-registers. For example, the
122 // x86 register AX is covered by its sub-registers AL and AH, but EAX is not
123 // covered by its sub-register AX.
124 bit CoveredBySubRegs = 0;
126 // HWEncoding - The target specific hardware encoding for this register.
127 bits<16> HWEncoding = 0;
130 // RegisterWithSubRegs - This can be used to define instances of Register which
131 // need to specify sub-registers.
132 // List "subregs" specifies which registers are sub-registers to this one. This
133 // is used to populate the SubRegs and AliasSet fields of TargetRegisterDesc.
134 // This allows the code generator to be careful not to put two values with
135 // overlapping live ranges into registers which alias.
136 class RegisterWithSubRegs<string n, list<Register> subregs> : Register<n> {
137 let SubRegs = subregs;
140 // DAGOperand - An empty base class that unifies RegisterClass's and other forms
141 // of Operand's that are legal as type qualifiers in DAG patterns. This should
142 // only ever be used for defining multiclasses that are polymorphic over both
143 // RegisterClass's and other Operand's.
146 // RegisterClass - Now that all of the registers are defined, and aliases
147 // between registers are defined, specify which registers belong to which
148 // register classes. This also defines the default allocation order of
149 // registers by register allocators.
151 class RegisterClass<string namespace, list<ValueType> regTypes, int alignment,
152 dag regList, RegAltNameIndex idx = NoRegAltName>
154 string Namespace = namespace;
156 // RegType - Specify the list ValueType of the registers in this register
157 // class. Note that all registers in a register class must have the same
158 // ValueTypes. This is a list because some targets permit storing different
159 // types in same register, for example vector values with 128-bit total size,
160 // but different count/size of items, like SSE on x86.
162 list<ValueType> RegTypes = regTypes;
164 // Size - Specify the spill size in bits of the registers. A default value of
165 // zero lets tablgen pick an appropriate size.
168 // Alignment - Specify the alignment required of the registers when they are
169 // stored or loaded to memory.
171 int Alignment = alignment;
173 // CopyCost - This value is used to specify the cost of copying a value
174 // between two registers in this register class. The default value is one
175 // meaning it takes a single instruction to perform the copying. A negative
176 // value means copying is extremely expensive or impossible.
179 // MemberList - Specify which registers are in this class. If the
180 // allocation_order_* method are not specified, this also defines the order of
181 // allocation used by the register allocator.
183 dag MemberList = regList;
185 // AltNameIndex - The alternate register name to use when printing operands
186 // of this register class. Every register in the register class must have
187 // a valid alternate name for the given index.
188 RegAltNameIndex altNameIndex = idx;
190 // isAllocatable - Specify that the register class can be used for virtual
191 // registers and register allocation. Some register classes are only used to
192 // model instruction operand constraints, and should have isAllocatable = 0.
193 bit isAllocatable = 1;
195 // AltOrders - List of alternative allocation orders. The default order is
196 // MemberList itself, and that is good enough for most targets since the
197 // register allocators automatically remove reserved registers and move
198 // callee-saved registers to the end.
199 list<dag> AltOrders = [];
201 // AltOrderSelect - The body of a function that selects the allocation order
202 // to use in a given machine function. The code will be inserted in a
203 // function like this:
205 // static inline unsigned f(const MachineFunction &MF) { ... }
207 // The function should return 0 to select the default order defined by
208 // MemberList, 1 to select the first AltOrders entry and so on.
209 code AltOrderSelect = [{}];
212 // The memberList in a RegisterClass is a dag of set operations. TableGen
213 // evaluates these set operations and expand them into register lists. These
214 // are the most common operation, see test/TableGen/SetTheory.td for more
215 // examples of what is possible:
217 // (add R0, R1, R2) - Set Union. Each argument can be an individual register, a
218 // register class, or a sub-expression. This is also the way to simply list
221 // (sub GPR, SP) - Set difference. Subtract the last arguments from the first.
223 // (and GPR, CSR) - Set intersection. All registers from the first set that are
224 // also in the second set.
226 // (sequence "R%u", 0, 15) -> [R0, R1, ..., R15]. Generate a sequence of
227 // numbered registers. Takes an optional 4th operand which is a stride to use
228 // when generating the sequence.
230 // (shl GPR, 4) - Remove the first N elements.
232 // (trunc GPR, 4) - Truncate after the first N elements.
234 // (rotl GPR, 1) - Rotate N places to the left.
236 // (rotr GPR, 1) - Rotate N places to the right.
238 // (decimate GPR, 2) - Pick every N'th element, starting with the first.
240 // (interleave A, B, ...) - Interleave the elements from each argument list.
242 // All of these operators work on ordered sets, not lists. That means
243 // duplicates are removed from sub-expressions.
245 // Set operators. The rest is defined in TargetSelectionDAG.td.
250 // RegisterTuples - Automatically generate super-registers by forming tuples of
251 // sub-registers. This is useful for modeling register sequence constraints
252 // with pseudo-registers that are larger than the architectural registers.
254 // The sub-register lists are zipped together:
256 // def EvenOdd : RegisterTuples<[sube, subo], [(add R0, R2), (add R1, R3)]>;
258 // Generates the same registers as:
260 // let SubRegIndices = [sube, subo] in {
261 // def R0_R1 : RegisterWithSubRegs<"", [R0, R1]>;
262 // def R2_R3 : RegisterWithSubRegs<"", [R2, R3]>;
265 // The generated pseudo-registers inherit super-classes and fields from their
266 // first sub-register. Most fields from the Register class are inferred, and
267 // the AsmName and Dwarf numbers are cleared.
269 // RegisterTuples instances can be used in other set operations to form
270 // register classes and so on. This is the only way of using the generated
272 class RegisterTuples<list<SubRegIndex> Indices, list<dag> Regs> {
273 // SubRegs - N lists of registers to be zipped up. Super-registers are
274 // synthesized from the first element of each SubRegs list, the second
275 // element and so on.
276 list<dag> SubRegs = Regs;
278 // SubRegIndices - N SubRegIndex instances. This provides the names of the
279 // sub-registers in the synthesized super-registers.
280 list<SubRegIndex> SubRegIndices = Indices;
284 //===----------------------------------------------------------------------===//
285 // DwarfRegNum - This class provides a mapping of the llvm register enumeration
286 // to the register numbering used by gcc and gdb. These values are used by a
287 // debug information writer to describe where values may be located during
289 class DwarfRegNum<list<int> Numbers> {
290 // DwarfNumbers - Numbers used internally by gcc/gdb to identify the register.
291 // These values can be determined by locating the <target>.h file in the
292 // directory llvmgcc/gcc/config/<target>/ and looking for REGISTER_NAMES. The
293 // order of these names correspond to the enumeration used by gcc. A value of
294 // -1 indicates that the gcc number is undefined and -2 that register number
295 // is invalid for this mode/flavour.
296 list<int> DwarfNumbers = Numbers;
299 // DwarfRegAlias - This class declares that a given register uses the same dwarf
300 // numbers as another one. This is useful for making it clear that the two
301 // registers do have the same number. It also lets us build a mapping
302 // from dwarf register number to llvm register.
303 class DwarfRegAlias<Register reg> {
304 Register DwarfAlias = reg;
307 //===----------------------------------------------------------------------===//
308 // Pull in the common support for scheduling
310 include "llvm/Target/TargetSchedule.td"
312 class Predicate; // Forward def
314 //===----------------------------------------------------------------------===//
315 // Instruction set description - These classes correspond to the C++ classes in
316 // the Target/TargetInstrInfo.h file.
319 string Namespace = "";
321 dag OutOperandList; // An dag containing the MI def operand list.
322 dag InOperandList; // An dag containing the MI use operand list.
323 string AsmString = ""; // The .s format to print the instruction with.
325 // Pattern - Set to the DAG pattern for this instruction, if we know of one,
326 // otherwise, uninitialized.
329 // The follow state will eventually be inferred automatically from the
330 // instruction pattern.
332 list<Register> Uses = []; // Default to using no non-operand registers
333 list<Register> Defs = []; // Default to modifying no non-operand registers
335 // Predicates - List of predicates which will be turned into isel matching
337 list<Predicate> Predicates = [];
339 // Size - Size of encoded instruction, or zero if the size cannot be determined
343 // DecoderNamespace - The "namespace" in which this instruction exists, on
344 // targets like ARM which multiple ISA namespaces exist.
345 string DecoderNamespace = "";
347 // Code size, for instruction selection.
348 // FIXME: What does this actually mean?
351 // Added complexity passed onto matching pattern.
352 int AddedComplexity = 0;
354 // These bits capture information about the high-level semantics of the
356 bit isReturn = 0; // Is this instruction a return instruction?
357 bit isBranch = 0; // Is this instruction a branch instruction?
358 bit isIndirectBranch = 0; // Is this instruction an indirect branch?
359 bit isCompare = 0; // Is this instruction a comparison instruction?
360 bit isMoveImm = 0; // Is this instruction a move immediate instruction?
361 bit isBitcast = 0; // Is this instruction a bitcast instruction?
362 bit isSelect = 0; // Is this instruction a select instruction?
363 bit isBarrier = 0; // Can control flow fall through this instruction?
364 bit isCall = 0; // Is this instruction a call instruction?
365 bit canFoldAsLoad = 0; // Can this be folded as a simple memory operand?
366 bit mayLoad = ?; // Is it possible for this inst to read memory?
367 bit mayStore = ?; // Is it possible for this inst to write memory?
368 bit isConvertibleToThreeAddress = 0; // Can this 2-addr instruction promote?
369 bit isCommutable = 0; // Is this 3 operand instruction commutable?
370 bit isTerminator = 0; // Is this part of the terminator for a basic block?
371 bit isReMaterializable = 0; // Is this instruction re-materializable?
372 bit isPredicable = 0; // Is this instruction predicable?
373 bit hasDelaySlot = 0; // Does this instruction have an delay slot?
374 bit usesCustomInserter = 0; // Pseudo instr needing special help.
375 bit hasPostISelHook = 0; // To be *adjusted* after isel by target hook.
376 bit hasCtrlDep = 0; // Does this instruction r/w ctrl-flow chains?
377 bit isNotDuplicable = 0; // Is it unsafe to duplicate this instruction?
378 bit isAsCheapAsAMove = 0; // As cheap (or cheaper) than a move instruction.
379 bit hasExtraSrcRegAllocReq = 0; // Sources have special regalloc requirement?
380 bit hasExtraDefRegAllocReq = 0; // Defs have special regalloc requirement?
381 bit isRegSequence = 0; // Is this instruction a kind of reg sequence?
382 // If so, make sure to override
383 // TargetInstrInfo::getRegSequenceLikeInputs.
384 bit isPseudo = 0; // Is this instruction a pseudo-instruction?
385 // If so, won't have encoding information for
386 // the [MC]CodeEmitter stuff.
387 bit isExtractSubreg = 0; // Is this instruction a kind of extract subreg?
388 // If so, make sure to override
389 // TargetInstrInfo::getExtractSubregLikeInputs.
390 bit isInsertSubreg = 0; // Is this instruction a kind of insert subreg?
391 // If so, make sure to override
392 // TargetInstrInfo::getInsertSubregLikeInputs.
394 // Side effect flags - When set, the flags have these meanings:
396 // hasSideEffects - The instruction has side effects that are not
397 // captured by any operands of the instruction or other flags.
399 // neverHasSideEffects (deprecated) - Set on an instruction with no pattern
400 // if it has no side effects. This is now equivalent to setting
401 // "hasSideEffects = 0".
402 bit hasSideEffects = ?;
403 bit neverHasSideEffects = 0;
405 // Is this instruction a "real" instruction (with a distinct machine
406 // encoding), or is it a pseudo instruction used for codegen modeling
408 // FIXME: For now this is distinct from isPseudo, above, as code-gen-only
409 // instructions can (and often do) still have encoding information
410 // associated with them. Once we've migrated all of them over to true
411 // pseudo-instructions that are lowered to real instructions prior to
412 // the printer/emitter, we can remove this attribute and just use isPseudo.
414 // The intended use is:
415 // isPseudo: Does not have encoding information and should be expanded,
416 // at the latest, during lowering to MCInst.
418 // isCodeGenOnly: Does have encoding information and can go through to the
419 // CodeEmitter unchanged, but duplicates a canonical instruction
420 // definition's encoding and should be ignored when constructing the
421 // assembler match tables.
422 bit isCodeGenOnly = 0;
424 // Is this instruction a pseudo instruction for use by the assembler parser.
425 bit isAsmParserOnly = 0;
427 InstrItinClass Itinerary = NoItinerary;// Execution steps used for scheduling.
429 // Scheduling information from TargetSchedule.td.
430 list<SchedReadWrite> SchedRW;
432 string Constraints = ""; // OperandConstraint, e.g. $src = $dst.
434 /// DisableEncoding - List of operand names (e.g. "$op1,$op2") that should not
435 /// be encoded into the output machineinstr.
436 string DisableEncoding = "";
438 string PostEncoderMethod = "";
439 string DecoderMethod = "";
441 /// Target-specific flags. This becomes the TSFlags field in TargetInstrDesc.
442 bits<64> TSFlags = 0;
444 ///@name Assembler Parser Support
447 string AsmMatchConverter = "";
449 /// TwoOperandAliasConstraint - Enable TableGen to auto-generate a
450 /// two-operand matcher inst-alias for a three operand instruction.
451 /// For example, the arm instruction "add r3, r3, r5" can be written
452 /// as "add r3, r5". The constraint is of the same form as a tied-operand
453 /// constraint. For example, "$Rn = $Rd".
454 string TwoOperandAliasConstraint = "";
458 /// UseNamedOperandTable - If set, the operand indices of this instruction
459 /// can be queried via the getNamedOperandIdx() function which is generated
461 bit UseNamedOperandTable = 0;
464 /// PseudoInstExpansion - Expansion information for a pseudo-instruction.
465 /// Which instruction it expands to and how the operands map from the
467 class PseudoInstExpansion<dag Result> {
468 dag ResultInst = Result; // The instruction to generate.
472 /// Predicates - These are extra conditionals which are turned into instruction
473 /// selector matching code. Currently each predicate is just a string.
474 class Predicate<string cond> {
475 string CondString = cond;
477 /// AssemblerMatcherPredicate - If this feature can be used by the assembler
478 /// matcher, this is true. Targets should set this by inheriting their
479 /// feature from the AssemblerPredicate class in addition to Predicate.
480 bit AssemblerMatcherPredicate = 0;
482 /// AssemblerCondString - Name of the subtarget feature being tested used
483 /// as alternative condition string used for assembler matcher.
484 /// e.g. "ModeThumb" is translated to "(Bits & ModeThumb) != 0".
485 /// "!ModeThumb" is translated to "(Bits & ModeThumb) == 0".
486 /// It can also list multiple features separated by ",".
487 /// e.g. "ModeThumb,FeatureThumb2" is translated to
488 /// "(Bits & ModeThumb) != 0 && (Bits & FeatureThumb2) != 0".
489 string AssemblerCondString = "";
491 /// PredicateName - User-level name to use for the predicate. Mainly for use
492 /// in diagnostics such as missing feature errors in the asm matcher.
493 string PredicateName = "";
496 /// NoHonorSignDependentRounding - This predicate is true if support for
497 /// sign-dependent-rounding is not enabled.
498 def NoHonorSignDependentRounding
499 : Predicate<"!TM.Options.HonorSignDependentRoundingFPMath()">;
501 class Requires<list<Predicate> preds> {
502 list<Predicate> Predicates = preds;
505 /// ops definition - This is just a simple marker used to identify the operand
506 /// list for an instruction. outs and ins are identical both syntactically and
507 /// semanticallyr; they are used to define def operands and use operands to
508 /// improve readibility. This should be used like this:
509 /// (outs R32:$dst), (ins R32:$src1, R32:$src2) or something similar.
514 /// variable_ops definition - Mark this instruction as taking a variable number
519 /// PointerLikeRegClass - Values that are designed to have pointer width are
520 /// derived from this. TableGen treats the register class as having a symbolic
521 /// type that it doesn't know, and resolves the actual regclass to use by using
522 /// the TargetRegisterInfo::getPointerRegClass() hook at codegen time.
523 class PointerLikeRegClass<int Kind> {
524 int RegClassKind = Kind;
528 /// ptr_rc definition - Mark this operand as being a pointer value whose
529 /// register class is resolved dynamically via a callback to TargetInstrInfo.
530 /// FIXME: We should probably change this to a class which contain a list of
531 /// flags. But currently we have but one flag.
532 def ptr_rc : PointerLikeRegClass<0>;
534 /// unknown definition - Mark this operand as being of unknown type, causing
535 /// it to be resolved by inference in the context it is used.
537 def unknown : unknown_class;
539 /// AsmOperandClass - Representation for the kinds of operands which the target
540 /// specific parser can create and the assembly matcher may need to distinguish.
542 /// Operand classes are used to define the order in which instructions are
543 /// matched, to ensure that the instruction which gets matched for any
544 /// particular list of operands is deterministic.
546 /// The target specific parser must be able to classify a parsed operand into a
547 /// unique class which does not partially overlap with any other classes. It can
548 /// match a subset of some other class, in which case the super class field
549 /// should be defined.
550 class AsmOperandClass {
551 /// The name to use for this class, which should be usable as an enum value.
554 /// The super classes of this operand.
555 list<AsmOperandClass> SuperClasses = [];
557 /// The name of the method on the target specific operand to call to test
558 /// whether the operand is an instance of this class. If not set, this will
559 /// default to "isFoo", where Foo is the AsmOperandClass name. The method
560 /// signature should be:
561 /// bool isFoo() const;
562 string PredicateMethod = ?;
564 /// The name of the method on the target specific operand to call to add the
565 /// target specific operand to an MCInst. If not set, this will default to
566 /// "addFooOperands", where Foo is the AsmOperandClass name. The method
567 /// signature should be:
568 /// void addFooOperands(MCInst &Inst, unsigned N) const;
569 string RenderMethod = ?;
571 /// The name of the method on the target specific operand to call to custom
572 /// handle the operand parsing. This is useful when the operands do not relate
573 /// to immediates or registers and are very instruction specific (as flags to
574 /// set in a processor register, coprocessor number, ...).
575 string ParserMethod = ?;
577 // The diagnostic type to present when referencing this operand in a
578 // match failure error message. By default, use a generic "invalid operand"
579 // diagnostic. The target AsmParser maps these codes to text.
580 string DiagnosticType = "";
583 def ImmAsmOperand : AsmOperandClass {
587 /// Operand Types - These provide the built-in operand types that may be used
588 /// by a target. Targets can optionally provide their own operand types as
589 /// needed, though this should not be needed for RISC targets.
590 class Operand<ValueType ty> : DAGOperand {
592 string PrintMethod = "printOperand";
593 string EncoderMethod = "";
594 string DecoderMethod = "";
595 string AsmOperandLowerMethod = ?;
596 string OperandType = "OPERAND_UNKNOWN";
597 dag MIOperandInfo = (ops);
599 // MCOperandPredicate - Optionally, a code fragment operating on
600 // const MCOperand &MCOp, and returning a bool, to indicate if
601 // the value of MCOp is valid for the specific subclass of Operand
602 code MCOperandPredicate;
604 // ParserMatchClass - The "match class" that operands of this type fit
605 // in. Match classes are used to define the order in which instructions are
606 // match, to ensure that which instructions gets matched is deterministic.
608 // The target specific parser must be able to classify an parsed operand into
609 // a unique class, which does not partially overlap with any other classes. It
610 // can match a subset of some other class, in which case the AsmOperandClass
611 // should declare the other operand as one of its super classes.
612 AsmOperandClass ParserMatchClass = ImmAsmOperand;
615 class RegisterOperand<RegisterClass regclass, string pm = "printOperand">
617 // RegClass - The register class of the operand.
618 RegisterClass RegClass = regclass;
619 // PrintMethod - The target method to call to print register operands of
620 // this type. The method normally will just use an alt-name index to look
621 // up the name to print. Default to the generic printOperand().
622 string PrintMethod = pm;
623 // ParserMatchClass - The "match class" that operands of this type fit
624 // in. Match classes are used to define the order in which instructions are
625 // match, to ensure that which instructions gets matched is deterministic.
627 // The target specific parser must be able to classify an parsed operand into
628 // a unique class, which does not partially overlap with any other classes. It
629 // can match a subset of some other class, in which case the AsmOperandClass
630 // should declare the other operand as one of its super classes.
631 AsmOperandClass ParserMatchClass;
634 let OperandType = "OPERAND_IMMEDIATE" in {
635 def i1imm : Operand<i1>;
636 def i8imm : Operand<i8>;
637 def i16imm : Operand<i16>;
638 def i32imm : Operand<i32>;
639 def i64imm : Operand<i64>;
641 def f32imm : Operand<f32>;
642 def f64imm : Operand<f64>;
645 /// zero_reg definition - Special node to stand for the zero register.
649 /// All operands which the MC layer classifies as predicates should inherit from
650 /// this class in some manner. This is already handled for the most commonly
651 /// used PredicateOperand, but may be useful in other circumstances.
654 /// OperandWithDefaultOps - This Operand class can be used as the parent class
655 /// for an Operand that needs to be initialized with a default value if
656 /// no value is supplied in a pattern. This class can be used to simplify the
657 /// pattern definitions for instructions that have target specific flags
658 /// encoded as immediate operands.
659 class OperandWithDefaultOps<ValueType ty, dag defaultops>
661 dag DefaultOps = defaultops;
664 /// PredicateOperand - This can be used to define a predicate operand for an
665 /// instruction. OpTypes specifies the MIOperandInfo for the operand, and
666 /// AlwaysVal specifies the value of this predicate when set to "always
668 class PredicateOperand<ValueType ty, dag OpTypes, dag AlwaysVal>
669 : OperandWithDefaultOps<ty, AlwaysVal>, PredicateOp {
670 let MIOperandInfo = OpTypes;
673 /// OptionalDefOperand - This is used to define a optional definition operand
674 /// for an instruction. DefaultOps is the register the operand represents if
675 /// none is supplied, e.g. zero_reg.
676 class OptionalDefOperand<ValueType ty, dag OpTypes, dag defaultops>
677 : OperandWithDefaultOps<ty, defaultops> {
678 let MIOperandInfo = OpTypes;
682 // InstrInfo - This class should only be instantiated once to provide parameters
683 // which are global to the target machine.
686 // Target can specify its instructions in either big or little-endian formats.
687 // For instance, while both Sparc and PowerPC are big-endian platforms, the
688 // Sparc manual specifies its instructions in the format [31..0] (big), while
689 // PowerPC specifies them using the format [0..31] (little).
690 bit isLittleEndianEncoding = 0;
692 // The instruction properties mayLoad, mayStore, and hasSideEffects are unset
693 // by default, and TableGen will infer their value from the instruction
694 // pattern when possible.
696 // Normally, TableGen will issue an error it it can't infer the value of a
697 // property that hasn't been set explicitly. When guessInstructionProperties
698 // is set, it will guess a safe value instead.
700 // This option is a temporary migration help. It will go away.
701 bit guessInstructionProperties = 1;
703 // TableGen's instruction encoder generator has support for matching operands
704 // to bit-field variables both by name and by position. While matching by
705 // name is preferred, this is currently not possible for complex operands,
706 // and some targets still reply on the positional encoding rules. When
707 // generating a decoder for such targets, the positional encoding rules must
708 // be used by the decoder generator as well.
710 // This option is temporary; it will go away once the TableGen decoder
711 // generator has better support for complex operands and targets have
712 // migrated away from using positionally encoded operands.
713 bit decodePositionallyEncodedOperands = 0;
715 // When set, this indicates that there will be no overlap between those
716 // operands that are matched by ordering (positional operands) and those
719 // This option is temporary; it will go away once the TableGen decoder
720 // generator has better support for complex operands and targets have
721 // migrated away from using positionally encoded operands.
722 bit noNamedPositionallyEncodedOperands = 0;
725 // Standard Pseudo Instructions.
726 // This list must match TargetOpcodes.h and CodeGenTarget.cpp.
727 // Only these instructions are allowed in the TargetOpcode namespace.
728 let isCodeGenOnly = 1, isPseudo = 1, Namespace = "TargetOpcode" in {
729 def PHI : Instruction {
730 let OutOperandList = (outs);
731 let InOperandList = (ins variable_ops);
732 let AsmString = "PHINODE";
734 def INLINEASM : Instruction {
735 let OutOperandList = (outs);
736 let InOperandList = (ins variable_ops);
738 let neverHasSideEffects = 1; // Note side effect is encoded in an operand.
740 def CFI_INSTRUCTION : Instruction {
741 let OutOperandList = (outs);
742 let InOperandList = (ins i32imm:$id);
745 let isNotDuplicable = 1;
747 def EH_LABEL : Instruction {
748 let OutOperandList = (outs);
749 let InOperandList = (ins i32imm:$id);
752 let isNotDuplicable = 1;
754 def GC_LABEL : Instruction {
755 let OutOperandList = (outs);
756 let InOperandList = (ins i32imm:$id);
759 let isNotDuplicable = 1;
761 def KILL : Instruction {
762 let OutOperandList = (outs);
763 let InOperandList = (ins variable_ops);
765 let neverHasSideEffects = 1;
767 def EXTRACT_SUBREG : Instruction {
768 let OutOperandList = (outs unknown:$dst);
769 let InOperandList = (ins unknown:$supersrc, i32imm:$subidx);
771 let neverHasSideEffects = 1;
773 def INSERT_SUBREG : Instruction {
774 let OutOperandList = (outs unknown:$dst);
775 let InOperandList = (ins unknown:$supersrc, unknown:$subsrc, i32imm:$subidx);
777 let neverHasSideEffects = 1;
778 let Constraints = "$supersrc = $dst";
780 def IMPLICIT_DEF : Instruction {
781 let OutOperandList = (outs unknown:$dst);
782 let InOperandList = (ins);
784 let neverHasSideEffects = 1;
785 let isReMaterializable = 1;
786 let isAsCheapAsAMove = 1;
788 def SUBREG_TO_REG : Instruction {
789 let OutOperandList = (outs unknown:$dst);
790 let InOperandList = (ins unknown:$implsrc, unknown:$subsrc, i32imm:$subidx);
792 let neverHasSideEffects = 1;
794 def COPY_TO_REGCLASS : Instruction {
795 let OutOperandList = (outs unknown:$dst);
796 let InOperandList = (ins unknown:$src, i32imm:$regclass);
798 let neverHasSideEffects = 1;
799 let isAsCheapAsAMove = 1;
801 def DBG_VALUE : Instruction {
802 let OutOperandList = (outs);
803 let InOperandList = (ins variable_ops);
804 let AsmString = "DBG_VALUE";
805 let neverHasSideEffects = 1;
807 def REG_SEQUENCE : Instruction {
808 let OutOperandList = (outs unknown:$dst);
809 let InOperandList = (ins variable_ops);
811 let neverHasSideEffects = 1;
812 let isAsCheapAsAMove = 1;
814 def COPY : Instruction {
815 let OutOperandList = (outs unknown:$dst);
816 let InOperandList = (ins unknown:$src);
818 let neverHasSideEffects = 1;
819 let isAsCheapAsAMove = 1;
821 def BUNDLE : Instruction {
822 let OutOperandList = (outs);
823 let InOperandList = (ins variable_ops);
824 let AsmString = "BUNDLE";
826 def LIFETIME_START : Instruction {
827 let OutOperandList = (outs);
828 let InOperandList = (ins i32imm:$id);
829 let AsmString = "LIFETIME_START";
830 let neverHasSideEffects = 1;
832 def LIFETIME_END : Instruction {
833 let OutOperandList = (outs);
834 let InOperandList = (ins i32imm:$id);
835 let AsmString = "LIFETIME_END";
836 let neverHasSideEffects = 1;
838 def STACKMAP : Instruction {
839 let OutOperandList = (outs);
840 let InOperandList = (ins i64imm:$id, i32imm:$nbytes, variable_ops);
843 let usesCustomInserter = 1;
845 def PATCHPOINT : Instruction {
846 let OutOperandList = (outs unknown:$dst);
847 let InOperandList = (ins i64imm:$id, i32imm:$nbytes, unknown:$callee,
848 i32imm:$nargs, i32imm:$cc, variable_ops);
851 let usesCustomInserter = 1;
853 def LOAD_STACK_GUARD : Instruction {
854 let OutOperandList = (outs ptr_rc:$dst);
855 let InOperandList = (ins);
857 bit isReMaterializable = 1;
858 let hasSideEffects = 0;
863 //===----------------------------------------------------------------------===//
864 // AsmParser - This class can be implemented by targets that wish to implement
867 // Subtargets can have multiple different assembly parsers (e.g. AT&T vs Intel
868 // syntax on X86 for example).
871 // AsmParserClassName - This specifies the suffix to use for the asmparser
872 // class. Generated AsmParser classes are always prefixed with the target
874 string AsmParserClassName = "AsmParser";
876 // AsmParserInstCleanup - If non-empty, this is the name of a custom member
877 // function of the AsmParser class to call on every matched instruction.
878 // This can be used to perform target specific instruction post-processing.
879 string AsmParserInstCleanup = "";
881 // ShouldEmitMatchRegisterName - Set to false if the target needs a hand
882 // written register name matcher
883 bit ShouldEmitMatchRegisterName = 1;
885 /// Does the instruction mnemonic allow '.'
886 bit MnemonicContainsDot = 0;
888 def DefaultAsmParser : AsmParser;
890 //===----------------------------------------------------------------------===//
891 // AsmParserVariant - Subtargets can have multiple different assembly parsers
892 // (e.g. AT&T vs Intel syntax on X86 for example). This class can be
893 // implemented by targets to describe such variants.
895 class AsmParserVariant {
896 // Variant - AsmParsers can be of multiple different variants. Variants are
897 // used to support targets that need to parser multiple formats for the
898 // assembly language.
901 // Name - The AsmParser variant name (e.g., AT&T vs Intel).
904 // CommentDelimiter - If given, the delimiter string used to recognize
905 // comments which are hard coded in the .td assembler strings for individual
907 string CommentDelimiter = "";
909 // RegisterPrefix - If given, the token prefix which indicates a register
910 // token. This is used by the matcher to automatically recognize hard coded
911 // register tokens as constrained registers, instead of tokens, for the
912 // purposes of matching.
913 string RegisterPrefix = "";
915 def DefaultAsmParserVariant : AsmParserVariant;
917 /// AssemblerPredicate - This is a Predicate that can be used when the assembler
918 /// matches instructions and aliases.
919 class AssemblerPredicate<string cond, string name = ""> {
920 bit AssemblerMatcherPredicate = 1;
921 string AssemblerCondString = cond;
922 string PredicateName = name;
925 /// TokenAlias - This class allows targets to define assembler token
926 /// operand aliases. That is, a token literal operand which is equivalent
927 /// to another, canonical, token literal. For example, ARM allows:
928 /// vmov.u32 s4, #0 -> vmov.i32, #0
929 /// 'u32' is a more specific designator for the 32-bit integer type specifier
930 /// and is legal for any instruction which accepts 'i32' as a datatype suffix.
931 /// def : TokenAlias<".u32", ".i32">;
933 /// This works by marking the match class of 'From' as a subclass of the
934 /// match class of 'To'.
935 class TokenAlias<string From, string To> {
936 string FromToken = From;
940 /// MnemonicAlias - This class allows targets to define assembler mnemonic
941 /// aliases. This should be used when all forms of one mnemonic are accepted
942 /// with a different mnemonic. For example, X86 allows:
943 /// sal %al, 1 -> shl %al, 1
944 /// sal %ax, %cl -> shl %ax, %cl
945 /// sal %eax, %cl -> shl %eax, %cl
946 /// etc. Though "sal" is accepted with many forms, all of them are directly
947 /// translated to a shl, so it can be handled with (in the case of X86, it
948 /// actually has one for each suffix as well):
949 /// def : MnemonicAlias<"sal", "shl">;
951 /// Mnemonic aliases are mapped before any other translation in the match phase,
952 /// and do allow Requires predicates, e.g.:
954 /// def : MnemonicAlias<"pushf", "pushfq">, Requires<[In64BitMode]>;
955 /// def : MnemonicAlias<"pushf", "pushfl">, Requires<[In32BitMode]>;
957 /// Mnemonic aliases can also be constrained to specific variants, e.g.:
959 /// def : MnemonicAlias<"pushf", "pushfq", "att">, Requires<[In64BitMode]>;
961 /// If no variant (e.g., "att" or "intel") is specified then the alias is
962 /// applied unconditionally.
963 class MnemonicAlias<string From, string To, string VariantName = ""> {
964 string FromMnemonic = From;
965 string ToMnemonic = To;
966 string AsmVariantName = VariantName;
968 // Predicates - Predicates that must be true for this remapping to happen.
969 list<Predicate> Predicates = [];
972 /// InstAlias - This defines an alternate assembly syntax that is allowed to
973 /// match an instruction that has a different (more canonical) assembly
975 class InstAlias<string Asm, dag Result, int Emit = 1> {
976 string AsmString = Asm; // The .s format to match the instruction with.
977 dag ResultInst = Result; // The MCInst to generate.
979 // This determines which order the InstPrinter detects aliases for
980 // printing. A larger value makes the alias more likely to be
981 // emitted. The Instruction's own definition is notionally 0.5, so 0
982 // disables printing and 1 enables it if there are no conflicting aliases.
983 int EmitPriority = Emit;
985 // Predicates - Predicates that must be true for this to match.
986 list<Predicate> Predicates = [];
989 //===----------------------------------------------------------------------===//
990 // AsmWriter - This class can be implemented by targets that need to customize
991 // the format of the .s file writer.
993 // Subtargets can have multiple different asmwriters (e.g. AT&T vs Intel syntax
994 // on X86 for example).
997 // AsmWriterClassName - This specifies the suffix to use for the asmwriter
998 // class. Generated AsmWriter classes are always prefixed with the target
1000 string AsmWriterClassName = "InstPrinter";
1002 // Variant - AsmWriters can be of multiple different variants. Variants are
1003 // used to support targets that need to emit assembly code in ways that are
1004 // mostly the same for different targets, but have minor differences in
1005 // syntax. If the asmstring contains {|} characters in them, this integer
1006 // will specify which alternative to use. For example "{x|y|z}" with Variant
1007 // == 1, will expand to "y".
1010 // OperandSpacing - Space between operand columns.
1011 int OperandSpacing = -1;
1013 def DefaultAsmWriter : AsmWriter;
1016 //===----------------------------------------------------------------------===//
1017 // Target - This class contains the "global" target information
1020 // InstructionSet - Instruction set description for this target.
1021 InstrInfo InstructionSet;
1023 // AssemblyParsers - The AsmParser instances available for this target.
1024 list<AsmParser> AssemblyParsers = [DefaultAsmParser];
1026 /// AssemblyParserVariants - The AsmParserVariant instances available for
1028 list<AsmParserVariant> AssemblyParserVariants = [DefaultAsmParserVariant];
1030 // AssemblyWriters - The AsmWriter instances available for this target.
1031 list<AsmWriter> AssemblyWriters = [DefaultAsmWriter];
1034 //===----------------------------------------------------------------------===//
1035 // SubtargetFeature - A characteristic of the chip set.
1037 class SubtargetFeature<string n, string a, string v, string d,
1038 list<SubtargetFeature> i = []> {
1039 // Name - Feature name. Used by command line (-mattr=) to determine the
1040 // appropriate target chip.
1044 // Attribute - Attribute to be set by feature.
1046 string Attribute = a;
1048 // Value - Value the attribute to be set to by feature.
1052 // Desc - Feature description. Used by command line (-mattr=) to display help
1057 // Implies - Features that this feature implies are present. If one of those
1058 // features isn't set, then this one shouldn't be set either.
1060 list<SubtargetFeature> Implies = i;
1063 /// Specifies a Subtarget feature that this instruction is deprecated on.
1064 class Deprecated<SubtargetFeature dep> {
1065 SubtargetFeature DeprecatedFeatureMask = dep;
1068 /// A custom predicate used to determine if an instruction is
1069 /// deprecated or not.
1070 class ComplexDeprecationPredicate<string dep> {
1071 string ComplexDeprecationPredicate = dep;
1074 //===----------------------------------------------------------------------===//
1075 // Processor chip sets - These values represent each of the chip sets supported
1076 // by the scheduler. Each Processor definition requires corresponding
1077 // instruction itineraries.
1079 class Processor<string n, ProcessorItineraries pi, list<SubtargetFeature> f> {
1080 // Name - Chip set name. Used by command line (-mcpu=) to determine the
1081 // appropriate target chip.
1085 // SchedModel - The machine model for scheduling and instruction cost.
1087 SchedMachineModel SchedModel = NoSchedModel;
1089 // ProcItin - The scheduling information for the target processor.
1091 ProcessorItineraries ProcItin = pi;
1093 // Features - list of
1094 list<SubtargetFeature> Features = f;
1097 // ProcessorModel allows subtargets to specify the more general
1098 // SchedMachineModel instead if a ProcessorItinerary. Subtargets will
1099 // gradually move to this newer form.
1101 // Although this class always passes NoItineraries to the Processor
1102 // class, the SchedMachineModel may still define valid Itineraries.
1103 class ProcessorModel<string n, SchedMachineModel m, list<SubtargetFeature> f>
1104 : Processor<n, NoItineraries, f> {
1108 //===----------------------------------------------------------------------===//
1109 // InstrMapping - This class is used to create mapping tables to relate
1110 // instructions with each other based on the values specified in RowFields,
1111 // ColFields, KeyCol and ValueCols.
1113 class InstrMapping {
1114 // FilterClass - Used to limit search space only to the instructions that
1115 // define the relationship modeled by this InstrMapping record.
1118 // RowFields - List of fields/attributes that should be same for all the
1119 // instructions in a row of the relation table. Think of this as a set of
1120 // properties shared by all the instructions related by this relationship
1121 // model and is used to categorize instructions into subgroups. For instance,
1122 // if we want to define a relation that maps 'Add' instruction to its
1123 // predicated forms, we can define RowFields like this:
1125 // let RowFields = BaseOp
1126 // All add instruction predicated/non-predicated will have to set their BaseOp
1127 // to the same value.
1129 // def Add: { let BaseOp = 'ADD'; let predSense = 'nopred' }
1130 // def Add_predtrue: { let BaseOp = 'ADD'; let predSense = 'true' }
1131 // def Add_predfalse: { let BaseOp = 'ADD'; let predSense = 'false' }
1132 list<string> RowFields = [];
1134 // List of fields/attributes that are same for all the instructions
1135 // in a column of the relation table.
1136 // Ex: let ColFields = 'predSense' -- It means that the columns are arranged
1137 // based on the 'predSense' values. All the instruction in a specific
1138 // column have the same value and it is fixed for the column according
1139 // to the values set in 'ValueCols'.
1140 list<string> ColFields = [];
1142 // Values for the fields/attributes listed in 'ColFields'.
1143 // Ex: let KeyCol = 'nopred' -- It means that the key instruction (instruction
1144 // that models this relation) should be non-predicated.
1145 // In the example above, 'Add' is the key instruction.
1146 list<string> KeyCol = [];
1148 // List of values for the fields/attributes listed in 'ColFields', one for
1149 // each column in the relation table.
1151 // Ex: let ValueCols = [['true'],['false']] -- It adds two columns in the
1152 // table. First column requires all the instructions to have predSense
1153 // set to 'true' and second column requires it to be 'false'.
1154 list<list<string> > ValueCols = [];
1157 //===----------------------------------------------------------------------===//
1158 // Pull in the common support for calling conventions.
1160 include "llvm/Target/TargetCallingConv.td"
1162 //===----------------------------------------------------------------------===//
1163 // Pull in the common support for DAG isel generation.
1165 include "llvm/Target/TargetSelectionDAG.td"