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 X86INSTRUCTIONINFO_H
  15 #define X86INSTRUCTIONINFO_H
  16
  17 #include "X86.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 X86TargetMachine;
  28
  29 namespace X86 {
  30   // X86 specific condition code. These correspond to X86_*_COND in
  31   // X86InstrInfo.td. They must be kept in synch.
  32   enum CondCode {
  33     COND_A  = 0,
  34     COND_AE = 1,
  35     COND_B  = 2,
  36     COND_BE = 3,
  37     COND_E  = 4,
  38     COND_G  = 5,
  39     COND_GE = 6,
  40     COND_L  = 7,
  41     COND_LE = 8,
  42     COND_NE = 9,
  43     COND_NO = 10,
  44     COND_NP = 11,
  45     COND_NS = 12,
  46     COND_O  = 13,
  47     COND_P  = 14,
  48     COND_S  = 15,
  49
  50     // Artificial condition codes. These are used by AnalyzeBranch
  51     // to indicate a block terminated with two conditional branches to
  52     // the same location. This occurs in code using FCMP_OEQ or FCMP_UNE,
  53     // which can't be represented on x86 with a single condition. These
  54     // are never used in MachineInstrs.
  55     COND_NE_OR_P,
  56     COND_NP_OR_E,
  57
  58     COND_INVALID
  59   };
  60
  61   // Turn condition code into conditional branch opcode.
  62   unsigned GetCondBranchFromCond(CondCode CC);
  63
  64   // Turn CMov opcode into condition code.
  65   CondCode getCondFromCMovOpc(unsigned Opc);
  66
  67   /// GetOppositeBranchCondition - Return the inverse of the specified cond,
  68   /// e.g. turning COND_E to COND_NE.
  69   CondCode GetOppositeBranchCondition(X86::CondCode CC);
  70 }  // end namespace X86;
  71
  72
  73 /// isGlobalStubReference - Return true if the specified TargetFlag operand is
  74 /// a reference to a stub for a global, not the global itself.
  75 inline static bool isGlobalStubReference(unsigned char TargetFlag) {
  76   switch (TargetFlag) {
  77   case X86II::MO_DLLIMPORT: // dllimport stub.
  78   case X86II::MO_GOTPCREL:  // rip-relative GOT reference.
  79   case X86II::MO_GOT:       // normal GOT reference.
  80   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:        // Normal $non_lazy_ptr ref.
  81   case X86II::MO_DARWIN_NONLAZY:                 // Normal $non_lazy_ptr ref.
  82   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: // Hidden $non_lazy_ptr ref.
  83     return true;
  84   default:
  85     return false;
  86   }
  87 }
  88
  89 /// isGlobalRelativeToPICBase - Return true if the specified global value
  90 /// reference is relative to a 32-bit PIC base (X86ISD::GlobalBaseReg).  If this
  91 /// is true, the addressing mode has the PIC base register added in (e.g. EBX).
  92 inline static bool isGlobalRelativeToPICBase(unsigned char TargetFlag) {
  93   switch (TargetFlag) {
  94   case X86II::MO_GOTOFF:                         // isPICStyleGOT: local global.
  95   case X86II::MO_GOT:                            // isPICStyleGOT: other global.
  96   case X86II::MO_PIC_BASE_OFFSET:                // Darwin local global.
  97   case X86II::MO_DARWIN_NONLAZY_PIC_BASE:        // Darwin/32 external global.
  98   case X86II::MO_DARWIN_HIDDEN_NONLAZY_PIC_BASE: // Darwin/32 hidden global.
  99   case X86II::MO_TLVP:                           // ??? Pretty sure..
 100     return true;
 101   default:
 102     return false;
 103   }
 104 }
 105
 106 inline static bool isScale(const MachineOperand &MO) {
 107   return MO.isImm() &&
 108     (MO.getImm() == 1 || MO.getImm() == 2 ||
 109      MO.getImm() == 4 || MO.getImm() == 8);
 110 }
 111
 112 inline static bool isLeaMem(const MachineInstr *MI, unsigned Op) {
 113   if (MI->getOperand(Op).isFI()) return true;
 114   return Op+4 <= MI->getNumOperands() &&
 115     MI->getOperand(Op  ).isReg() && isScale(MI->getOperand(Op+1)) &&
 116     MI->getOperand(Op+2).isReg() &&
 117     (MI->getOperand(Op+3).isImm() ||
 118      MI->getOperand(Op+3).isGlobal() ||
 119      MI->getOperand(Op+3).isCPI() ||
 120      MI->getOperand(Op+3).isJTI());
 121 }
 122
 123 inline static bool isMem(const MachineInstr *MI, unsigned Op) {
 124   if (MI->getOperand(Op).isFI()) return true;
 125   return Op+5 <= MI->getNumOperands() &&
 126     MI->getOperand(Op+4).isReg() &&
 127     isLeaMem(MI, Op);
 128 }
 129
 130 class X86InstrInfo : public X86GenInstrInfo {
 131   X86TargetMachine &TM;
 132   const X86RegisterInfo RI;
 133
 134   /// RegOp2MemOpTable3Addr, RegOp2MemOpTable0, RegOp2MemOpTable1,
 135   /// RegOp2MemOpTable2, RegOp2MemOpTable3 - Load / store folding opcode maps.
 136   ///
 137   typedef DenseMap<unsigned,
 138                    std::pair<unsigned, unsigned> > RegOp2MemOpTableType;
 139   RegOp2MemOpTableType RegOp2MemOpTable2Addr;
 140   RegOp2MemOpTableType RegOp2MemOpTable0;
 141   RegOp2MemOpTableType RegOp2MemOpTable1;
 142   RegOp2MemOpTableType RegOp2MemOpTable2;
 143   RegOp2MemOpTableType RegOp2MemOpTable3;
 144
 145   /// MemOp2RegOpTable - Load / store unfolding opcode map.
 146   ///
 147   typedef DenseMap<unsigned,
 148                    std::pair<unsigned, unsigned> > MemOp2RegOpTableType;
 149   MemOp2RegOpTableType MemOp2RegOpTable;
 150
 151   static void AddTableEntry(RegOp2MemOpTableType &R2MTable,
 152                             MemOp2RegOpTableType &M2RTable,
 153                             unsigned RegOp, unsigned MemOp, unsigned Flags);
 154
 155   virtual void anchor();
 156
 157 public:
 158   explicit X86InstrInfo(X86TargetMachine &tm);
 159
 160   /// getRegisterInfo - TargetInstrInfo is a superset of MRegister info.  As
 161   /// such, whenever a client has an instance of instruction info, it should
 162   /// always be able to get register info as well (through this method).
 163   ///
 164   const X86RegisterInfo &getRegisterInfo() const { return RI; }
 165
 166   /// isCoalescableExtInstr - Return true if the instruction is a "coalescable"
 167   /// extension instruction. That is, it's like a copy where it's legal for the
 168   /// source to overlap the destination. e.g. X86::MOVSX64rr32. If this returns
 169   /// true, then it's expected the pre-extension value is available as a subreg
 170   /// of the result register. This also returns the sub-register index in
 171   /// SubIdx.
 172   bool isCoalescableExtInstr(const MachineInstr &MI,
 173                              unsigned &SrcReg, unsigned &DstReg,
 174                              unsigned &SubIdx) const override;
 175
 176   unsigned isLoadFromStackSlot(const MachineInstr *MI,
 177                                int &FrameIndex) const override;
 178   /// isLoadFromStackSlotPostFE - Check for post-frame ptr elimination
 179   /// stack locations as well.  This uses a heuristic so it isn't
 180   /// reliable for correctness.
 181   unsigned isLoadFromStackSlotPostFE(const MachineInstr *MI,
 182                                      int &FrameIndex) const override;
 183
 184   unsigned isStoreToStackSlot(const MachineInstr *MI,
 185                               int &FrameIndex) const override;
 186   /// isStoreToStackSlotPostFE - Check for post-frame ptr elimination
 187   /// stack locations as well.  This uses a heuristic so it isn't
 188   /// reliable for correctness.
 189   unsigned isStoreToStackSlotPostFE(const MachineInstr *MI,
 190                                     int &FrameIndex) const override;
 191
 192   bool isReallyTriviallyReMaterializable(const MachineInstr *MI,
 193                                          AliasAnalysis *AA) const override;
 194   void reMaterialize(MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
 195                      unsigned DestReg, unsigned SubIdx,
 196                      const MachineInstr *Orig,
 197                      const TargetRegisterInfo &TRI) const override;
 198
 199   /// Given an operand within a MachineInstr, insert preceding code to put it
 200   /// into the right format for a particular kind of LEA instruction. This may
 201   /// involve using an appropriate super-register instead (with an implicit use
 202   /// of the original) or creating a new virtual register and inserting COPY
 203   /// instructions to get the data into the right class.
 204   ///
 205   /// Reference parameters are set to indicate how caller should add this
 206   /// operand to the LEA instruction.
 207   bool classifyLEAReg(MachineInstr *MI, const MachineOperand &Src,
 208                       unsigned LEAOpcode, bool AllowSP,
 209                       unsigned &NewSrc, bool &isKill,
 210                       bool &isUndef, MachineOperand &ImplicitOp) const;
 211
 212   /// convertToThreeAddress - This method must be implemented by targets that
 213   /// set the M_CONVERTIBLE_TO_3_ADDR flag.  When this flag is set, the target
 214   /// may be able to convert a two-address instruction into a true
 215   /// three-address instruction on demand.  This allows the X86 target (for
 216   /// example) to convert ADD and SHL instructions into LEA instructions if they
 217   /// would require register copies due to two-addressness.
 218   ///
 219   /// This method returns a null pointer if the transformation cannot be
 220   /// performed, otherwise it returns the new instruction.
 221   ///
 222   MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
 223                                       MachineBasicBlock::iterator &MBBI,
 224                                       LiveVariables *LV) const override;
 225
 226   /// commuteInstruction - We have a few instructions that must be hacked on to
 227   /// commute them.
 228   ///
 229   MachineInstr *commuteInstruction(MachineInstr *MI, bool NewMI) const override;
 230
 231   // Branch analysis.
 232   bool isUnpredicatedTerminator(const MachineInstr* MI) const override;
 233   bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
 234                      MachineBasicBlock *&FBB,
 235                      SmallVectorImpl<MachineOperand> &Cond,
 236                      bool AllowModify) const override;
 237   unsigned RemoveBranch(MachineBasicBlock &MBB) const override;
 238   unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
 239                         MachineBasicBlock *FBB,
 240                         const SmallVectorImpl<MachineOperand> &Cond,
 241                         DebugLoc DL) const override;
 242   bool canInsertSelect(const MachineBasicBlock&,
 243                        const SmallVectorImpl<MachineOperand> &Cond,
 244                        unsigned, unsigned, int&, int&, int&) const override;
 245   void insertSelect(MachineBasicBlock &MBB,
 246                     MachineBasicBlock::iterator MI, DebugLoc DL,
 247                     unsigned DstReg,
 248                     const SmallVectorImpl<MachineOperand> &Cond,
 249                     unsigned TrueReg, unsigned FalseReg) const override;
 250   void copyPhysReg(MachineBasicBlock &MBB,
 251                    MachineBasicBlock::iterator MI, DebugLoc DL,
 252                    unsigned DestReg, unsigned SrcReg,
 253                    bool KillSrc) const override;
 254   void storeRegToStackSlot(MachineBasicBlock &MBB,
 255                            MachineBasicBlock::iterator MI,
 256                            unsigned SrcReg, bool isKill, int FrameIndex,
 257                            const TargetRegisterClass *RC,
 258                            const TargetRegisterInfo *TRI) const override;
 259
 260   void storeRegToAddr(MachineFunction &MF, unsigned SrcReg, bool isKill,
 261                       SmallVectorImpl<MachineOperand> &Addr,
 262                       const TargetRegisterClass *RC,
 263                       MachineInstr::mmo_iterator MMOBegin,
 264                       MachineInstr::mmo_iterator MMOEnd,
 265                       SmallVectorImpl<MachineInstr*> &NewMIs) const;
 266
 267   void loadRegFromStackSlot(MachineBasicBlock &MBB,
 268                             MachineBasicBlock::iterator MI,
 269                             unsigned DestReg, int FrameIndex,
 270                             const TargetRegisterClass *RC,
 271                             const TargetRegisterInfo *TRI) const override;
 272
 273   void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
 274                        SmallVectorImpl<MachineOperand> &Addr,
 275                        const TargetRegisterClass *RC,
 276                        MachineInstr::mmo_iterator MMOBegin,
 277                        MachineInstr::mmo_iterator MMOEnd,
 278                        SmallVectorImpl<MachineInstr*> &NewMIs) const;
 279
 280   bool expandPostRAPseudo(MachineBasicBlock::iterator MI) const override;
 281
 282   /// foldMemoryOperand - If this target supports it, fold a load or store of
 283   /// the specified stack slot into the specified machine instruction for the
 284   /// specified operand(s).  If this is possible, the target should perform the
 285   /// folding and return true, otherwise it should return false.  If it folds
 286   /// the instruction, it is likely that the MachineInstruction the iterator
 287   /// references has been changed.
 288   MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 289                                       MachineInstr* MI,
 290                                       const SmallVectorImpl<unsigned> &Ops,
 291                                       int FrameIndex) const override;
 292
 293   /// foldMemoryOperand - Same as the previous version except it allows folding
 294   /// of any load and store from / to any address, not just from a specific
 295   /// stack slot.
 296   MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 297                                       MachineInstr* MI,
 298                                       const SmallVectorImpl<unsigned> &Ops,
 299                                       MachineInstr* LoadMI) const override;
 300
 301   /// canFoldMemoryOperand - Returns true if the specified load / store is
 302   /// folding is possible.
 303   bool canFoldMemoryOperand(const MachineInstr*,
 304                             const SmallVectorImpl<unsigned> &) const override;
 305
 306   /// unfoldMemoryOperand - Separate a single instruction which folded a load or
 307   /// a store or a load and a store into two or more instruction. If this is
 308   /// possible, returns true as well as the new instructions by reference.
 309   bool unfoldMemoryOperand(MachineFunction &MF, MachineInstr *MI,
 310                          unsigned Reg, bool UnfoldLoad, bool UnfoldStore,
 311                          SmallVectorImpl<MachineInstr*> &NewMIs) const override;
 312
 313   bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
 314                            SmallVectorImpl<SDNode*> &NewNodes) const override;
 315
 316   /// getOpcodeAfterMemoryUnfold - Returns the opcode of the would be new
 317   /// instruction after load / store are unfolded from an instruction of the
 318   /// specified opcode. It returns zero if the specified unfolding is not
 319   /// possible. If LoadRegIndex is non-null, it is filled in with the operand
 320   /// index of the operand which will hold the register holding the loaded
 321   /// value.
 322   unsigned getOpcodeAfterMemoryUnfold(unsigned Opc,
 323                               bool UnfoldLoad, bool UnfoldStore,
 324                               unsigned *LoadRegIndex = 0) const override;
 325
 326   /// areLoadsFromSameBasePtr - This is used by the pre-regalloc scheduler
 327   /// to determine if two loads are loading from the same base address. It
 328   /// should only return true if the base pointers are the same and the
 329   /// only differences between the two addresses are the offset. It also returns
 330   /// the offsets by reference.
 331   bool areLoadsFromSameBasePtr(SDNode *Load1, SDNode *Load2, int64_t &Offset1,
 332                                int64_t &Offset2) const override;
 333
 334   /// shouldScheduleLoadsNear - This is a used by the pre-regalloc scheduler to
 335   /// determine (in conjunction with areLoadsFromSameBasePtr) if two loads should
 336   /// be scheduled togther. On some targets if two loads are loading from
 337   /// addresses in the same cache line, it's better if they are scheduled
 338   /// together. This function takes two integers that represent the load offsets
 339   /// from the common base address. It returns true if it decides it's desirable
 340   /// to schedule the two loads together. "NumLoads" is the number of loads that
 341   /// have already been scheduled after Load1.
 342   bool shouldScheduleLoadsNear(SDNode *Load1, SDNode *Load2,
 343                                int64_t Offset1, int64_t Offset2,
 344                                unsigned NumLoads) const override;
 345
 346   bool shouldScheduleAdjacent(MachineInstr* First,
 347                               MachineInstr *Second) const override;
 348
 349   void getNoopForMachoTarget(MCInst &NopInst) const override;
 350
 351   bool
 352   ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const override;
 353
 354   /// isSafeToMoveRegClassDefs - Return true if it's safe to move a machine
 355   /// instruction that defines the specified register class.
 356   bool isSafeToMoveRegClassDefs(const TargetRegisterClass *RC) const override;
 357
 358   static bool isX86_64ExtendedReg(const MachineOperand &MO) {
 359     if (!MO.isReg()) return false;
 360     return X86II::isX86_64ExtendedReg(MO.getReg());
 361   }
 362
 363   /// getGlobalBaseReg - Return a virtual register initialized with the
 364   /// the global base register value. Output instructions required to
 365   /// initialize the register in the function entry block, if necessary.
 366   ///
 367   unsigned getGlobalBaseReg(MachineFunction *MF) const;
 368
 369   std::pair<uint16_t, uint16_t>
 370   getExecutionDomain(const MachineInstr *MI) const override;
 371
 372   void setExecutionDomain(MachineInstr *MI, unsigned Domain) const override;
 373
 374   unsigned
 375     getPartialRegUpdateClearance(const MachineInstr *MI, unsigned OpNum,
 376                                  const TargetRegisterInfo *TRI) const override;
 377   unsigned getUndefRegClearance(const MachineInstr *MI, unsigned &OpNum,
 378                                 const TargetRegisterInfo *TRI) const override;
 379   void breakPartialRegDependency(MachineBasicBlock::iterator MI, unsigned OpNum,
 380                                  const TargetRegisterInfo *TRI) const override;
 381
 382   MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 383                                       MachineInstr* MI,
 384                                       unsigned OpNum,
 385                                       const SmallVectorImpl<MachineOperand> &MOs,
 386                                       unsigned Size, unsigned Alignment) const;
 387
 388   bool isHighLatencyDef(int opc) const override;
 389
 390   bool hasHighOperandLatency(const InstrItineraryData *ItinData,
 391                              const MachineRegisterInfo *MRI,
 392                              const MachineInstr *DefMI, unsigned DefIdx,
 393                              const MachineInstr *UseMI,
 394                              unsigned UseIdx) const override;
 395
 396   /// analyzeCompare - For a comparison instruction, return the source registers
 397   /// in SrcReg and SrcReg2 if having two register operands, and the value it
 398   /// compares against in CmpValue. Return true if the comparison instruction
 399   /// can be analyzed.
 400   bool analyzeCompare(const MachineInstr *MI, unsigned &SrcReg,
 401                       unsigned &SrcReg2, int &CmpMask,
 402                       int &CmpValue) const override;
 403
 404   /// optimizeCompareInstr - Check if there exists an earlier instruction that
 405   /// operates on the same source operands and sets flags in the same way as
 406   /// Compare; remove Compare if possible.
 407   bool optimizeCompareInstr(MachineInstr *CmpInstr, unsigned SrcReg,
 408                             unsigned SrcReg2, int CmpMask, int CmpValue,
 409                             const MachineRegisterInfo *MRI) const override;
 410
 411   /// optimizeLoadInstr - Try to remove the load by folding it to a register
 412   /// operand at the use. We fold the load instructions if and only if the
 413   /// def and use are in the same BB. We only look at one load and see
 414   /// whether it can be folded into MI. FoldAsLoadDefReg is the virtual register
 415   /// defined by the load we are trying to fold. DefMI returns the machine
 416   /// instruction that defines FoldAsLoadDefReg, and the function returns
 417   /// the machine instruction generated due to folding.
 418   MachineInstr* optimizeLoadInstr(MachineInstr *MI,
 419                                   const MachineRegisterInfo *MRI,
 420                                   unsigned &FoldAsLoadDefReg,
 421                                   MachineInstr *&DefMI) const override;
 422
 423 private:
 424   MachineInstr * convertToThreeAddressWithLEA(unsigned MIOpc,
 425                                               MachineFunction::iterator &MFI,
 426                                               MachineBasicBlock::iterator &MBBI,
 427                                               LiveVariables *LV) const;
 428
 429   /// isFrameOperand - Return true and the FrameIndex if the specified
 430   /// operand and follow operands form a reference to the stack frame.
 431   bool isFrameOperand(const MachineInstr *MI, unsigned int Op,
 432                       int &FrameIndex) const;
 433 };
 434
 435 } // End llvm namespace
 436
 437 #endif