[x86] Add a reassociation optimization to increase ILP via the MachineCombiner pass
[oota-llvm.git] / lib / Target / X86 / X86InstrInfo.h
1 //===-- X86InstrInfo.h - X86 Instruction Information ------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the X86 implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TARGET_X86_X86INSTRINFO_H
15 #define LLVM_LIB_TARGET_X86_X86INSTRINFO_H
16
17 #include "MCTargetDesc/X86BaseInfo.h"
18 #include "X86RegisterInfo.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/Target/TargetInstrInfo.h"
21
22 #define GET_INSTRINFO_HEADER
23 #include "X86GenInstrInfo.inc"
24
25 namespace llvm {
26   class X86RegisterInfo;
27   class X86Subtarget;
28
29   namespace MachineCombinerPattern {
30     enum MC_PATTERN : int {
31       // These are commutative variants for reassociating a computation chain
32       // of the form:
33       //   B = A op X (Prev)
34       //   C = B op Y (Root)
35       MC_REASSOC_AX_BY = 0,
36       MC_REASSOC_AX_YB = 1,
37       MC_REASSOC_XA_BY = 2,
38       MC_REASSOC_XA_YB = 3,
39     };
40   } // end namespace MachineCombinerPattern
41
42 namespace X86 {
43   // X86 specific condition code. These correspond to X86_*_COND in
44   // X86InstrInfo.td. They must be kept in synch.
45   enum CondCode {
46     COND_A  = 0,
47     COND_AE = 1,
48     COND_B  = 2,
49     COND_BE = 3,
50     COND_E  = 4,
51     COND_G  = 5,
52     COND_GE = 6,
53     COND_L  = 7,
54     COND_LE = 8,
55     COND_NE = 9,
56     COND_NO = 10,
57     COND_NP = 11,
58     COND_NS = 12,
59     COND_O  = 13,
60     COND_P  = 14,
61     COND_S  = 15,
62     LAST_VALID_COND = COND_S,
63
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.
69     COND_NE_OR_P,
70     COND_NP_OR_E,
71
72     COND_INVALID
73   };
74
75   // Turn condition code into conditional branch opcode.
76   unsigned GetCondBranchFromCond(CondCode CC);
77
78   /// \brief Return a set opcode for the given condition and whether it has
79   /// a memory operand.
80   unsigned getSETFromCond(CondCode CC, bool HasMemoryOperand = false);
81
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);
86
87   // Turn CMov opcode into condition code.
88   CondCode getCondFromCMovOpc(unsigned Opc);
89
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;
94
95
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) {
99   switch (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.
106     return true;
107   default:
108     return false;
109   }
110 }
111
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..
123     return true;
124   default:
125     return false;
126   }
127 }
128
129 inline static bool isScale(const MachineOperand &MO) {
130   return MO.isImm() &&
131     (MO.getImm() == 1 || MO.getImm() == 2 ||
132      MO.getImm() == 4 || MO.getImm() == 8);
133 }
134
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());
145 }
146
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() &&
151     isLeaMem(MI, Op);
152 }
153
154 class X86InstrInfo final : public X86GenInstrInfo {
155   X86Subtarget &Subtarget;
156   const X86RegisterInfo RI;
157
158   /// RegOp2MemOpTable3Addr, RegOp2MemOpTable0, RegOp2MemOpTable1,
159   /// RegOp2MemOpTable2, RegOp2MemOpTable3 - Load / store folding opcode maps.
160   ///
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;
169
170   /// MemOp2RegOpTable - Load / store unfolding opcode map.
171   ///
172   typedef DenseMap<unsigned,
173                    std::pair<unsigned, unsigned> > MemOp2RegOpTableType;
174   MemOp2RegOpTableType MemOp2RegOpTable;
175
176   static void AddTableEntry(RegOp2MemOpTableType &R2MTable,
177                             MemOp2RegOpTableType &M2RTable,
178                             unsigned RegOp, unsigned MemOp, unsigned Flags);
179
180   virtual void anchor();
181
182 public:
183   explicit X86InstrInfo(X86Subtarget &STI);
184
185   /// getRegisterInfo - TargetInstrInfo is a superset of MRegister info.  As
186   /// such, whenever a client has an instance of instruction info, it should
187   /// always be able to get register info as well (through this method).
188   ///
189   const X86RegisterInfo &getRegisterInfo() const { return RI; }
190
191   /// getSPAdjust - This returns the stack pointer adjustment made by
192   /// this instruction. For x86, we need to handle more complex call
193   /// sequences involving PUSHes.
194   int getSPAdjust(const MachineInstr *MI) const override;
195
196   /// isCoalescableExtInstr - Return true if the instruction is a "coalescable"
197   /// extension instruction. That is, it's like a copy where it's legal for the
198   /// source to overlap the destination. e.g. X86::MOVSX64rr32. If this returns
199   /// true, then it's expected the pre-extension value is available as a subreg
200   /// of the result register. This also returns the sub-register index in
201   /// SubIdx.
202   bool isCoalescableExtInstr(const MachineInstr &MI,
203                              unsigned &SrcReg, unsigned &DstReg,
204                              unsigned &SubIdx) const override;
205
206   unsigned isLoadFromStackSlot(const MachineInstr *MI,
207                                int &FrameIndex) const override;
208   /// isLoadFromStackSlotPostFE - Check for post-frame ptr elimination
209   /// stack locations as well.  This uses a heuristic so it isn't
210   /// reliable for correctness.
211   unsigned isLoadFromStackSlotPostFE(const MachineInstr *MI,
212                                      int &FrameIndex) const override;
213
214   unsigned isStoreToStackSlot(const MachineInstr *MI,
215                               int &FrameIndex) const override;
216   /// isStoreToStackSlotPostFE - Check for post-frame ptr elimination
217   /// stack locations as well.  This uses a heuristic so it isn't
218   /// reliable for correctness.
219   unsigned isStoreToStackSlotPostFE(const MachineInstr *MI,
220                                     int &FrameIndex) const override;
221
222   bool isReallyTriviallyReMaterializable(const MachineInstr *MI,
223                                          AliasAnalysis *AA) const override;
224   void reMaterialize(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
225                      unsigned DestReg, unsigned SubIdx,
226                      const MachineInstr *Orig,
227                      const TargetRegisterInfo &TRI) const override;
228
229   /// Given an operand within a MachineInstr, insert preceding code to put it
230   /// into the right format for a particular kind of LEA instruction. This may
231   /// involve using an appropriate super-register instead (with an implicit use
232   /// of the original) or creating a new virtual register and inserting COPY
233   /// instructions to get the data into the right class.
234   ///
235   /// Reference parameters are set to indicate how caller should add this
236   /// operand to the LEA instruction.
237   bool classifyLEAReg(MachineInstr *MI, const MachineOperand &Src,
238                       unsigned LEAOpcode, bool AllowSP,
239                       unsigned &NewSrc, bool &isKill,
240                       bool &isUndef, MachineOperand &ImplicitOp) const;
241
242   /// convertToThreeAddress - This method must be implemented by targets that
243   /// set the M_CONVERTIBLE_TO_3_ADDR flag.  When this flag is set, the target
244   /// may be able to convert a two-address instruction into a true
245   /// three-address instruction on demand.  This allows the X86 target (for
246   /// example) to convert ADD and SHL instructions into LEA instructions if they
247   /// would require register copies due to two-addressness.
248   ///
249   /// This method returns a null pointer if the transformation cannot be
250   /// performed, otherwise it returns the new instruction.
251   ///
252   MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
253                                       MachineBasicBlock::iterator &MBBI,
254                                       LiveVariables *LV) const override;
255
256   /// commuteInstruction - We have a few instructions that must be hacked on to
257   /// commute them.
258   ///
259   MachineInstr *commuteInstruction(MachineInstr *MI, bool NewMI) const override;
260
261   bool findCommutedOpIndices(MachineInstr *MI, unsigned &SrcOpIdx1,
262                              unsigned &SrcOpIdx2) const override;
263
264   // Branch analysis.
265   bool isUnpredicatedTerminator(const MachineInstr* MI) const override;
266   bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
267                      MachineBasicBlock *&FBB,
268                      SmallVectorImpl<MachineOperand> &Cond,
269                      bool AllowModify) const override;
270   unsigned RemoveBranch(MachineBasicBlock &MBB) const override;
271   unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
272                         MachineBasicBlock *FBB,
273                         const SmallVectorImpl<MachineOperand> &Cond,
274                         DebugLoc DL) const override;
275   bool canInsertSelect(const MachineBasicBlock&,
276                        const SmallVectorImpl<MachineOperand> &Cond,
277                        unsigned, unsigned, int&, int&, int&) const override;
278   void insertSelect(MachineBasicBlock &MBB,
279                     MachineBasicBlock::iterator MI, DebugLoc DL,
280                     unsigned DstReg,
281                     const SmallVectorImpl<MachineOperand> &Cond,
282                     unsigned TrueReg, unsigned FalseReg) const override;
283   void copyPhysReg(MachineBasicBlock &MBB,
284                    MachineBasicBlock::iterator MI, DebugLoc DL,
285                    unsigned DestReg, unsigned SrcReg,
286                    bool KillSrc) const override;
287   void storeRegToStackSlot(MachineBasicBlock &MBB,
288                            MachineBasicBlock::iterator MI,
289                            unsigned SrcReg, bool isKill, int FrameIndex,
290                            const TargetRegisterClass *RC,
291                            const TargetRegisterInfo *TRI) const override;
292
293   void storeRegToAddr(MachineFunction &MF, unsigned SrcReg, bool isKill,
294                       SmallVectorImpl<MachineOperand> &Addr,
295                       const TargetRegisterClass *RC,
296                       MachineInstr::mmo_iterator MMOBegin,
297                       MachineInstr::mmo_iterator MMOEnd,
298                       SmallVectorImpl<MachineInstr*> &NewMIs) const;
299
300   void loadRegFromStackSlot(MachineBasicBlock &MBB,
301                             MachineBasicBlock::iterator MI,
302                             unsigned DestReg, int FrameIndex,
303                             const TargetRegisterClass *RC,
304                             const TargetRegisterInfo *TRI) const override;
305
306   void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
307                        SmallVectorImpl<MachineOperand> &Addr,
308                        const TargetRegisterClass *RC,
309                        MachineInstr::mmo_iterator MMOBegin,
310                        MachineInstr::mmo_iterator MMOEnd,
311                        SmallVectorImpl<MachineInstr*> &NewMIs) const;
312
313   bool expandPostRAPseudo(MachineBasicBlock::iterator MI) const override;
314
315   /// foldMemoryOperand - If this target supports it, fold a load or store of
316   /// the specified stack slot into the specified machine instruction for the
317   /// specified operand(s).  If this is possible, the target should perform the
318   /// folding and return true, otherwise it should return false.  If it folds
319   /// the instruction, it is likely that the MachineInstruction the iterator
320   /// references has been changed.
321   MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
322                                       ArrayRef<unsigned> Ops,
323                                       MachineBasicBlock::iterator InsertPt,
324                                       int FrameIndex) const override;
325
326   /// foldMemoryOperand - Same as the previous version except it allows folding
327   /// of any load and store from / to any address, not just from a specific
328   /// stack slot.
329   MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
330                                       ArrayRef<unsigned> Ops,
331                                       MachineBasicBlock::iterator InsertPt,
332                                       MachineInstr *LoadMI) const override;
333
334   /// canFoldMemoryOperand - Returns true if the specified load / store is
335   /// folding is possible.
336   bool canFoldMemoryOperand(const MachineInstr *,
337                             ArrayRef<unsigned>) const override;
338
339   /// unfoldMemoryOperand - Separate a single instruction which folded a load or
340   /// a store or a load and a store into two or more instruction. If this is
341   /// possible, returns true as well as the new instructions by reference.
342   bool unfoldMemoryOperand(MachineFunction &MF, MachineInstr *MI,
343                          unsigned Reg, bool UnfoldLoad, bool UnfoldStore,
344                          SmallVectorImpl<MachineInstr*> &NewMIs) const override;
345
346   bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
347                            SmallVectorImpl<SDNode*> &NewNodes) const override;
348
349   /// getOpcodeAfterMemoryUnfold - Returns the opcode of the would be new
350   /// instruction after load / store are unfolded from an instruction of the
351   /// specified opcode. It returns zero if the specified unfolding is not
352   /// possible. If LoadRegIndex is non-null, it is filled in with the operand
353   /// index of the operand which will hold the register holding the loaded
354   /// value.
355   unsigned getOpcodeAfterMemoryUnfold(unsigned Opc,
356                               bool UnfoldLoad, bool UnfoldStore,
357                               unsigned *LoadRegIndex = nullptr) const override;
358
359   /// areLoadsFromSameBasePtr - This is used by the pre-regalloc scheduler
360   /// to determine if two loads are loading from the same base address. It
361   /// should only return true if the base pointers are the same and the
362   /// only differences between the two addresses are the offset. It also returns
363   /// the offsets by reference.
364   bool areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2, int64_t &Offset1,
365                                int64_t &Offset2) const override;
366
367   /// shouldScheduleLoadsNear - This is a used by the pre-regalloc scheduler to
368   /// determine (in conjunction with areLoadsFromSameBasePtr) if two loads should
369   /// be scheduled togther. On some targets if two loads are loading from
370   /// addresses in the same cache line, it's better if they are scheduled
371   /// together. This function takes two integers that represent the load offsets
372   /// from the common base address. It returns true if it decides it's desirable
373   /// to schedule the two loads together. "NumLoads" is the number of loads that
374   /// have already been scheduled after Load1.
375   bool shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
376                                int64_t Offset1, int64_t Offset2,
377                                unsigned NumLoads) const override;
378
379   bool shouldScheduleAdjacent(MachineInstr* First,
380                               MachineInstr *Second) const override;
381
382   void getNoopForMachoTarget(MCInst &NopInst) const override;
383
384   bool
385   ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const override;
386
387   /// isSafeToMoveRegClassDefs - Return true if it's safe to move a machine
388   /// instruction that defines the specified register class.
389   bool isSafeToMoveRegClassDefs(const TargetRegisterClass *RC) const override;
390
391   /// isSafeToClobberEFLAGS - Return true if it's safe insert an instruction tha
392   /// would clobber the EFLAGS condition register. Note the result may be
393   /// conservative. If it cannot definitely determine the safety after visiting
394   /// a few instructions in each direction it assumes it's not safe.
395   bool isSafeToClobberEFLAGS(MachineBasicBlock &MBB,
396                              MachineBasicBlock::iterator I) const;
397
398   static bool isX86_64ExtendedReg(const MachineOperand &MO) {
399     if (!MO.isReg()) return false;
400     return X86II::isX86_64ExtendedReg(MO.getReg());
401   }
402
403   /// getGlobalBaseReg - Return a virtual register initialized with the
404   /// the global base register value. Output instructions required to
405   /// initialize the register in the function entry block, if necessary.
406   ///
407   unsigned getGlobalBaseReg(MachineFunction *MF) const;
408
409   std::pair<uint16_t, uint16_t>
410   getExecutionDomain(const MachineInstr *MI) const override;
411
412   void setExecutionDomain(MachineInstr *MI, unsigned Domain) const override;
413
414   unsigned
415     getPartialRegUpdateClearance(const MachineInstr *MI, unsigned OpNum,
416                                  const TargetRegisterInfo *TRI) const override;
417   unsigned getUndefRegClearance(const MachineInstr *MI, unsigned &OpNum,
418                                 const TargetRegisterInfo *TRI) const override;
419   void breakPartialRegDependency(MachineBasicBlock::iterator MI, unsigned OpNum,
420                                  const TargetRegisterInfo *TRI) const override;
421
422   MachineInstr *foldMemoryOperandImpl(MachineFunction &MF, MachineInstr *MI,
423                                       unsigned OpNum,
424                                       ArrayRef<MachineOperand> MOs,
425                                       MachineBasicBlock::iterator InsertPt,
426                                       unsigned Size, unsigned Alignment,
427                                       bool AllowCommute) const;
428
429   void
430   getUnconditionalBranch(MCInst &Branch,
431                          const MCSymbolRefExpr *BranchTarget) const override;
432
433   void getTrap(MCInst &MI) const override;
434
435   unsigned getJumpInstrTableEntryBound() const override;
436
437   bool isHighLatencyDef(int opc) const override;
438
439   bool hasHighOperandLatency(const InstrItineraryData *ItinData,
440                              const MachineRegisterInfo *MRI,
441                              const MachineInstr *DefMI, unsigned DefIdx,
442                              const MachineInstr *UseMI,
443                              unsigned UseIdx) const override;
444
445   
446   bool useMachineCombiner() const override {
447     return true;
448   }
449   
450   /// Return true when there is potentially a faster code sequence
451   /// for an instruction chain ending in <Root>. All potential patterns are
452   /// output in the <Pattern> array.
453   bool hasPattern(
454       MachineInstr &Root,
455       SmallVectorImpl<MachineCombinerPattern::MC_PATTERN> &P) const override;
456   
457   /// When hasPattern() finds a pattern, this function generates the
458   /// instructions that could replace the original code sequence.
459   void genAlternativeCodeSequence(
460           MachineInstr &Root, MachineCombinerPattern::MC_PATTERN P,
461           SmallVectorImpl<MachineInstr *> &InsInstrs,
462           SmallVectorImpl<MachineInstr *> &DelInstrs,
463           DenseMap<unsigned, unsigned> &InstrIdxForVirtReg) const override;
464
465   /// analyzeCompare - For a comparison instruction, return the source registers
466   /// in SrcReg and SrcReg2 if having two register operands, and the value it
467   /// compares against in CmpValue. Return true if the comparison instruction
468   /// can be analyzed.
469   bool analyzeCompare(const MachineInstr *MI, unsigned &SrcReg,
470                       unsigned &SrcReg2, int &CmpMask,
471                       int &CmpValue) const override;
472
473   /// optimizeCompareInstr - Check if there exists an earlier instruction that
474   /// operates on the same source operands and sets flags in the same way as
475   /// Compare; remove Compare if possible.
476   bool optimizeCompareInstr(MachineInstr *CmpInstr, unsigned SrcReg,
477                             unsigned SrcReg2, int CmpMask, int CmpValue,
478                             const MachineRegisterInfo *MRI) const override;
479
480   /// optimizeLoadInstr - Try to remove the load by folding it to a register
481   /// operand at the use. We fold the load instructions if and only if the
482   /// def and use are in the same BB. We only look at one load and see
483   /// whether it can be folded into MI. FoldAsLoadDefReg is the virtual register
484   /// defined by the load we are trying to fold. DefMI returns the machine
485   /// instruction that defines FoldAsLoadDefReg, and the function returns
486   /// the machine instruction generated due to folding.
487   MachineInstr* optimizeLoadInstr(MachineInstr *MI,
488                                   const MachineRegisterInfo *MRI,
489                                   unsigned &FoldAsLoadDefReg,
490                                   MachineInstr *&DefMI) const override;
491
492 private:
493   MachineInstr * convertToThreeAddressWithLEA(unsigned MIOpc,
494                                               MachineFunction::iterator &MFI,
495                                               MachineBasicBlock::iterator &MBBI,
496                                               LiveVariables *LV) const;
497
498   /// isFrameOperand - Return true and the FrameIndex if the specified
499   /// operand and follow operands form a reference to the stack frame.
500   bool isFrameOperand(const MachineInstr *MI, unsigned int Op,
501                       int &FrameIndex) const;
502 };
503
504 } // End llvm namespace
505
506 #endif