1 //===- llvm/CodeGen/TargetInstrInfo.h - Instruction Info --------*- C++ -*-===//
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 describes the target machine instruction set to the code generator.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_TARGET_TARGETINSTRINFO_H
15 #define LLVM_TARGET_TARGETINSTRINFO_H
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/DenseMapInfo.h"
20 #include "llvm/ADT/None.h"
21 #include "llvm/CodeGen/MachineBasicBlock.h"
22 #include "llvm/CodeGen/MachineCombinerPattern.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineInstr.h"
25 #include "llvm/CodeGen/MachineLoopInfo.h"
26 #include "llvm/CodeGen/MachineOperand.h"
27 #include "llvm/CodeGen/PseudoSourceValue.h"
28 #include "llvm/MC/MCInstrInfo.h"
29 #include "llvm/Support/BranchProbability.h"
30 #include "llvm/Support/ErrorHandling.h"
40 class InstrItineraryData;
43 class MachineMemOperand;
44 class MachineRegisterInfo;
50 class ScheduleHazardRecognizer;
54 class TargetRegisterClass;
55 class TargetRegisterInfo;
56 class TargetSchedModel;
57 class TargetSubtargetInfo;
59 template <class T> class SmallVectorImpl;
61 //---------------------------------------------------------------------------
63 /// TargetInstrInfo - Interface to description of machine instruction set
65 class TargetInstrInfo : public MCInstrInfo {
67 TargetInstrInfo(unsigned CFSetupOpcode = ~0u, unsigned CFDestroyOpcode = ~0u,
68 unsigned CatchRetOpcode = ~0u, unsigned ReturnOpcode = ~0u)
69 : CallFrameSetupOpcode(CFSetupOpcode),
70 CallFrameDestroyOpcode(CFDestroyOpcode), CatchRetOpcode(CatchRetOpcode),
71 ReturnOpcode(ReturnOpcode) {}
72 TargetInstrInfo(const TargetInstrInfo &) = delete;
73 TargetInstrInfo &operator=(const TargetInstrInfo &) = delete;
74 virtual ~TargetInstrInfo();
76 static bool isGenericOpcode(unsigned Opc) {
77 return Opc <= TargetOpcode::GENERIC_OP_END;
80 /// Given a machine instruction descriptor, returns the register
81 /// class constraint for OpNum, or NULL.
82 const TargetRegisterClass *getRegClass(const MCInstrDesc &TID, unsigned OpNum,
83 const TargetRegisterInfo *TRI,
84 const MachineFunction &MF) const;
86 /// Return true if the instruction is trivially rematerializable, meaning it
87 /// has no side effects and requires no operands that aren't always available.
88 /// This means the only allowed uses are constants and unallocatable physical
89 /// registers so that the instructions result is independent of the place
91 bool isTriviallyReMaterializable(const MachineInstr &MI,
92 AliasAnalysis *AA = nullptr) const {
93 return MI.getOpcode() == TargetOpcode::IMPLICIT_DEF ||
94 (MI.getDesc().isRematerializable() &&
95 (isReallyTriviallyReMaterializable(MI, AA) ||
96 isReallyTriviallyReMaterializableGeneric(MI, AA)));
100 /// For instructions with opcodes for which the M_REMATERIALIZABLE flag is
101 /// set, this hook lets the target specify whether the instruction is actually
102 /// trivially rematerializable, taking into consideration its operands. This
103 /// predicate must return false if the instruction has any side effects other
104 /// than producing a value, or if it requres any address registers that are
105 /// not always available.
106 /// Requirements must be check as stated in isTriviallyReMaterializable() .
107 virtual bool isReallyTriviallyReMaterializable(const MachineInstr &MI,
108 AliasAnalysis *AA) const {
112 /// This method commutes the operands of the given machine instruction MI.
113 /// The operands to be commuted are specified by their indices OpIdx1 and
116 /// If a target has any instructions that are commutable but require
117 /// converting to different instructions or making non-trivial changes
118 /// to commute them, this method can be overloaded to do that.
119 /// The default implementation simply swaps the commutable operands.
121 /// If NewMI is false, MI is modified in place and returned; otherwise, a
122 /// new machine instruction is created and returned.
124 /// Do not call this method for a non-commutable instruction.
125 /// Even though the instruction is commutable, the method may still
126 /// fail to commute the operands, null pointer is returned in such cases.
127 virtual MachineInstr *commuteInstructionImpl(MachineInstr &MI, bool NewMI,
129 unsigned OpIdx2) const;
131 /// Assigns the (CommutableOpIdx1, CommutableOpIdx2) pair of commutable
132 /// operand indices to (ResultIdx1, ResultIdx2).
133 /// One or both input values of the pair: (ResultIdx1, ResultIdx2) may be
134 /// predefined to some indices or be undefined (designated by the special
135 /// value 'CommuteAnyOperandIndex').
136 /// The predefined result indices cannot be re-defined.
137 /// The function returns true iff after the result pair redefinition
138 /// the fixed result pair is equal to or equivalent to the source pair of
139 /// indices: (CommutableOpIdx1, CommutableOpIdx2). It is assumed here that
140 /// the pairs (x,y) and (y,x) are equivalent.
141 static bool fixCommutedOpIndices(unsigned &ResultIdx1, unsigned &ResultIdx2,
142 unsigned CommutableOpIdx1,
143 unsigned CommutableOpIdx2);
146 /// For instructions with opcodes for which the M_REMATERIALIZABLE flag is
147 /// set and the target hook isReallyTriviallyReMaterializable returns false,
148 /// this function does target-independent tests to determine if the
149 /// instruction is really trivially rematerializable.
150 bool isReallyTriviallyReMaterializableGeneric(const MachineInstr &MI,
151 AliasAnalysis *AA) const;
154 /// These methods return the opcode of the frame setup/destroy instructions
155 /// if they exist (-1 otherwise). Some targets use pseudo instructions in
156 /// order to abstract away the difference between operating with a frame
157 /// pointer and operating without, through the use of these two instructions.
159 unsigned getCallFrameSetupOpcode() const { return CallFrameSetupOpcode; }
160 unsigned getCallFrameDestroyOpcode() const { return CallFrameDestroyOpcode; }
162 /// Returns true if the argument is a frame pseudo instruction.
163 bool isFrameInstr(const MachineInstr &I) const {
164 return I.getOpcode() == getCallFrameSetupOpcode() ||
165 I.getOpcode() == getCallFrameDestroyOpcode();
168 /// Returns true if the argument is a frame setup pseudo instruction.
169 bool isFrameSetup(const MachineInstr &I) const {
170 return I.getOpcode() == getCallFrameSetupOpcode();
173 /// Returns size of the frame associated with the given frame instruction.
174 /// For frame setup instruction this is frame that is set up space set up
175 /// after the instruction. For frame destroy instruction this is the frame
176 /// freed by the caller.
177 /// Note, in some cases a call frame (or a part of it) may be prepared prior
178 /// to the frame setup instruction. It occurs in the calls that involve
179 /// inalloca arguments. This function reports only the size of the frame part
180 /// that is set up between the frame setup and destroy pseudo instructions.
181 int64_t getFrameSize(const MachineInstr &I) const {
182 assert(isFrameInstr(I) && "Not a frame instruction");
183 assert(I.getOperand(0).getImm() >= 0);
184 return I.getOperand(0).getImm();
187 /// Returns the total frame size, which is made up of the space set up inside
188 /// the pair of frame start-stop instructions and the space that is set up
189 /// prior to the pair.
190 int64_t getFrameTotalSize(const MachineInstr &I) const {
191 if (isFrameSetup(I)) {
192 assert(I.getOperand(1).getImm() >= 0 &&
193 "Frame size must not be negative");
194 return getFrameSize(I) + I.getOperand(1).getImm();
196 return getFrameSize(I);
199 unsigned getCatchReturnOpcode() const { return CatchRetOpcode; }
200 unsigned getReturnOpcode() const { return ReturnOpcode; }
202 /// Returns the actual stack pointer adjustment made by an instruction
203 /// as part of a call sequence. By default, only call frame setup/destroy
204 /// instructions adjust the stack, but targets may want to override this
205 /// to enable more fine-grained adjustment, or adjust by a different value.
206 virtual int getSPAdjust(const MachineInstr &MI) const;
208 /// Return true if the instruction is a "coalescable" extension instruction.
209 /// That is, it's like a copy where it's legal for the source to overlap the
210 /// destination. e.g. X86::MOVSX64rr32. If this returns true, then it's
211 /// expected the pre-extension value is available as a subreg of the result
212 /// register. This also returns the sub-register index in SubIdx.
213 virtual bool isCoalescableExtInstr(const MachineInstr &MI, unsigned &SrcReg,
214 unsigned &DstReg, unsigned &SubIdx) const {
218 /// If the specified machine instruction is a direct
219 /// load from a stack slot, return the virtual or physical register number of
220 /// the destination along with the FrameIndex of the loaded stack slot. If
221 /// not, return 0. This predicate must return 0 if the instruction has
222 /// any side effects other than loading from the stack slot.
223 virtual unsigned isLoadFromStackSlot(const MachineInstr &MI,
224 int &FrameIndex) const {
228 /// Check for post-frame ptr elimination stack locations as well.
229 /// This uses a heuristic so it isn't reliable for correctness.
230 virtual unsigned isLoadFromStackSlotPostFE(const MachineInstr &MI,
231 int &FrameIndex) const {
235 /// If the specified machine instruction has a load from a stack slot,
236 /// return true along with the FrameIndex of the loaded stack slot and the
237 /// machine mem operand containing the reference.
238 /// If not, return false. Unlike isLoadFromStackSlot, this returns true for
239 /// any instructions that loads from the stack. This is just a hint, as some
240 /// cases may be missed.
241 virtual bool hasLoadFromStackSlot(const MachineInstr &MI,
242 const MachineMemOperand *&MMO,
243 int &FrameIndex) const;
245 /// If the specified machine instruction is a direct
246 /// store to a stack slot, return the virtual or physical register number of
247 /// the source reg along with the FrameIndex of the loaded stack slot. If
248 /// not, return 0. This predicate must return 0 if the instruction has
249 /// any side effects other than storing to the stack slot.
250 virtual unsigned isStoreToStackSlot(const MachineInstr &MI,
251 int &FrameIndex) const {
255 /// Check for post-frame ptr elimination stack locations as well.
256 /// This uses a heuristic, so it isn't reliable for correctness.
257 virtual unsigned isStoreToStackSlotPostFE(const MachineInstr &MI,
258 int &FrameIndex) const {
262 /// If the specified machine instruction has a store to a stack slot,
263 /// return true along with the FrameIndex of the loaded stack slot and the
264 /// machine mem operand containing the reference.
265 /// If not, return false. Unlike isStoreToStackSlot,
266 /// this returns true for any instructions that stores to the
267 /// stack. This is just a hint, as some cases may be missed.
268 virtual bool hasStoreToStackSlot(const MachineInstr &MI,
269 const MachineMemOperand *&MMO,
270 int &FrameIndex) const;
272 /// Return true if the specified machine instruction
273 /// is a copy of one stack slot to another and has no other effect.
274 /// Provide the identity of the two frame indices.
275 virtual bool isStackSlotCopy(const MachineInstr &MI, int &DestFrameIndex,
276 int &SrcFrameIndex) const {
280 /// Compute the size in bytes and offset within a stack slot of a spilled
281 /// register or subregister.
283 /// \param [out] Size in bytes of the spilled value.
284 /// \param [out] Offset in bytes within the stack slot.
285 /// \returns true if both Size and Offset are successfully computed.
287 /// Not all subregisters have computable spill slots. For example,
288 /// subregisters registers may not be byte-sized, and a pair of discontiguous
289 /// subregisters has no single offset.
291 /// Targets with nontrivial bigendian implementations may need to override
292 /// this, particularly to support spilled vector registers.
293 virtual bool getStackSlotRange(const TargetRegisterClass *RC, unsigned SubIdx,
294 unsigned &Size, unsigned &Offset,
295 const MachineFunction &MF) const;
297 /// Returns the size in bytes of the specified MachineInstr, or ~0U
298 /// when this function is not implemented by a target.
299 virtual unsigned getInstSizeInBytes(const MachineInstr &MI) const {
303 /// Return true if the instruction is as cheap as a move instruction.
305 /// Targets for different archs need to override this, and different
306 /// micro-architectures can also be finely tuned inside.
307 virtual bool isAsCheapAsAMove(const MachineInstr &MI) const {
308 return MI.isAsCheapAsAMove();
311 /// Return true if the instruction should be sunk by MachineSink.
313 /// MachineSink determines on its own whether the instruction is safe to sink;
314 /// this gives the target a hook to override the default behavior with regards
315 /// to which instructions should be sunk.
316 virtual bool shouldSink(const MachineInstr &MI) const { return true; }
318 /// Re-issue the specified 'original' instruction at the
319 /// specific location targeting a new destination register.
320 /// The register in Orig->getOperand(0).getReg() will be substituted by
321 /// DestReg:SubIdx. Any existing subreg index is preserved or composed with
323 virtual void reMaterialize(MachineBasicBlock &MBB,
324 MachineBasicBlock::iterator MI, unsigned DestReg,
325 unsigned SubIdx, const MachineInstr &Orig,
326 const TargetRegisterInfo &TRI) const;
328 /// \brief Clones instruction or the whole instruction bundle \p Orig and
329 /// insert into \p MBB before \p InsertBefore. The target may update operands
330 /// that are required to be unique.
332 /// \p Orig must not return true for MachineInstr::isNotDuplicable().
333 virtual MachineInstr &duplicate(MachineBasicBlock &MBB,
334 MachineBasicBlock::iterator InsertBefore,
335 const MachineInstr &Orig) const;
337 /// This method must be implemented by targets that
338 /// set the M_CONVERTIBLE_TO_3_ADDR flag. When this flag is set, the target
339 /// may be able to convert a two-address instruction into one or more true
340 /// three-address instructions on demand. This allows the X86 target (for
341 /// example) to convert ADD and SHL instructions into LEA instructions if they
342 /// would require register copies due to two-addressness.
344 /// This method returns a null pointer if the transformation cannot be
345 /// performed, otherwise it returns the last new instruction.
347 virtual MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
349 LiveVariables *LV) const {
353 // This constant can be used as an input value of operand index passed to
354 // the method findCommutedOpIndices() to tell the method that the
355 // corresponding operand index is not pre-defined and that the method
356 // can pick any commutable operand.
357 static const unsigned CommuteAnyOperandIndex = ~0U;
359 /// This method commutes the operands of the given machine instruction MI.
361 /// The operands to be commuted are specified by their indices OpIdx1 and
362 /// OpIdx2. OpIdx1 and OpIdx2 arguments may be set to a special value
363 /// 'CommuteAnyOperandIndex', which means that the method is free to choose
364 /// any arbitrarily chosen commutable operand. If both arguments are set to
365 /// 'CommuteAnyOperandIndex' then the method looks for 2 different commutable
366 /// operands; then commutes them if such operands could be found.
368 /// If NewMI is false, MI is modified in place and returned; otherwise, a
369 /// new machine instruction is created and returned.
371 /// Do not call this method for a non-commutable instruction or
372 /// for non-commuable operands.
373 /// Even though the instruction is commutable, the method may still
374 /// fail to commute the operands, null pointer is returned in such cases.
376 commuteInstruction(MachineInstr &MI, bool NewMI = false,
377 unsigned OpIdx1 = CommuteAnyOperandIndex,
378 unsigned OpIdx2 = CommuteAnyOperandIndex) const;
380 /// Returns true iff the routine could find two commutable operands in the
381 /// given machine instruction.
382 /// The 'SrcOpIdx1' and 'SrcOpIdx2' are INPUT and OUTPUT arguments.
383 /// If any of the INPUT values is set to the special value
384 /// 'CommuteAnyOperandIndex' then the method arbitrarily picks a commutable
385 /// operand, then returns its index in the corresponding argument.
386 /// If both of INPUT values are set to 'CommuteAnyOperandIndex' then method
387 /// looks for 2 commutable operands.
388 /// If INPUT values refer to some operands of MI, then the method simply
389 /// returns true if the corresponding operands are commutable and returns
392 /// For example, calling this method this way:
393 /// unsigned Op1 = 1, Op2 = CommuteAnyOperandIndex;
394 /// findCommutedOpIndices(MI, Op1, Op2);
395 /// can be interpreted as a query asking to find an operand that would be
396 /// commutable with the operand#1.
397 virtual bool findCommutedOpIndices(MachineInstr &MI, unsigned &SrcOpIdx1,
398 unsigned &SrcOpIdx2) const;
400 /// A pair composed of a register and a sub-register index.
401 /// Used to give some type checking when modeling Reg:SubReg.
402 struct RegSubRegPair {
406 RegSubRegPair(unsigned Reg = 0, unsigned SubReg = 0)
407 : Reg(Reg), SubReg(SubReg) {}
410 /// A pair composed of a pair of a register and a sub-register index,
411 /// and another sub-register index.
412 /// Used to give some type checking when modeling Reg:SubReg1, SubReg2.
413 struct RegSubRegPairAndIdx : RegSubRegPair {
416 RegSubRegPairAndIdx(unsigned Reg = 0, unsigned SubReg = 0,
418 : RegSubRegPair(Reg, SubReg), SubIdx(SubIdx) {}
421 /// Build the equivalent inputs of a REG_SEQUENCE for the given \p MI
423 /// \p [out] InputRegs of the equivalent REG_SEQUENCE. Each element of
424 /// the list is modeled as <Reg:SubReg, SubIdx>. Operands with the undef
425 /// flag are not added to this list.
426 /// E.g., REG_SEQUENCE %1:sub1, sub0, %2, sub1 would produce
431 /// \returns true if it is possible to build such an input sequence
432 /// with the pair \p MI, \p DefIdx. False otherwise.
434 /// \pre MI.isRegSequence() or MI.isRegSequenceLike().
436 /// \note The generic implementation does not provide any support for
437 /// MI.isRegSequenceLike(). In other words, one has to override
438 /// getRegSequenceLikeInputs for target specific instructions.
440 getRegSequenceInputs(const MachineInstr &MI, unsigned DefIdx,
441 SmallVectorImpl<RegSubRegPairAndIdx> &InputRegs) const;
443 /// Build the equivalent inputs of a EXTRACT_SUBREG for the given \p MI
445 /// \p [out] InputReg of the equivalent EXTRACT_SUBREG.
446 /// E.g., EXTRACT_SUBREG %1:sub1, sub0, sub1 would produce:
449 /// \returns true if it is possible to build such an input sequence
450 /// with the pair \p MI, \p DefIdx and the operand has no undef flag set.
453 /// \pre MI.isExtractSubreg() or MI.isExtractSubregLike().
455 /// \note The generic implementation does not provide any support for
456 /// MI.isExtractSubregLike(). In other words, one has to override
457 /// getExtractSubregLikeInputs for target specific instructions.
458 bool getExtractSubregInputs(const MachineInstr &MI, unsigned DefIdx,
459 RegSubRegPairAndIdx &InputReg) const;
461 /// Build the equivalent inputs of a INSERT_SUBREG for the given \p MI
463 /// \p [out] BaseReg and \p [out] InsertedReg contain
464 /// the equivalent inputs of INSERT_SUBREG.
465 /// E.g., INSERT_SUBREG %0:sub0, %1:sub1, sub3 would produce:
466 /// - BaseReg: %0:sub0
467 /// - InsertedReg: %1:sub1, sub3
469 /// \returns true if it is possible to build such an input sequence
470 /// with the pair \p MI, \p DefIdx and the operand has no undef flag set.
473 /// \pre MI.isInsertSubreg() or MI.isInsertSubregLike().
475 /// \note The generic implementation does not provide any support for
476 /// MI.isInsertSubregLike(). In other words, one has to override
477 /// getInsertSubregLikeInputs for target specific instructions.
478 bool getInsertSubregInputs(const MachineInstr &MI, unsigned DefIdx,
479 RegSubRegPair &BaseReg,
480 RegSubRegPairAndIdx &InsertedReg) const;
482 /// Return true if two machine instructions would produce identical values.
483 /// By default, this is only true when the two instructions
484 /// are deemed identical except for defs. If this function is called when the
485 /// IR is still in SSA form, the caller can pass the MachineRegisterInfo for
486 /// aggressive checks.
487 virtual bool produceSameValue(const MachineInstr &MI0,
488 const MachineInstr &MI1,
489 const MachineRegisterInfo *MRI = nullptr) const;
491 /// \returns true if a branch from an instruction with opcode \p BranchOpc
492 /// bytes is capable of jumping to a position \p BrOffset bytes away.
493 virtual bool isBranchOffsetInRange(unsigned BranchOpc,
494 int64_t BrOffset) const {
495 llvm_unreachable("target did not implement");
498 /// \returns The block that branch instruction \p MI jumps to.
499 virtual MachineBasicBlock *getBranchDestBlock(const MachineInstr &MI) const {
500 llvm_unreachable("target did not implement");
503 /// Insert an unconditional indirect branch at the end of \p MBB to \p
504 /// NewDestBB. \p BrOffset indicates the offset of \p NewDestBB relative to
505 /// the offset of the position to insert the new branch.
507 /// \returns The number of bytes added to the block.
508 virtual unsigned insertIndirectBranch(MachineBasicBlock &MBB,
509 MachineBasicBlock &NewDestBB,
511 int64_t BrOffset = 0,
512 RegScavenger *RS = nullptr) const {
513 llvm_unreachable("target did not implement");
516 /// Analyze the branching code at the end of MBB, returning
517 /// true if it cannot be understood (e.g. it's a switch dispatch or isn't
518 /// implemented for a target). Upon success, this returns false and returns
519 /// with the following information in various cases:
521 /// 1. If this block ends with no branches (it just falls through to its succ)
522 /// just return false, leaving TBB/FBB null.
523 /// 2. If this block ends with only an unconditional branch, it sets TBB to be
524 /// the destination block.
525 /// 3. If this block ends with a conditional branch and it falls through to a
526 /// successor block, it sets TBB to be the branch destination block and a
527 /// list of operands that evaluate the condition. These operands can be
528 /// passed to other TargetInstrInfo methods to create new branches.
529 /// 4. If this block ends with a conditional branch followed by an
530 /// unconditional branch, it returns the 'true' destination in TBB, the
531 /// 'false' destination in FBB, and a list of operands that evaluate the
532 /// condition. These operands can be passed to other TargetInstrInfo
533 /// methods to create new branches.
535 /// Note that removeBranch and insertBranch must be implemented to support
536 /// cases where this method returns success.
538 /// If AllowModify is true, then this routine is allowed to modify the basic
539 /// block (e.g. delete instructions after the unconditional branch).
541 /// The CFG information in MBB.Predecessors and MBB.Successors must be valid
542 /// before calling this function.
543 virtual bool analyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
544 MachineBasicBlock *&FBB,
545 SmallVectorImpl<MachineOperand> &Cond,
546 bool AllowModify = false) const {
550 /// Represents a predicate at the MachineFunction level. The control flow a
551 /// MachineBranchPredicate represents is:
553 /// Reg = LHS `Predicate` RHS == ConditionDef
554 /// if Reg then goto TrueDest else goto FalseDest
556 struct MachineBranchPredicate {
557 enum ComparePredicate {
558 PRED_EQ, // True if two values are equal
559 PRED_NE, // True if two values are not equal
560 PRED_INVALID // Sentinel value
563 ComparePredicate Predicate = PRED_INVALID;
564 MachineOperand LHS = MachineOperand::CreateImm(0);
565 MachineOperand RHS = MachineOperand::CreateImm(0);
566 MachineBasicBlock *TrueDest = nullptr;
567 MachineBasicBlock *FalseDest = nullptr;
568 MachineInstr *ConditionDef = nullptr;
570 /// SingleUseCondition is true if ConditionDef is dead except for the
571 /// branch(es) at the end of the basic block.
573 bool SingleUseCondition = false;
575 explicit MachineBranchPredicate() = default;
578 /// Analyze the branching code at the end of MBB and parse it into the
579 /// MachineBranchPredicate structure if possible. Returns false on success
580 /// and true on failure.
582 /// If AllowModify is true, then this routine is allowed to modify the basic
583 /// block (e.g. delete instructions after the unconditional branch).
585 virtual bool analyzeBranchPredicate(MachineBasicBlock &MBB,
586 MachineBranchPredicate &MBP,
587 bool AllowModify = false) const {
591 /// Remove the branching code at the end of the specific MBB.
592 /// This is only invoked in cases where AnalyzeBranch returns success. It
593 /// returns the number of instructions that were removed.
594 /// If \p BytesRemoved is non-null, report the change in code size from the
595 /// removed instructions.
596 virtual unsigned removeBranch(MachineBasicBlock &MBB,
597 int *BytesRemoved = nullptr) const {
598 llvm_unreachable("Target didn't implement TargetInstrInfo::removeBranch!");
601 /// Insert branch code into the end of the specified MachineBasicBlock. The
602 /// operands to this method are the same as those returned by AnalyzeBranch.
603 /// This is only invoked in cases where AnalyzeBranch returns success. It
604 /// returns the number of instructions inserted. If \p BytesAdded is non-null,
605 /// report the change in code size from the added instructions.
607 /// It is also invoked by tail merging to add unconditional branches in
608 /// cases where AnalyzeBranch doesn't apply because there was no original
609 /// branch to analyze. At least this much must be implemented, else tail
610 /// merging needs to be disabled.
612 /// The CFG information in MBB.Predecessors and MBB.Successors must be valid
613 /// before calling this function.
614 virtual unsigned insertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
615 MachineBasicBlock *FBB,
616 ArrayRef<MachineOperand> Cond,
618 int *BytesAdded = nullptr) const {
619 llvm_unreachable("Target didn't implement TargetInstrInfo::insertBranch!");
622 unsigned insertUnconditionalBranch(MachineBasicBlock &MBB,
623 MachineBasicBlock *DestBB,
625 int *BytesAdded = nullptr) const {
626 return insertBranch(MBB, DestBB, nullptr, ArrayRef<MachineOperand>(), DL,
630 /// Analyze the loop code, return true if it cannot be understoo. Upon
631 /// success, this function returns false and returns information about the
632 /// induction variable and compare instruction used at the end.
633 virtual bool analyzeLoop(MachineLoop &L, MachineInstr *&IndVarInst,
634 MachineInstr *&CmpInst) const {
638 /// Generate code to reduce the loop iteration by one and check if the loop is
639 /// finished. Return the value/register of the the new loop count. We need
640 /// this function when peeling off one or more iterations of a loop. This
641 /// function assumes the nth iteration is peeled first.
642 virtual unsigned reduceLoopCount(MachineBasicBlock &MBB, MachineInstr *IndVar,
644 SmallVectorImpl<MachineOperand> &Cond,
645 SmallVectorImpl<MachineInstr *> &PrevInsts,
646 unsigned Iter, unsigned MaxIter) const {
647 llvm_unreachable("Target didn't implement ReduceLoopCount");
650 /// Delete the instruction OldInst and everything after it, replacing it with
651 /// an unconditional branch to NewDest. This is used by the tail merging pass.
652 virtual void ReplaceTailWithBranchTo(MachineBasicBlock::iterator Tail,
653 MachineBasicBlock *NewDest) const;
655 /// Return true if it's legal to split the given basic
656 /// block at the specified instruction (i.e. instruction would be the start
657 /// of a new basic block).
658 virtual bool isLegalToSplitMBBAt(MachineBasicBlock &MBB,
659 MachineBasicBlock::iterator MBBI) const {
663 /// Return true if it's profitable to predicate
664 /// instructions with accumulated instruction latency of "NumCycles"
665 /// of the specified basic block, where the probability of the instructions
666 /// being executed is given by Probability, and Confidence is a measure
667 /// of our confidence that it will be properly predicted.
668 virtual bool isProfitableToIfCvt(MachineBasicBlock &MBB, unsigned NumCycles,
669 unsigned ExtraPredCycles,
670 BranchProbability Probability) const {
674 /// Second variant of isProfitableToIfCvt. This one
675 /// checks for the case where two basic blocks from true and false path
676 /// of a if-then-else (diamond) are predicated on mutally exclusive
677 /// predicates, where the probability of the true path being taken is given
678 /// by Probability, and Confidence is a measure of our confidence that it
679 /// will be properly predicted.
680 virtual bool isProfitableToIfCvt(MachineBasicBlock &TMBB, unsigned NumTCycles,
681 unsigned ExtraTCycles,
682 MachineBasicBlock &FMBB, unsigned NumFCycles,
683 unsigned ExtraFCycles,
684 BranchProbability Probability) const {
688 /// Return true if it's profitable for if-converter to duplicate instructions
689 /// of specified accumulated instruction latencies in the specified MBB to
690 /// enable if-conversion.
691 /// The probability of the instructions being executed is given by
692 /// Probability, and Confidence is a measure of our confidence that it
693 /// will be properly predicted.
694 virtual bool isProfitableToDupForIfCvt(MachineBasicBlock &MBB,
696 BranchProbability Probability) const {
700 /// Return true if it's profitable to unpredicate
701 /// one side of a 'diamond', i.e. two sides of if-else predicated on mutually
702 /// exclusive predicates.
710 /// This may be profitable is conditional instructions are always executed.
711 virtual bool isProfitableToUnpredicate(MachineBasicBlock &TMBB,
712 MachineBasicBlock &FMBB) const {
716 /// Return true if it is possible to insert a select
717 /// instruction that chooses between TrueReg and FalseReg based on the
718 /// condition code in Cond.
720 /// When successful, also return the latency in cycles from TrueReg,
721 /// FalseReg, and Cond to the destination register. In most cases, a select
722 /// instruction will be 1 cycle, so CondCycles = TrueCycles = FalseCycles = 1
724 /// Some x86 implementations have 2-cycle cmov instructions.
726 /// @param MBB Block where select instruction would be inserted.
727 /// @param Cond Condition returned by AnalyzeBranch.
728 /// @param TrueReg Virtual register to select when Cond is true.
729 /// @param FalseReg Virtual register to select when Cond is false.
730 /// @param CondCycles Latency from Cond+Branch to select output.
731 /// @param TrueCycles Latency from TrueReg to select output.
732 /// @param FalseCycles Latency from FalseReg to select output.
733 virtual bool canInsertSelect(const MachineBasicBlock &MBB,
734 ArrayRef<MachineOperand> Cond, unsigned TrueReg,
735 unsigned FalseReg, int &CondCycles,
736 int &TrueCycles, int &FalseCycles) const {
740 /// Insert a select instruction into MBB before I that will copy TrueReg to
741 /// DstReg when Cond is true, and FalseReg to DstReg when Cond is false.
743 /// This function can only be called after canInsertSelect() returned true.
744 /// The condition in Cond comes from AnalyzeBranch, and it can be assumed
745 /// that the same flags or registers required by Cond are available at the
748 /// @param MBB Block where select instruction should be inserted.
749 /// @param I Insertion point.
750 /// @param DL Source location for debugging.
751 /// @param DstReg Virtual register to be defined by select instruction.
752 /// @param Cond Condition as computed by AnalyzeBranch.
753 /// @param TrueReg Virtual register to copy when Cond is true.
754 /// @param FalseReg Virtual register to copy when Cons is false.
755 virtual void insertSelect(MachineBasicBlock &MBB,
756 MachineBasicBlock::iterator I, const DebugLoc &DL,
757 unsigned DstReg, ArrayRef<MachineOperand> Cond,
758 unsigned TrueReg, unsigned FalseReg) const {
759 llvm_unreachable("Target didn't implement TargetInstrInfo::insertSelect!");
762 /// Analyze the given select instruction, returning true if
763 /// it cannot be understood. It is assumed that MI->isSelect() is true.
765 /// When successful, return the controlling condition and the operands that
766 /// determine the true and false result values.
768 /// Result = SELECT Cond, TrueOp, FalseOp
770 /// Some targets can optimize select instructions, for example by predicating
771 /// the instruction defining one of the operands. Such targets should set
774 /// @param MI Select instruction to analyze.
775 /// @param Cond Condition controlling the select.
776 /// @param TrueOp Operand number of the value selected when Cond is true.
777 /// @param FalseOp Operand number of the value selected when Cond is false.
778 /// @param Optimizable Returned as true if MI is optimizable.
779 /// @returns False on success.
780 virtual bool analyzeSelect(const MachineInstr &MI,
781 SmallVectorImpl<MachineOperand> &Cond,
782 unsigned &TrueOp, unsigned &FalseOp,
783 bool &Optimizable) const {
784 assert(MI.getDesc().isSelect() && "MI must be a select instruction");
788 /// Given a select instruction that was understood by
789 /// analyzeSelect and returned Optimizable = true, attempt to optimize MI by
790 /// merging it with one of its operands. Returns NULL on failure.
792 /// When successful, returns the new select instruction. The client is
793 /// responsible for deleting MI.
795 /// If both sides of the select can be optimized, PreferFalse is used to pick
798 /// @param MI Optimizable select instruction.
799 /// @param NewMIs Set that record all MIs in the basic block up to \p
800 /// MI. Has to be updated with any newly created MI or deleted ones.
801 /// @param PreferFalse Try to optimize FalseOp instead of TrueOp.
802 /// @returns Optimized instruction or NULL.
803 virtual MachineInstr *optimizeSelect(MachineInstr &MI,
804 SmallPtrSetImpl<MachineInstr *> &NewMIs,
805 bool PreferFalse = false) const {
806 // This function must be implemented if Optimizable is ever set.
807 llvm_unreachable("Target must implement TargetInstrInfo::optimizeSelect!");
810 /// Emit instructions to copy a pair of physical registers.
812 /// This function should support copies within any legal register class as
813 /// well as any cross-class copies created during instruction selection.
815 /// The source and destination registers may overlap, which may require a
816 /// careful implementation when multiple copy instructions are required for
817 /// large registers. See for example the ARM target.
818 virtual void copyPhysReg(MachineBasicBlock &MBB,
819 MachineBasicBlock::iterator MI, const DebugLoc &DL,
820 unsigned DestReg, unsigned SrcReg,
821 bool KillSrc) const {
822 llvm_unreachable("Target didn't implement TargetInstrInfo::copyPhysReg!");
825 /// Store the specified register of the given register class to the specified
826 /// stack frame index. The store instruction is to be added to the given
827 /// machine basic block before the specified machine instruction. If isKill
828 /// is true, the register operand is the last use and must be marked kill.
829 virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
830 MachineBasicBlock::iterator MI,
831 unsigned SrcReg, bool isKill, int FrameIndex,
832 const TargetRegisterClass *RC,
833 const TargetRegisterInfo *TRI) const {
834 llvm_unreachable("Target didn't implement "
835 "TargetInstrInfo::storeRegToStackSlot!");
838 /// Load the specified register of the given register class from the specified
839 /// stack frame index. The load instruction is to be added to the given
840 /// machine basic block before the specified machine instruction.
841 virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
842 MachineBasicBlock::iterator MI,
843 unsigned DestReg, int FrameIndex,
844 const TargetRegisterClass *RC,
845 const TargetRegisterInfo *TRI) const {
846 llvm_unreachable("Target didn't implement "
847 "TargetInstrInfo::loadRegFromStackSlot!");
850 /// This function is called for all pseudo instructions
851 /// that remain after register allocation. Many pseudo instructions are
852 /// created to help register allocation. This is the place to convert them
853 /// into real instructions. The target can edit MI in place, or it can insert
854 /// new instructions and erase MI. The function should return true if
855 /// anything was changed.
856 virtual bool expandPostRAPseudo(MachineInstr &MI) const { return false; }
858 /// Check whether the target can fold a load that feeds a subreg operand
859 /// (or a subreg operand that feeds a store).
860 /// For example, X86 may want to return true if it can fold
861 /// movl (%esp), %eax
866 /// Ideally, we'd like the target implementation of foldMemoryOperand() to
867 /// reject subregs - but since this behavior used to be enforced in the
868 /// target-independent code, moving this responsibility to the targets
869 /// has the potential of causing nasty silent breakage in out-of-tree targets.
870 virtual bool isSubregFoldable() const { return false; }
872 /// Attempt to fold a load or store of the specified stack
873 /// slot into the specified machine instruction for the specified operand(s).
874 /// If this is possible, a new instruction is returned with the specified
875 /// operand folded, otherwise NULL is returned.
876 /// The new instruction is inserted before MI, and the client is responsible
877 /// for removing the old instruction.
878 MachineInstr *foldMemoryOperand(MachineInstr &MI, ArrayRef<unsigned> Ops,
880 LiveIntervals *LIS = nullptr) const;
882 /// Same as the previous version except it allows folding of any load and
883 /// store from / to any address, not just from a specific stack slot.
884 MachineInstr *foldMemoryOperand(MachineInstr &MI, ArrayRef<unsigned> Ops,
885 MachineInstr &LoadMI,
886 LiveIntervals *LIS = nullptr) const;
888 /// Return true when there is potentially a faster code sequence
889 /// for an instruction chain ending in \p Root. All potential patterns are
890 /// returned in the \p Pattern vector. Pattern should be sorted in priority
891 /// order since the pattern evaluator stops checking as soon as it finds a
893 /// \param Root - Instruction that could be combined with one of its operands
894 /// \param Patterns - Vector of possible combination patterns
895 virtual bool getMachineCombinerPatterns(
897 SmallVectorImpl<MachineCombinerPattern> &Patterns) const;
899 /// Return true when a code sequence can improve throughput. It
900 /// should be called only for instructions in loops.
901 /// \param Pattern - combiner pattern
902 virtual bool isThroughputPattern(MachineCombinerPattern Pattern) const;
904 /// Return true if the input \P Inst is part of a chain of dependent ops
905 /// that are suitable for reassociation, otherwise return false.
906 /// If the instruction's operands must be commuted to have a previous
907 /// instruction of the same type define the first source operand, \P Commuted
908 /// will be set to true.
909 bool isReassociationCandidate(const MachineInstr &Inst, bool &Commuted) const;
911 /// Return true when \P Inst is both associative and commutative.
912 virtual bool isAssociativeAndCommutative(const MachineInstr &Inst) const {
916 /// Return true when \P Inst has reassociable operands in the same \P MBB.
917 virtual bool hasReassociableOperands(const MachineInstr &Inst,
918 const MachineBasicBlock *MBB) const;
920 /// Return true when \P Inst has reassociable sibling.
921 bool hasReassociableSibling(const MachineInstr &Inst, bool &Commuted) const;
923 /// When getMachineCombinerPatterns() finds patterns, this function generates
924 /// the instructions that could replace the original code sequence. The client
925 /// has to decide whether the actual replacement is beneficial or not.
926 /// \param Root - Instruction that could be combined with one of its operands
927 /// \param Pattern - Combination pattern for Root
928 /// \param InsInstrs - Vector of new instructions that implement P
929 /// \param DelInstrs - Old instructions, including Root, that could be
930 /// replaced by InsInstr
931 /// \param InstrIdxForVirtReg - map of virtual register to instruction in
932 /// InsInstr that defines it
933 virtual void genAlternativeCodeSequence(
934 MachineInstr &Root, MachineCombinerPattern Pattern,
935 SmallVectorImpl<MachineInstr *> &InsInstrs,
936 SmallVectorImpl<MachineInstr *> &DelInstrs,
937 DenseMap<unsigned, unsigned> &InstrIdxForVirtReg) const;
939 /// Attempt to reassociate \P Root and \P Prev according to \P Pattern to
940 /// reduce critical path length.
941 void reassociateOps(MachineInstr &Root, MachineInstr &Prev,
942 MachineCombinerPattern Pattern,
943 SmallVectorImpl<MachineInstr *> &InsInstrs,
944 SmallVectorImpl<MachineInstr *> &DelInstrs,
945 DenseMap<unsigned, unsigned> &InstrIdxForVirtReg) const;
947 /// This is an architecture-specific helper function of reassociateOps.
948 /// Set special operand attributes for new instructions after reassociation.
949 virtual void setSpecialOperandAttr(MachineInstr &OldMI1, MachineInstr &OldMI2,
950 MachineInstr &NewMI1,
951 MachineInstr &NewMI2) const {}
953 /// Return true when a target supports MachineCombiner.
954 virtual bool useMachineCombiner() const { return false; }
956 /// Return true if the given SDNode can be copied during scheduling
957 /// even if it has glue.
958 virtual bool canCopyGluedNodeDuringSchedule(SDNode *N) const { return false; }
961 /// Target-dependent implementation for foldMemoryOperand.
962 /// Target-independent code in foldMemoryOperand will
963 /// take care of adding a MachineMemOperand to the newly created instruction.
964 /// The instruction and any auxiliary instructions necessary will be inserted
966 virtual MachineInstr *
967 foldMemoryOperandImpl(MachineFunction &MF, MachineInstr &MI,
968 ArrayRef<unsigned> Ops,
969 MachineBasicBlock::iterator InsertPt, int FrameIndex,
970 LiveIntervals *LIS = nullptr) const {
974 /// Target-dependent implementation for foldMemoryOperand.
975 /// Target-independent code in foldMemoryOperand will
976 /// take care of adding a MachineMemOperand to the newly created instruction.
977 /// The instruction and any auxiliary instructions necessary will be inserted
979 virtual MachineInstr *foldMemoryOperandImpl(
980 MachineFunction &MF, MachineInstr &MI, ArrayRef<unsigned> Ops,
981 MachineBasicBlock::iterator InsertPt, MachineInstr &LoadMI,
982 LiveIntervals *LIS = nullptr) const {
986 /// \brief Target-dependent implementation of getRegSequenceInputs.
988 /// \returns true if it is possible to build the equivalent
989 /// REG_SEQUENCE inputs with the pair \p MI, \p DefIdx. False otherwise.
991 /// \pre MI.isRegSequenceLike().
993 /// \see TargetInstrInfo::getRegSequenceInputs.
994 virtual bool getRegSequenceLikeInputs(
995 const MachineInstr &MI, unsigned DefIdx,
996 SmallVectorImpl<RegSubRegPairAndIdx> &InputRegs) const {
1000 /// \brief Target-dependent implementation of getExtractSubregInputs.
1002 /// \returns true if it is possible to build the equivalent
1003 /// EXTRACT_SUBREG inputs with the pair \p MI, \p DefIdx. False otherwise.
1005 /// \pre MI.isExtractSubregLike().
1007 /// \see TargetInstrInfo::getExtractSubregInputs.
1008 virtual bool getExtractSubregLikeInputs(const MachineInstr &MI,
1010 RegSubRegPairAndIdx &InputReg) const {
1014 /// \brief Target-dependent implementation of getInsertSubregInputs.
1016 /// \returns true if it is possible to build the equivalent
1017 /// INSERT_SUBREG inputs with the pair \p MI, \p DefIdx. False otherwise.
1019 /// \pre MI.isInsertSubregLike().
1021 /// \see TargetInstrInfo::getInsertSubregInputs.
1023 getInsertSubregLikeInputs(const MachineInstr &MI, unsigned DefIdx,
1024 RegSubRegPair &BaseReg,
1025 RegSubRegPairAndIdx &InsertedReg) const {
1030 /// getAddressSpaceForPseudoSourceKind - Given the kind of memory
1031 /// (e.g. stack) the target returns the corresponding address space.
1033 getAddressSpaceForPseudoSourceKind(PseudoSourceValue::PSVKind Kind) const {
1037 /// unfoldMemoryOperand - Separate a single instruction which folded a load or
1038 /// a store or a load and a store into two or more instruction. If this is
1039 /// possible, returns true as well as the new instructions by reference.
1041 unfoldMemoryOperand(MachineFunction &MF, MachineInstr &MI, unsigned Reg,
1042 bool UnfoldLoad, bool UnfoldStore,
1043 SmallVectorImpl<MachineInstr *> &NewMIs) const {
1047 virtual bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
1048 SmallVectorImpl<SDNode *> &NewNodes) const {
1052 /// Returns the opcode of the would be new
1053 /// instruction after load / store are unfolded from an instruction of the
1054 /// specified opcode. It returns zero if the specified unfolding is not
1055 /// possible. If LoadRegIndex is non-null, it is filled in with the operand
1056 /// index of the operand which will hold the register holding the loaded
1059 getOpcodeAfterMemoryUnfold(unsigned Opc, bool UnfoldLoad, bool UnfoldStore,
1060 unsigned *LoadRegIndex = nullptr) const {
1064 /// This is used by the pre-regalloc scheduler to determine if two loads are
1065 /// loading from the same base address. It should only return true if the base
1066 /// pointers are the same and the only differences between the two addresses
1067 /// are the offset. It also returns the offsets by reference.
1068 virtual bool areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2,
1070 int64_t &Offset2) const {
1074 /// This is a used by the pre-regalloc scheduler to determine (in conjunction
1075 /// with areLoadsFromSameBasePtr) if two loads should be scheduled together.
1076 /// On some targets if two loads are loading from
1077 /// addresses in the same cache line, it's better if they are scheduled
1078 /// together. This function takes two integers that represent the load offsets
1079 /// from the common base address. It returns true if it decides it's desirable
1080 /// to schedule the two loads together. "NumLoads" is the number of loads that
1081 /// have already been scheduled after Load1.
1082 virtual bool shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
1083 int64_t Offset1, int64_t Offset2,
1084 unsigned NumLoads) const {
1088 /// Get the base register and byte offset of an instruction that reads/writes
1090 virtual bool getMemOpBaseRegImmOfs(MachineInstr &MemOp, unsigned &BaseReg,
1092 const TargetRegisterInfo *TRI) const {
1096 /// Return true if the instruction contains a base register and offset. If
1097 /// true, the function also sets the operand position in the instruction
1098 /// for the base register and offset.
1099 virtual bool getBaseAndOffsetPosition(const MachineInstr &MI,
1101 unsigned &OffsetPos) const {
1105 /// If the instruction is an increment of a constant value, return the amount.
1106 virtual bool getIncrementValue(const MachineInstr &MI, int &Value) const {
1110 /// Returns true if the two given memory operations should be scheduled
1111 /// adjacent. Note that you have to add:
1112 /// DAG->addMutation(createLoadClusterDAGMutation(DAG->TII, DAG->TRI));
1114 /// DAG->addMutation(createStoreClusterDAGMutation(DAG->TII, DAG->TRI));
1115 /// to TargetPassConfig::createMachineScheduler() to have an effect.
1116 virtual bool shouldClusterMemOps(MachineInstr &FirstLdSt, unsigned BaseReg1,
1117 MachineInstr &SecondLdSt, unsigned BaseReg2,
1118 unsigned NumLoads) const {
1119 llvm_unreachable("target did not implement shouldClusterMemOps()");
1122 /// Reverses the branch condition of the specified condition list,
1123 /// returning false on success and true if it cannot be reversed.
1125 reverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const {
1129 /// Insert a noop into the instruction stream at the specified point.
1130 virtual void insertNoop(MachineBasicBlock &MBB,
1131 MachineBasicBlock::iterator MI) const;
1133 /// Return the noop instruction to use for a noop.
1134 virtual void getNoop(MCInst &NopInst) const;
1136 /// Return true for post-incremented instructions.
1137 virtual bool isPostIncrement(const MachineInstr &MI) const { return false; }
1139 /// Returns true if the instruction is already predicated.
1140 virtual bool isPredicated(const MachineInstr &MI) const { return false; }
1142 /// Returns true if the instruction is a
1143 /// terminator instruction that has not been predicated.
1144 virtual bool isUnpredicatedTerminator(const MachineInstr &MI) const;
1146 /// Returns true if MI is an unconditional tail call.
1147 virtual bool isUnconditionalTailCall(const MachineInstr &MI) const {
1151 /// Returns true if the tail call can be made conditional on BranchCond.
1152 virtual bool canMakeTailCallConditional(SmallVectorImpl<MachineOperand> &Cond,
1153 const MachineInstr &TailCall) const {
1157 /// Replace the conditional branch in MBB with a conditional tail call.
1158 virtual void replaceBranchWithTailCall(MachineBasicBlock &MBB,
1159 SmallVectorImpl<MachineOperand> &Cond,
1160 const MachineInstr &TailCall) const {
1161 llvm_unreachable("Target didn't implement replaceBranchWithTailCall!");
1164 /// Convert the instruction into a predicated instruction.
1165 /// It returns true if the operation was successful.
1166 virtual bool PredicateInstruction(MachineInstr &MI,
1167 ArrayRef<MachineOperand> Pred) const;
1169 /// Returns true if the first specified predicate
1170 /// subsumes the second, e.g. GE subsumes GT.
1171 virtual bool SubsumesPredicate(ArrayRef<MachineOperand> Pred1,
1172 ArrayRef<MachineOperand> Pred2) const {
1176 /// If the specified instruction defines any predicate
1177 /// or condition code register(s) used for predication, returns true as well
1178 /// as the definition predicate(s) by reference.
1179 virtual bool DefinesPredicate(MachineInstr &MI,
1180 std::vector<MachineOperand> &Pred) const {
1184 /// Return true if the specified instruction can be predicated.
1185 /// By default, this returns true for every instruction with a
1186 /// PredicateOperand.
1187 virtual bool isPredicable(const MachineInstr &MI) const {
1188 return MI.getDesc().isPredicable();
1191 /// Return true if it's safe to move a machine
1192 /// instruction that defines the specified register class.
1193 virtual bool isSafeToMoveRegClassDefs(const TargetRegisterClass *RC) const {
1197 /// Test if the given instruction should be considered a scheduling boundary.
1198 /// This primarily includes labels and terminators.
1199 virtual bool isSchedulingBoundary(const MachineInstr &MI,
1200 const MachineBasicBlock *MBB,
1201 const MachineFunction &MF) const;
1203 /// Measure the specified inline asm to determine an approximation of its
1205 virtual unsigned getInlineAsmLength(const char *Str,
1206 const MCAsmInfo &MAI) const;
1208 /// Allocate and return a hazard recognizer to use for this target when
1209 /// scheduling the machine instructions before register allocation.
1210 virtual ScheduleHazardRecognizer *
1211 CreateTargetHazardRecognizer(const TargetSubtargetInfo *STI,
1212 const ScheduleDAG *DAG) const;
1214 /// Allocate and return a hazard recognizer to use for this target when
1215 /// scheduling the machine instructions before register allocation.
1216 virtual ScheduleHazardRecognizer *
1217 CreateTargetMIHazardRecognizer(const InstrItineraryData *,
1218 const ScheduleDAG *DAG) const;
1220 /// Allocate and return a hazard recognizer to use for this target when
1221 /// scheduling the machine instructions after register allocation.
1222 virtual ScheduleHazardRecognizer *
1223 CreateTargetPostRAHazardRecognizer(const InstrItineraryData *,
1224 const ScheduleDAG *DAG) const;
1226 /// Allocate and return a hazard recognizer to use for by non-scheduling
1228 virtual ScheduleHazardRecognizer *
1229 CreateTargetPostRAHazardRecognizer(const MachineFunction &MF) const {
1233 /// Provide a global flag for disabling the PreRA hazard recognizer that
1234 /// targets may choose to honor.
1235 bool usePreRAHazardRecognizer() const;
1237 /// For a comparison instruction, return the source registers
1238 /// in SrcReg and SrcReg2 if having two register operands, and the value it
1239 /// compares against in CmpValue. Return true if the comparison instruction
1240 /// can be analyzed.
1241 virtual bool analyzeCompare(const MachineInstr &MI, unsigned &SrcReg,
1242 unsigned &SrcReg2, int &Mask, int &Value) const {
1246 /// See if the comparison instruction can be converted
1247 /// into something more efficient. E.g., on ARM most instructions can set the
1248 /// flags register, obviating the need for a separate CMP.
1249 virtual bool optimizeCompareInstr(MachineInstr &CmpInstr, unsigned SrcReg,
1250 unsigned SrcReg2, int Mask, int Value,
1251 const MachineRegisterInfo *MRI) const {
1254 virtual bool optimizeCondBranch(MachineInstr &MI) const { return false; }
1256 /// Try to remove the load by folding it to a register operand at the use.
1257 /// We fold the load instructions if and only if the
1258 /// def and use are in the same BB. We only look at one load and see
1259 /// whether it can be folded into MI. FoldAsLoadDefReg is the virtual register
1260 /// defined by the load we are trying to fold. DefMI returns the machine
1261 /// instruction that defines FoldAsLoadDefReg, and the function returns
1262 /// the machine instruction generated due to folding.
1263 virtual MachineInstr *optimizeLoadInstr(MachineInstr &MI,
1264 const MachineRegisterInfo *MRI,
1265 unsigned &FoldAsLoadDefReg,
1266 MachineInstr *&DefMI) const {
1270 /// 'Reg' is known to be defined by a move immediate instruction,
1271 /// try to fold the immediate into the use instruction.
1272 /// If MRI->hasOneNonDBGUse(Reg) is true, and this function returns true,
1273 /// then the caller may assume that DefMI has been erased from its parent
1274 /// block. The caller may assume that it will not be erased by this
1275 /// function otherwise.
1276 virtual bool FoldImmediate(MachineInstr &UseMI, MachineInstr &DefMI,
1277 unsigned Reg, MachineRegisterInfo *MRI) const {
1281 /// Return the number of u-operations the given machine
1282 /// instruction will be decoded to on the target cpu. The itinerary's
1283 /// IssueWidth is the number of microops that can be dispatched each
1284 /// cycle. An instruction with zero microops takes no dispatch resources.
1285 virtual unsigned getNumMicroOps(const InstrItineraryData *ItinData,
1286 const MachineInstr &MI) const;
1288 /// Return true for pseudo instructions that don't consume any
1289 /// machine resources in their current form. These are common cases that the
1290 /// scheduler should consider free, rather than conservatively handling them
1291 /// as instructions with no itinerary.
1292 bool isZeroCost(unsigned Opcode) const {
1293 return Opcode <= TargetOpcode::COPY;
1296 virtual int getOperandLatency(const InstrItineraryData *ItinData,
1297 SDNode *DefNode, unsigned DefIdx,
1298 SDNode *UseNode, unsigned UseIdx) const;
1300 /// Compute and return the use operand latency of a given pair of def and use.
1301 /// In most cases, the static scheduling itinerary was enough to determine the
1302 /// operand latency. But it may not be possible for instructions with variable
1303 /// number of defs / uses.
1305 /// This is a raw interface to the itinerary that may be directly overridden
1306 /// by a target. Use computeOperandLatency to get the best estimate of
1308 virtual int getOperandLatency(const InstrItineraryData *ItinData,
1309 const MachineInstr &DefMI, unsigned DefIdx,
1310 const MachineInstr &UseMI,
1311 unsigned UseIdx) const;
1313 /// Compute the instruction latency of a given instruction.
1314 /// If the instruction has higher cost when predicated, it's returned via
1316 virtual unsigned getInstrLatency(const InstrItineraryData *ItinData,
1317 const MachineInstr &MI,
1318 unsigned *PredCost = nullptr) const;
1320 virtual unsigned getPredicationCost(const MachineInstr &MI) const;
1322 virtual int getInstrLatency(const InstrItineraryData *ItinData,
1323 SDNode *Node) const;
1325 /// Return the default expected latency for a def based on its opcode.
1326 unsigned defaultDefLatency(const MCSchedModel &SchedModel,
1327 const MachineInstr &DefMI) const;
1329 int computeDefOperandLatency(const InstrItineraryData *ItinData,
1330 const MachineInstr &DefMI) const;
1332 /// Return true if this opcode has high latency to its result.
1333 virtual bool isHighLatencyDef(int opc) const { return false; }
1335 /// Compute operand latency between a def of 'Reg'
1336 /// and a use in the current loop. Return true if the target considered
1337 /// it 'high'. This is used by optimization passes such as machine LICM to
1338 /// determine whether it makes sense to hoist an instruction out even in a
1339 /// high register pressure situation.
1340 virtual bool hasHighOperandLatency(const TargetSchedModel &SchedModel,
1341 const MachineRegisterInfo *MRI,
1342 const MachineInstr &DefMI, unsigned DefIdx,
1343 const MachineInstr &UseMI,
1344 unsigned UseIdx) const {
1348 /// Compute operand latency of a def of 'Reg'. Return true
1349 /// if the target considered it 'low'.
1350 virtual bool hasLowDefLatency(const TargetSchedModel &SchedModel,
1351 const MachineInstr &DefMI,
1352 unsigned DefIdx) const;
1354 /// Perform target-specific instruction verification.
1355 virtual bool verifyInstruction(const MachineInstr &MI,
1356 StringRef &ErrInfo) const {
1360 /// Return the current execution domain and bit mask of
1361 /// possible domains for instruction.
1363 /// Some micro-architectures have multiple execution domains, and multiple
1364 /// opcodes that perform the same operation in different domains. For
1365 /// example, the x86 architecture provides the por, orps, and orpd
1366 /// instructions that all do the same thing. There is a latency penalty if a
1367 /// register is written in one domain and read in another.
1369 /// This function returns a pair (domain, mask) containing the execution
1370 /// domain of MI, and a bit mask of possible domains. The setExecutionDomain
1371 /// function can be used to change the opcode to one of the domains in the
1372 /// bit mask. Instructions whose execution domain can't be changed should
1373 /// return a 0 mask.
1375 /// The execution domain numbers don't have any special meaning except domain
1376 /// 0 is used for instructions that are not associated with any interesting
1377 /// execution domain.
1379 virtual std::pair<uint16_t, uint16_t>
1380 getExecutionDomain(const MachineInstr &MI) const {
1381 return std::make_pair(0, 0);
1384 /// Change the opcode of MI to execute in Domain.
1386 /// The bit (1 << Domain) must be set in the mask returned from
1387 /// getExecutionDomain(MI).
1388 virtual void setExecutionDomain(MachineInstr &MI, unsigned Domain) const {}
1390 /// Returns the preferred minimum clearance
1391 /// before an instruction with an unwanted partial register update.
1393 /// Some instructions only write part of a register, and implicitly need to
1394 /// read the other parts of the register. This may cause unwanted stalls
1395 /// preventing otherwise unrelated instructions from executing in parallel in
1396 /// an out-of-order CPU.
1398 /// For example, the x86 instruction cvtsi2ss writes its result to bits
1399 /// [31:0] of the destination xmm register. Bits [127:32] are unaffected, so
1400 /// the instruction needs to wait for the old value of the register to become
1403 /// addps %xmm1, %xmm0
1404 /// movaps %xmm0, (%rax)
1405 /// cvtsi2ss %rbx, %xmm0
1407 /// In the code above, the cvtsi2ss instruction needs to wait for the addps
1408 /// instruction before it can issue, even though the high bits of %xmm0
1409 /// probably aren't needed.
1411 /// This hook returns the preferred clearance before MI, measured in
1412 /// instructions. Other defs of MI's operand OpNum are avoided in the last N
1413 /// instructions before MI. It should only return a positive value for
1414 /// unwanted dependencies. If the old bits of the defined register have
1415 /// useful values, or if MI is determined to otherwise read the dependency,
1416 /// the hook should return 0.
1418 /// The unwanted dependency may be handled by:
1420 /// 1. Allocating the same register for an MI def and use. That makes the
1421 /// unwanted dependency identical to a required dependency.
1423 /// 2. Allocating a register for the def that has no defs in the previous N
1426 /// 3. Calling breakPartialRegDependency() with the same arguments. This
1427 /// allows the target to insert a dependency breaking instruction.
1430 getPartialRegUpdateClearance(const MachineInstr &MI, unsigned OpNum,
1431 const TargetRegisterInfo *TRI) const {
1432 // The default implementation returns 0 for no partial register dependency.
1436 /// \brief Return the minimum clearance before an instruction that reads an
1437 /// unused register.
1439 /// For example, AVX instructions may copy part of a register operand into
1440 /// the unused high bits of the destination register.
1442 /// vcvtsi2sdq %rax, undef %xmm0, %xmm14
1444 /// In the code above, vcvtsi2sdq copies %xmm0[127:64] into %xmm14 creating a
1445 /// false dependence on any previous write to %xmm0.
1447 /// This hook works similarly to getPartialRegUpdateClearance, except that it
1448 /// does not take an operand index. Instead sets \p OpNum to the index of the
1449 /// unused register.
1450 virtual unsigned getUndefRegClearance(const MachineInstr &MI, unsigned &OpNum,
1451 const TargetRegisterInfo *TRI) const {
1452 // The default implementation returns 0 for no undef register dependency.
1456 /// Insert a dependency-breaking instruction
1457 /// before MI to eliminate an unwanted dependency on OpNum.
1459 /// If it wasn't possible to avoid a def in the last N instructions before MI
1460 /// (see getPartialRegUpdateClearance), this hook will be called to break the
1461 /// unwanted dependency.
1463 /// On x86, an xorps instruction can be used as a dependency breaker:
1465 /// addps %xmm1, %xmm0
1466 /// movaps %xmm0, (%rax)
1467 /// xorps %xmm0, %xmm0
1468 /// cvtsi2ss %rbx, %xmm0
1470 /// An <imp-kill> operand should be added to MI if an instruction was
1471 /// inserted. This ties the instructions together in the post-ra scheduler.
1473 virtual void breakPartialRegDependency(MachineInstr &MI, unsigned OpNum,
1474 const TargetRegisterInfo *TRI) const {}
1476 /// Create machine specific model for scheduling.
1477 virtual DFAPacketizer *
1478 CreateTargetScheduleState(const TargetSubtargetInfo &) const {
1482 /// Sometimes, it is possible for the target
1483 /// to tell, even without aliasing information, that two MIs access different
1484 /// memory addresses. This function returns true if two MIs access different
1485 /// memory addresses and false otherwise.
1487 /// Assumes any physical registers used to compute addresses have the same
1488 /// value for both instructions. (This is the most useful assumption for
1489 /// post-RA scheduling.)
1491 /// See also MachineInstr::mayAlias, which is implemented on top of this
1494 areMemAccessesTriviallyDisjoint(MachineInstr &MIa, MachineInstr &MIb,
1495 AliasAnalysis *AA = nullptr) const {
1496 assert((MIa.mayLoad() || MIa.mayStore()) &&
1497 "MIa must load from or modify a memory location");
1498 assert((MIb.mayLoad() || MIb.mayStore()) &&
1499 "MIb must load from or modify a memory location");
1503 /// \brief Return the value to use for the MachineCSE's LookAheadLimit,
1504 /// which is a heuristic used for CSE'ing phys reg defs.
1505 virtual unsigned getMachineCSELookAheadLimit() const {
1506 // The default lookahead is small to prevent unprofitable quadratic
1511 /// Return an array that contains the ids of the target indices (used for the
1512 /// TargetIndex machine operand) and their names.
1514 /// MIR Serialization is able to serialize only the target indices that are
1515 /// defined by this method.
1516 virtual ArrayRef<std::pair<int, const char *>>
1517 getSerializableTargetIndices() const {
1521 /// Decompose the machine operand's target flags into two values - the direct
1522 /// target flag value and any of bit flags that are applied.
1523 virtual std::pair<unsigned, unsigned>
1524 decomposeMachineOperandsTargetFlags(unsigned /*TF*/) const {
1525 return std::make_pair(0u, 0u);
1528 /// Return an array that contains the direct target flag values and their
1531 /// MIR Serialization is able to serialize only the target flags that are
1532 /// defined by this method.
1533 virtual ArrayRef<std::pair<unsigned, const char *>>
1534 getSerializableDirectMachineOperandTargetFlags() const {
1538 /// Return an array that contains the bitmask target flag values and their
1541 /// MIR Serialization is able to serialize only the target flags that are
1542 /// defined by this method.
1543 virtual ArrayRef<std::pair<unsigned, const char *>>
1544 getSerializableBitmaskMachineOperandTargetFlags() const {
1548 /// Return an array that contains the MMO target flag values and their
1551 /// MIR Serialization is able to serialize only the MMO target flags that are
1552 /// defined by this method.
1553 virtual ArrayRef<std::pair<MachineMemOperand::Flags, const char *>>
1554 getSerializableMachineMemOperandTargetFlags() const {
1558 /// Determines whether \p Inst is a tail call instruction. Override this
1559 /// method on targets that do not properly set MCID::Return and MCID::Call on
1560 /// tail call instructions."
1561 virtual bool isTailCall(const MachineInstr &Inst) const {
1562 return Inst.isReturn() && Inst.isCall();
1565 /// True if the instruction is bound to the top of its basic block and no
1566 /// other instructions shall be inserted before it. This can be implemented
1567 /// to prevent register allocator to insert spills before such instructions.
1568 virtual bool isBasicBlockPrologue(const MachineInstr &MI) const {
1572 /// \brief Describes the number of instructions that it will take to call and
1573 /// construct a frame for a given outlining candidate.
1574 struct MachineOutlinerInfo {
1575 /// Number of instructions to call an outlined function for this candidate.
1576 unsigned CallOverhead;
1578 /// \brief Number of instructions to construct an outlined function frame
1579 /// for this candidate.
1580 unsigned FrameOverhead;
1582 /// \brief Represents the specific instructions that must be emitted to
1583 /// construct a call to this candidate.
1584 unsigned CallConstructionID;
1586 /// \brief Represents the specific instructions that must be emitted to
1587 /// construct a frame for this candidate's outlined function.
1588 unsigned FrameConstructionID;
1590 MachineOutlinerInfo() {}
1591 MachineOutlinerInfo(unsigned CallOverhead, unsigned FrameOverhead,
1592 unsigned CallConstructionID,
1593 unsigned FrameConstructionID)
1594 : CallOverhead(CallOverhead), FrameOverhead(FrameOverhead),
1595 CallConstructionID(CallConstructionID),
1596 FrameConstructionID(FrameConstructionID) {}
1599 /// \brief Returns a \p MachineOutlinerInfo struct containing target-specific
1600 /// information for a set of outlining candidates.
1601 virtual MachineOutlinerInfo getOutlininingCandidateInfo(
1603 std::pair<MachineBasicBlock::iterator, MachineBasicBlock::iterator>>
1604 &RepeatedSequenceLocs) const {
1606 "Target didn't implement TargetInstrInfo::getOutliningOverhead!");
1609 /// Represents how an instruction should be mapped by the outliner.
1610 /// \p Legal instructions are those which are safe to outline.
1611 /// \p Illegal instructions are those which cannot be outlined.
1612 /// \p Invisible instructions are instructions which can be outlined, but
1613 /// shouldn't actually impact the outlining result.
1614 enum MachineOutlinerInstrType { Legal, Illegal, Invisible };
1616 /// Returns how or if \p MI should be outlined.
1617 virtual MachineOutlinerInstrType getOutliningType(MachineInstr &MI) const {
1619 "Target didn't implement TargetInstrInfo::getOutliningType!");
1622 /// Insert a custom epilogue for outlined functions.
1623 /// This may be empty, in which case no epilogue or return statement will be
1625 virtual void insertOutlinerEpilogue(MachineBasicBlock &MBB,
1626 MachineFunction &MF,
1627 const MachineOutlinerInfo &MInfo) const {
1629 "Target didn't implement TargetInstrInfo::insertOutlinerEpilogue!");
1632 /// Insert a call to an outlined function into the program.
1633 /// Returns an iterator to the spot where we inserted the call. This must be
1634 /// implemented by the target.
1635 virtual MachineBasicBlock::iterator
1636 insertOutlinedCall(Module &M, MachineBasicBlock &MBB,
1637 MachineBasicBlock::iterator &It, MachineFunction &MF,
1638 const MachineOutlinerInfo &MInfo) const {
1640 "Target didn't implement TargetInstrInfo::insertOutlinedCall!");
1643 /// Insert a custom prologue for outlined functions.
1644 /// This may be empty, in which case no prologue will be emitted.
1645 virtual void insertOutlinerPrologue(MachineBasicBlock &MBB,
1646 MachineFunction &MF,
1647 const MachineOutlinerInfo &MInfo) const {
1649 "Target didn't implement TargetInstrInfo::insertOutlinerPrologue!");
1652 /// Return true if the function can safely be outlined from.
1653 /// A function \p MF is considered safe for outlining if an outlined function
1654 /// produced from instructions in F will produce a program which produces the
1655 /// same output for any set of given inputs.
1656 virtual bool isFunctionSafeToOutlineFrom(MachineFunction &MF,
1657 bool OutlineFromLinkOnceODRs) const {
1658 llvm_unreachable("Target didn't implement "
1659 "TargetInstrInfo::isFunctionSafeToOutlineFrom!");
1663 unsigned CallFrameSetupOpcode, CallFrameDestroyOpcode;
1664 unsigned CatchRetOpcode;
1665 unsigned ReturnOpcode;
1668 /// \brief Provide DenseMapInfo for TargetInstrInfo::RegSubRegPair.
1669 template <> struct DenseMapInfo<TargetInstrInfo::RegSubRegPair> {
1670 using RegInfo = DenseMapInfo<unsigned>;
1672 static inline TargetInstrInfo::RegSubRegPair getEmptyKey() {
1673 return TargetInstrInfo::RegSubRegPair(RegInfo::getEmptyKey(),
1674 RegInfo::getEmptyKey());
1677 static inline TargetInstrInfo::RegSubRegPair getTombstoneKey() {
1678 return TargetInstrInfo::RegSubRegPair(RegInfo::getTombstoneKey(),
1679 RegInfo::getTombstoneKey());
1682 /// \brief Reuse getHashValue implementation from
1683 /// std::pair<unsigned, unsigned>.
1684 static unsigned getHashValue(const TargetInstrInfo::RegSubRegPair &Val) {
1685 std::pair<unsigned, unsigned> PairVal = std::make_pair(Val.Reg, Val.SubReg);
1686 return DenseMapInfo<std::pair<unsigned, unsigned>>::getHashValue(PairVal);
1689 static bool isEqual(const TargetInstrInfo::RegSubRegPair &LHS,
1690 const TargetInstrInfo::RegSubRegPair &RHS) {
1691 return RegInfo::isEqual(LHS.Reg, RHS.Reg) &&
1692 RegInfo::isEqual(LHS.SubReg, RHS.SubReg);
1696 } // end namespace llvm
1698 #endif // LLVM_TARGET_TARGETINSTRINFO_H