1 //===-- X86InstrInfo.h - X86 Instruction Information ------------*- 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 contains the X86 implementation of the TargetInstrInfo class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_TARGET_X86_X86INSTRINFO_H
15 #define LLVM_LIB_TARGET_X86_X86INSTRINFO_H
17 #include "MCTargetDesc/X86BaseInfo.h"
18 #include "X86RegisterInfo.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/Target/TargetInstrInfo.h"
22 #define GET_INSTRINFO_HEADER
23 #include "X86GenInstrInfo.inc"
26 class X86RegisterInfo;
29 namespace MachineCombinerPattern {
30 enum MC_PATTERN : int {
31 // These are commutative variants for reassociating a computation chain
40 } // end namespace MachineCombinerPattern
43 // X86 specific condition code. These correspond to X86_*_COND in
44 // X86InstrInfo.td. They must be kept in synch.
62 LAST_VALID_COND = COND_S,
64 // Artificial condition codes. These are used by AnalyzeBranch
65 // to indicate a block terminated with two conditional branches to
66 // the same location. This occurs in code using FCMP_OEQ or FCMP_UNE,
67 // which can't be represented on x86 with a single condition. These
68 // are never used in MachineInstrs.
75 // Turn condition code into conditional branch opcode.
76 unsigned GetCondBranchFromCond(CondCode CC);
78 /// \brief Return a set opcode for the given condition and whether it has
80 unsigned getSETFromCond(CondCode CC, bool HasMemoryOperand = false);
82 /// \brief Return a cmov opcode for the given condition, register size in
83 /// bytes, and operand type.
84 unsigned getCMovFromCond(CondCode CC, unsigned RegBytes,
85 bool HasMemoryOperand = false);
87 // Turn CMov opcode into condition code.
88 CondCode getCondFromCMovOpc(unsigned Opc);
90 /// GetOppositeBranchCondition - Return the inverse of the specified cond,
91 /// e.g. turning COND_E to COND_NE.
92 CondCode GetOppositeBranchCondition(CondCode CC);
93 } // end namespace X86;
96 /// isGlobalStubReference - Return true if the specified TargetFlag operand is
97 /// a reference to a stub for a global, not the global itself.
98 inline static bool isGlobalStubReference(unsigned char TargetFlag) {
100 case X86II::MO_DLLIMPORT: // dllimport stub.
101 case X86II::MO_GOTPCREL: // rip-relative GOT reference.
102 case X86II::MO_GOT: // normal GOT reference.
103 case X86II::MO_DARWIN_NONLAZY_PIC_BASE: // Normal $non_lazy_ptr ref.
104 case X86II::MO_DARWIN_NONLAZY: // Normal $non_lazy_ptr ref.
105 case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: // Hidden $non_lazy_ptr ref.
112 /// isGlobalRelativeToPICBase - Return true if the specified global value
113 /// reference is relative to a 32-bit PIC base (X86ISD::GlobalBaseReg). If this
114 /// is true, the addressing mode has the PIC base register added in (e.g. EBX).
115 inline static bool isGlobalRelativeToPICBase(unsigned char TargetFlag) {
116 switch (TargetFlag) {
117 case X86II::MO_GOTOFF: // isPICStyleGOT: local global.
118 case X86II::MO_GOT: // isPICStyleGOT: other global.
119 case X86II::MO_PIC_BASE_OFFSET: // Darwin local global.
120 case X86II::MO_DARWIN_NONLAZY_PIC_BASE: // Darwin/32 external global.
121 case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: // Darwin/32 hidden global.
122 case X86II::MO_TLVP: // ??? Pretty sure..
129 inline static bool isScale(const MachineOperand &MO) {
131 (MO.getImm() == 1 || MO.getImm() == 2 ||
132 MO.getImm() == 4 || MO.getImm() == 8);
135 inline static bool isLeaMem(const MachineInstr *MI, unsigned Op) {
136 if (MI->getOperand(Op).isFI()) return true;
137 return Op+X86::AddrSegmentReg <= MI->getNumOperands() &&
138 MI->getOperand(Op+X86::AddrBaseReg).isReg() &&
139 isScale(MI->getOperand(Op+X86::AddrScaleAmt)) &&
140 MI->getOperand(Op+X86::AddrIndexReg).isReg() &&
141 (MI->getOperand(Op+X86::AddrDisp).isImm() ||
142 MI->getOperand(Op+X86::AddrDisp).isGlobal() ||
143 MI->getOperand(Op+X86::AddrDisp).isCPI() ||
144 MI->getOperand(Op+X86::AddrDisp).isJTI());
147 inline static bool isMem(const MachineInstr *MI, unsigned Op) {
148 if (MI->getOperand(Op).isFI()) return true;
149 return Op+X86::AddrNumOperands <= MI->getNumOperands() &&
150 MI->getOperand(Op+X86::AddrSegmentReg).isReg() &&
154 class X86InstrInfo final : public X86GenInstrInfo {
155 X86Subtarget &Subtarget;
156 const X86RegisterInfo RI;
158 /// RegOp2MemOpTable3Addr, RegOp2MemOpTable0, RegOp2MemOpTable1,
159 /// RegOp2MemOpTable2, RegOp2MemOpTable3 - Load / store folding opcode maps.
161 typedef DenseMap<unsigned,
162 std::pair<unsigned, unsigned> > RegOp2MemOpTableType;
163 RegOp2MemOpTableType RegOp2MemOpTable2Addr;
164 RegOp2MemOpTableType RegOp2MemOpTable0;
165 RegOp2MemOpTableType RegOp2MemOpTable1;
166 RegOp2MemOpTableType RegOp2MemOpTable2;
167 RegOp2MemOpTableType RegOp2MemOpTable3;
168 RegOp2MemOpTableType RegOp2MemOpTable4;
170 /// MemOp2RegOpTable - Load / store unfolding opcode map.
172 typedef DenseMap<unsigned,
173 std::pair<unsigned, unsigned> > MemOp2RegOpTableType;
174 MemOp2RegOpTableType MemOp2RegOpTable;
176 static void AddTableEntry(RegOp2MemOpTableType &R2MTable,
177 MemOp2RegOpTableType &M2RTable,
178 unsigned RegOp, unsigned MemOp, unsigned Flags);
180 virtual void anchor();
182 bool AnalyzeBranchImpl(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
183 MachineBasicBlock *&FBB,
184 SmallVectorImpl<MachineOperand> &Cond,
185 SmallVectorImpl<MachineInstr *> &CondBranches,
186 bool AllowModify) const;
189 explicit X86InstrInfo(X86Subtarget &STI);
191 /// getRegisterInfo - TargetInstrInfo is a superset of MRegister info. As
192 /// such, whenever a client has an instance of instruction info, it should
193 /// always be able to get register info as well (through this method).
195 const X86RegisterInfo &getRegisterInfo() const { return RI; }
197 /// getSPAdjust - This returns the stack pointer adjustment made by
198 /// this instruction. For x86, we need to handle more complex call
199 /// sequences involving PUSHes.
200 int getSPAdjust(const MachineInstr *MI) const override;
202 /// isCoalescableExtInstr - Return true if the instruction is a "coalescable"
203 /// extension instruction. That is, it's like a copy where it's legal for the
204 /// source to overlap the destination. e.g. X86::MOVSX64rr32. If this returns
205 /// true, then it's expected the pre-extension value is available as a subreg
206 /// of the result register. This also returns the sub-register index in
208 bool isCoalescableExtInstr(const MachineInstr &MI,
209 unsigned &SrcReg, unsigned &DstReg,
210 unsigned &SubIdx) const override;
212 unsigned isLoadFromStackSlot(const MachineInstr *MI,
213 int &FrameIndex) const override;
214 /// isLoadFromStackSlotPostFE - Check for post-frame ptr elimination
215 /// stack locations as well. This uses a heuristic so it isn't
216 /// reliable for correctness.
217 unsigned isLoadFromStackSlotPostFE(const MachineInstr *MI,
218 int &FrameIndex) const override;
220 unsigned isStoreToStackSlot(const MachineInstr *MI,
221 int &FrameIndex) const override;
222 /// isStoreToStackSlotPostFE - Check for post-frame ptr elimination
223 /// stack locations as well. This uses a heuristic so it isn't
224 /// reliable for correctness.
225 unsigned isStoreToStackSlotPostFE(const MachineInstr *MI,
226 int &FrameIndex) const override;
228 bool isReallyTriviallyReMaterializable(const MachineInstr *MI,
229 AliasAnalysis *AA) const override;
230 void reMaterialize(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
231 unsigned DestReg, unsigned SubIdx,
232 const MachineInstr *Orig,
233 const TargetRegisterInfo &TRI) const override;
235 /// Given an operand within a MachineInstr, insert preceding code to put it
236 /// into the right format for a particular kind of LEA instruction. This may
237 /// involve using an appropriate super-register instead (with an implicit use
238 /// of the original) or creating a new virtual register and inserting COPY
239 /// instructions to get the data into the right class.
241 /// Reference parameters are set to indicate how caller should add this
242 /// operand to the LEA instruction.
243 bool classifyLEAReg(MachineInstr *MI, const MachineOperand &Src,
244 unsigned LEAOpcode, bool AllowSP,
245 unsigned &NewSrc, bool &isKill,
246 bool &isUndef, MachineOperand &ImplicitOp) const;
248 /// convertToThreeAddress - This method must be implemented by targets that
249 /// set the M_CONVERTIBLE_TO_3_ADDR flag. When this flag is set, the target
250 /// may be able to convert a two-address instruction into a true
251 /// three-address instruction on demand. This allows the X86 target (for
252 /// example) to convert ADD and SHL instructions into LEA instructions if they
253 /// would require register copies due to two-addressness.
255 /// This method returns a null pointer if the transformation cannot be
256 /// performed, otherwise it returns the new instruction.
258 MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
259 MachineBasicBlock::iterator &MBBI,
260 LiveVariables *LV) const override;
262 /// commuteInstruction - We have a few instructions that must be hacked on to
265 MachineInstr *commuteInstruction(MachineInstr *MI, bool NewMI) const override;
267 bool findCommutedOpIndices(MachineInstr *MI, unsigned &SrcOpIdx1,
268 unsigned &SrcOpIdx2) const override;
271 bool isUnpredicatedTerminator(const MachineInstr* MI) const override;
272 bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
273 MachineBasicBlock *&FBB,
274 SmallVectorImpl<MachineOperand> &Cond,
275 bool AllowModify) const override;
277 bool getMemOpBaseRegImmOfs(MachineInstr *LdSt, unsigned &BaseReg,
279 const TargetRegisterInfo *TRI) const override;
280 bool AnalyzeBranchPredicate(MachineBasicBlock &MBB,
281 TargetInstrInfo::MachineBranchPredicate &MBP,
282 bool AllowModify = false) const override;
284 unsigned RemoveBranch(MachineBasicBlock &MBB) const override;
285 unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
286 MachineBasicBlock *FBB, ArrayRef<MachineOperand> Cond,
287 DebugLoc DL) const override;
288 bool canInsertSelect(const MachineBasicBlock&, ArrayRef<MachineOperand> Cond,
289 unsigned, unsigned, int&, int&, int&) const override;
290 void insertSelect(MachineBasicBlock &MBB,
291 MachineBasicBlock::iterator MI, DebugLoc DL,
292 unsigned DstReg, ArrayRef<MachineOperand> Cond,
293 unsigned TrueReg, unsigned FalseReg) const override;
294 void copyPhysReg(MachineBasicBlock &MBB,
295 MachineBasicBlock::iterator MI, DebugLoc DL,
296 unsigned DestReg, unsigned SrcReg,
297 bool KillSrc) const override;
298 void storeRegToStackSlot(MachineBasicBlock &MBB,
299 MachineBasicBlock::iterator MI,
300 unsigned SrcReg, bool isKill, int FrameIndex,
301 const TargetRegisterClass *RC,
302 const TargetRegisterInfo *TRI) const override;
304 void storeRegToAddr(MachineFunction &MF, unsigned SrcReg, bool isKill,
305 SmallVectorImpl<MachineOperand> &Addr,
306 const TargetRegisterClass *RC,
307 MachineInstr::mmo_iterator MMOBegin,
308 MachineInstr::mmo_iterator MMOEnd,
309 SmallVectorImpl<MachineInstr*> &NewMIs) const;
311 void loadRegFromStackSlot(MachineBasicBlock &MBB,
312 MachineBasicBlock::iterator MI,
313 unsigned DestReg, int FrameIndex,
314 const TargetRegisterClass *RC,
315 const TargetRegisterInfo *TRI) const override;
317 void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
318 SmallVectorImpl<MachineOperand> &Addr,
319 const TargetRegisterClass *RC,
320 MachineInstr::mmo_iterator MMOBegin,
321 MachineInstr::mmo_iterator MMOEnd,
322 SmallVectorImpl<MachineInstr*> &NewMIs) const;
324 bool expandPostRAPseudo(MachineBasicBlock::iterator MI) const override;
326 /// foldMemoryOperand - If this target supports it, fold a load or store of
327 /// the specified stack slot into the specified machine instruction for the
328 /// specified operand(s). If this is possible, the target should perform the
329 /// folding and return true, otherwise it should return false. If it folds
330 /// the instruction, it is likely that the MachineInstruction the iterator
331 /// references has been changed.
332 MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
333 ArrayRef<unsigned> Ops,
334 MachineBasicBlock::iterator InsertPt,
335 int FrameIndex) const override;
337 /// foldMemoryOperand - Same as the previous version except it allows folding
338 /// of any load and store from / to any address, not just from a specific
340 MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
341 ArrayRef<unsigned> Ops,
342 MachineBasicBlock::iterator InsertPt,
343 MachineInstr *LoadMI) const override;
345 /// unfoldMemoryOperand - Separate a single instruction which folded a load or
346 /// a store or a load and a store into two or more instruction. If this is
347 /// possible, returns true as well as the new instructions by reference.
348 bool unfoldMemoryOperand(MachineFunction &MF, MachineInstr *MI,
349 unsigned Reg, bool UnfoldLoad, bool UnfoldStore,
350 SmallVectorImpl<MachineInstr*> &NewMIs) const override;
352 bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
353 SmallVectorImpl<SDNode*> &NewNodes) const override;
355 /// getOpcodeAfterMemoryUnfold - Returns the opcode of the would be new
356 /// instruction after load / store are unfolded from an instruction of the
357 /// specified opcode. It returns zero if the specified unfolding is not
358 /// possible. If LoadRegIndex is non-null, it is filled in with the operand
359 /// index of the operand which will hold the register holding the loaded
361 unsigned getOpcodeAfterMemoryUnfold(unsigned Opc,
362 bool UnfoldLoad, bool UnfoldStore,
363 unsigned *LoadRegIndex = nullptr) const override;
365 /// areLoadsFromSameBasePtr - This is used by the pre-regalloc scheduler
366 /// to determine if two loads are loading from the same base address. It
367 /// should only return true if the base pointers are the same and the
368 /// only differences between the two addresses are the offset. It also returns
369 /// the offsets by reference.
370 bool areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2, int64_t &Offset1,
371 int64_t &Offset2) const override;
373 /// shouldScheduleLoadsNear - This is a used by the pre-regalloc scheduler to
374 /// determine (in conjunction with areLoadsFromSameBasePtr) if two loads should
375 /// be scheduled togther. On some targets if two loads are loading from
376 /// addresses in the same cache line, it's better if they are scheduled
377 /// together. This function takes two integers that represent the load offsets
378 /// from the common base address. It returns true if it decides it's desirable
379 /// to schedule the two loads together. "NumLoads" is the number of loads that
380 /// have already been scheduled after Load1.
381 bool shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
382 int64_t Offset1, int64_t Offset2,
383 unsigned NumLoads) const override;
385 bool shouldScheduleAdjacent(MachineInstr* First,
386 MachineInstr *Second) const override;
388 void getNoopForMachoTarget(MCInst &NopInst) const override;
391 ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const override;
393 /// isSafeToMoveRegClassDefs - Return true if it's safe to move a machine
394 /// instruction that defines the specified register class.
395 bool isSafeToMoveRegClassDefs(const TargetRegisterClass *RC) const override;
397 /// isSafeToClobberEFLAGS - Return true if it's safe insert an instruction tha
398 /// would clobber the EFLAGS condition register. Note the result may be
399 /// conservative. If it cannot definitely determine the safety after visiting
400 /// a few instructions in each direction it assumes it's not safe.
401 bool isSafeToClobberEFLAGS(MachineBasicBlock &MBB,
402 MachineBasicBlock::iterator I) const;
404 static bool isX86_64ExtendedReg(const MachineOperand &MO) {
405 if (!MO.isReg()) return false;
406 return X86II::isX86_64ExtendedReg(MO.getReg());
409 /// getGlobalBaseReg - Return a virtual register initialized with the
410 /// the global base register value. Output instructions required to
411 /// initialize the register in the function entry block, if necessary.
413 unsigned getGlobalBaseReg(MachineFunction *MF) const;
415 std::pair<uint16_t, uint16_t>
416 getExecutionDomain(const MachineInstr *MI) const override;
418 void setExecutionDomain(MachineInstr *MI, unsigned Domain) const override;
421 getPartialRegUpdateClearance(const MachineInstr *MI, unsigned OpNum,
422 const TargetRegisterInfo *TRI) const override;
423 unsigned getUndefRegClearance(const MachineInstr *MI, unsigned &OpNum,
424 const TargetRegisterInfo *TRI) const override;
425 void breakPartialRegDependency(MachineBasicBlock::iterator MI, unsigned OpNum,
426 const TargetRegisterInfo *TRI) const override;
428 MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
430 ArrayRef<MachineOperand> MOs,
431 MachineBasicBlock::iterator InsertPt,
432 unsigned Size, unsigned Alignment,
433 bool AllowCommute) const;
436 getUnconditionalBranch(MCInst &Branch,
437 const MCSymbolRefExpr *BranchTarget) const override;
439 void getTrap(MCInst &MI) const override;
441 unsigned getJumpInstrTableEntryBound() const override;
443 bool isHighLatencyDef(int opc) const override;
445 bool hasHighOperandLatency(const TargetSchedModel &SchedModel,
446 const MachineRegisterInfo *MRI,
447 const MachineInstr *DefMI, unsigned DefIdx,
448 const MachineInstr *UseMI,
449 unsigned UseIdx) const override;
452 bool useMachineCombiner() const override {
456 /// Return true when there is potentially a faster code sequence
457 /// for an instruction chain ending in <Root>. All potential patterns are
458 /// output in the <Pattern> array.
459 bool getMachineCombinerPatterns(
461 SmallVectorImpl<MachineCombinerPattern::MC_PATTERN> &P) const override;
463 /// When getMachineCombinerPatterns() finds a pattern, this function generates
464 /// the instructions that could replace the original code sequence.
465 void genAlternativeCodeSequence(
466 MachineInstr &Root, MachineCombinerPattern::MC_PATTERN P,
467 SmallVectorImpl<MachineInstr *> &InsInstrs,
468 SmallVectorImpl<MachineInstr *> &DelInstrs,
469 DenseMap<unsigned, unsigned> &InstrIdxForVirtReg) const override;
471 /// analyzeCompare - For a comparison instruction, return the source registers
472 /// in SrcReg and SrcReg2 if having two register operands, and the value it
473 /// compares against in CmpValue. Return true if the comparison instruction
475 bool analyzeCompare(const MachineInstr *MI, unsigned &SrcReg,
476 unsigned &SrcReg2, int &CmpMask,
477 int &CmpValue) const override;
479 /// optimizeCompareInstr - Check if there exists an earlier instruction that
480 /// operates on the same source operands and sets flags in the same way as
481 /// Compare; remove Compare if possible.
482 bool optimizeCompareInstr(MachineInstr *CmpInstr, unsigned SrcReg,
483 unsigned SrcReg2, int CmpMask, int CmpValue,
484 const MachineRegisterInfo *MRI) const override;
486 /// optimizeLoadInstr - Try to remove the load by folding it to a register
487 /// operand at the use. We fold the load instructions if and only if the
488 /// def and use are in the same BB. We only look at one load and see
489 /// whether it can be folded into MI. FoldAsLoadDefReg is the virtual register
490 /// defined by the load we are trying to fold. DefMI returns the machine
491 /// instruction that defines FoldAsLoadDefReg, and the function returns
492 /// the machine instruction generated due to folding.
493 MachineInstr* optimizeLoadInstr(MachineInstr *MI,
494 const MachineRegisterInfo *MRI,
495 unsigned &FoldAsLoadDefReg,
496 MachineInstr *&DefMI) const override;
498 std::pair<unsigned, unsigned>
499 decomposeMachineOperandsTargetFlags(unsigned TF) const override;
501 ArrayRef<std::pair<unsigned, const char *>>
502 getSerializableDirectMachineOperandTargetFlags() const override;
505 MachineInstr * convertToThreeAddressWithLEA(unsigned MIOpc,
506 MachineFunction::iterator &MFI,
507 MachineBasicBlock::iterator &MBBI,
508 LiveVariables *LV) const;
510 /// isFrameOperand - Return true and the FrameIndex if the specified
511 /// operand and follow operands form a reference to the stack frame.
512 bool isFrameOperand(const MachineInstr *MI, unsigned int Op,
513 int &FrameIndex) const;
516 } // End llvm namespace