include/llvm/Target/TargetInstrInfo.h

   1 //===-- llvm/Target/TargetInstrInfo.h - Instruction Info --------*- 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 describes the target machine instruction set to the code generator.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TARGET_TARGETINSTRINFO_H
  15 #define LLVM_TARGET_TARGETINSTRINFO_H
  16
  17 #include "llvm/Target/TargetInstrDesc.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19
  20 namespace llvm {
  21
  22 class MCAsmInfo;
  23 class TargetRegisterClass;
  24 class TargetRegisterInfo;
  25 class LiveVariables;
  26 class CalleeSavedInfo;
  27 class SDNode;
  28 class SelectionDAG;
  29
  30 template<class T> class SmallVectorImpl;
  31
  32
  33 //---------------------------------------------------------------------------
  34 ///
  35 /// TargetInstrInfo - Interface to description of machine instruction set
  36 ///
  37 class TargetInstrInfo {
  38   const TargetInstrDesc *Descriptors; // Raw array to allow static init'n
  39   unsigned NumOpcodes;                // Number of entries in the desc array
  40
  41   TargetInstrInfo(const TargetInstrInfo &);  // DO NOT IMPLEMENT
  42   void operator=(const TargetInstrInfo &);   // DO NOT IMPLEMENT
  43 public:
  44   TargetInstrInfo(const TargetInstrDesc *desc, unsigned NumOpcodes);
  45   virtual ~TargetInstrInfo();
  46
  47   // Invariant opcodes: All instruction sets have these as their low opcodes.
  48   enum {
  49     PHI = 0,
  50     INLINEASM = 1,
  51     DBG_LABEL = 2,
  52     EH_LABEL = 3,
  53     GC_LABEL = 4,
  54
  55     /// KILL - This instruction is a noop that is used only to adjust the liveness
  56     /// of registers. This can be useful when dealing with sub-registers.
  57     KILL = 5,
  58
  59     /// EXTRACT_SUBREG - This instruction takes two operands: a register
  60     /// that has subregisters, and a subregister index. It returns the
  61     /// extracted subregister value. This is commonly used to implement
  62     /// truncation operations on target architectures which support it.
  63     EXTRACT_SUBREG = 6,
  64
  65     /// INSERT_SUBREG - This instruction takes three operands: a register
  66     /// that has subregisters, a register providing an insert value, and a
  67     /// subregister index. It returns the value of the first register with
  68     /// the value of the second register inserted. The first register is
  69     /// often defined by an IMPLICIT_DEF, as is commonly used to implement
  70     /// anyext operations on target architectures which support it.
  71     INSERT_SUBREG = 7,
  72
  73     /// IMPLICIT_DEF - This is the MachineInstr-level equivalent of undef.
  74     IMPLICIT_DEF = 8,
  75
  76     /// SUBREG_TO_REG - This instruction is similar to INSERT_SUBREG except
  77     /// that the first operand is an immediate integer constant. This constant
  78     /// is often zero, as is commonly used to implement zext operations on
  79     /// target architectures which support it, such as with x86-64 (with
  80     /// zext from i32 to i64 via implicit zero-extension).
  81     SUBREG_TO_REG = 9,
  82
  83     /// COPY_TO_REGCLASS - This instruction is a placeholder for a plain
  84     /// register-to-register copy into a specific register class. This is only
  85     /// used between instruction selection and MachineInstr creation, before
  86     /// virtual registers have been created for all the instructions, and it's
  87     /// only needed in cases where the register classes implied by the
  88     /// instructions are insufficient. The actual MachineInstrs to perform
  89     /// the copy are emitted with the TargetInstrInfo::copyRegToReg hook.
  90     COPY_TO_REGCLASS = 10
  91   };
  92
  93   unsigned getNumOpcodes() const { return NumOpcodes; }
  94
  95   /// get - Return the machine instruction descriptor that corresponds to the
  96   /// specified instruction opcode.
  97   ///
  98   const TargetInstrDesc &get(unsigned Opcode) const {
  99     assert(Opcode < NumOpcodes && "Invalid opcode!");
 100     return Descriptors[Opcode];
 101   }
 102
 103   /// isTriviallyReMaterializable - Return true if the instruction is trivially
 104   /// rematerializable, meaning it has no side effects and requires no operands
 105   /// that aren't always available.
 106   bool isTriviallyReMaterializable(const MachineInstr *MI) const {
 107     return MI->getDesc().isRematerializable() &&
 108            isReallyTriviallyReMaterializable(MI);
 109   }
 110
 111 protected:
 112   /// isReallyTriviallyReMaterializable - For instructions with opcodes for
 113   /// which the M_REMATERIALIZABLE flag is set, this function tests whether the
 114   /// instruction itself is actually trivially rematerializable, considering
 115   /// its operands.  This is used for targets that have instructions that are
 116   /// only trivially rematerializable for specific uses.  This predicate must
 117   /// return false if the instruction has any side effects other than
 118   /// producing a value, or if it requres any address registers that are not
 119   /// always available.
 120   virtual bool isReallyTriviallyReMaterializable(const MachineInstr *MI) const {
 121     return true;
 122   }
 123
 124 public:
 125   /// Return true if the instruction is a register to register move and return
 126   /// the source and dest operands and their sub-register indices by reference.
 127   virtual bool isMoveInstr(const MachineInstr& MI,
 128                            unsigned& SrcReg, unsigned& DstReg,
 129                            unsigned& SrcSubIdx, unsigned& DstSubIdx) const {
 130     return false;
 131   }
 132
 133   /// isLoadFromStackSlot - If the specified machine instruction is a direct
 134   /// load from a stack slot, return the virtual or physical register number of
 135   /// the destination along with the FrameIndex of the loaded stack slot.  If
 136   /// not, return 0.  This predicate must return 0 if the instruction has
 137   /// any side effects other than loading from the stack slot.
 138   virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
 139                                        int &FrameIndex) const {
 140     return 0;
 141   }
 142
 143   /// isStoreToStackSlot - If the specified machine instruction is a direct
 144   /// store to a stack slot, return the virtual or physical register number of
 145   /// the source reg along with the FrameIndex of the loaded stack slot.  If
 146   /// not, return 0.  This predicate must return 0 if the instruction has
 147   /// any side effects other than storing to the stack slot.
 148   virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
 149                                       int &FrameIndex) const {
 150     return 0;
 151   }
 152
 153   /// reMaterialize - Re-issue the specified 'original' instruction at the
 154   /// specific location targeting a new destination register.
 155   virtual void reMaterialize(MachineBasicBlock &MBB,
 156                              MachineBasicBlock::iterator MI,
 157                              unsigned DestReg, unsigned SubIdx,
 158                              const MachineInstr *Orig) const = 0;
 159
 160   /// isInvariantLoad - Return true if the specified instruction (which is
 161   /// marked mayLoad) is loading from a location whose value is invariant across
 162   /// the function.  For example, loading a value from the constant pool or from
 163   /// from the argument area of a function if it does not change.  This should
 164   /// only return true of *all* loads the instruction does are invariant (if it
 165   /// does multiple loads).
 166   virtual bool isInvariantLoad(const MachineInstr *MI) const {
 167     return false;
 168   }
 169
 170   /// convertToThreeAddress - This method must be implemented by targets that
 171   /// set the M_CONVERTIBLE_TO_3_ADDR flag.  When this flag is set, the target
 172   /// may be able to convert a two-address instruction into one or more true
 173   /// three-address instructions on demand.  This allows the X86 target (for
 174   /// example) to convert ADD and SHL instructions into LEA instructions if they
 175   /// would require register copies due to two-addressness.
 176   ///
 177   /// This method returns a null pointer if the transformation cannot be
 178   /// performed, otherwise it returns the last new instruction.
 179   ///
 180   virtual MachineInstr *
 181   convertToThreeAddress(MachineFunction::iterator &MFI,
 182                    MachineBasicBlock::iterator &MBBI, LiveVariables *LV) const {
 183     return 0;
 184   }
 185
 186   /// commuteInstruction - If a target has any instructions that are commutable,
 187   /// but require converting to a different instruction or making non-trivial
 188   /// changes to commute them, this method can overloaded to do this.  The
 189   /// default implementation of this method simply swaps the first two operands
 190   /// of MI and returns it.
 191   ///
 192   /// If a target wants to make more aggressive changes, they can construct and
 193   /// return a new machine instruction.  If an instruction cannot commute, it
 194   /// can also return null.
 195   ///
 196   /// If NewMI is true, then a new machine instruction must be created.
 197   ///
 198   virtual MachineInstr *commuteInstruction(MachineInstr *MI,
 199                                            bool NewMI = false) const = 0;
 200
 201   /// findCommutedOpIndices - If specified MI is commutable, return the two
 202   /// operand indices that would swap value. Return true if the instruction
 203   /// is not in a form which this routine understands.
 204   virtual bool findCommutedOpIndices(MachineInstr *MI, unsigned &SrcOpIdx1,
 205                                      unsigned &SrcOpIdx2) const = 0;
 206
 207   /// AnalyzeBranch - Analyze the branching code at the end of MBB, returning
 208   /// true if it cannot be understood (e.g. it's a switch dispatch or isn't
 209   /// implemented for a target).  Upon success, this returns false and returns
 210   /// with the following information in various cases:
 211   ///
 212   /// 1. If this block ends with no branches (it just falls through to its succ)
 213   ///    just return false, leaving TBB/FBB null.
 214   /// 2. If this block ends with only an unconditional branch, it sets TBB to be
 215   ///    the destination block.
 216   /// 3. If this block ends with an conditional branch and it falls through to
 217   ///    a successor block, it sets TBB to be the branch destination block and
 218   ///    a list of operands that evaluate the condition. These
 219   ///    operands can be passed to other TargetInstrInfo methods to create new
 220   ///    branches.
 221   /// 4. If this block ends with a conditional branch followed by an
 222   ///    unconditional branch, it returns the 'true' destination in TBB, the
 223   ///    'false' destination in FBB, and a list of operands that evaluate the
 224   ///    condition.  These operands can be passed to other TargetInstrInfo
 225   ///    methods to create new branches.
 226   ///
 227   /// Note that RemoveBranch and InsertBranch must be implemented to support
 228   /// cases where this method returns success.
 229   ///
 230   /// If AllowModify is true, then this routine is allowed to modify the basic
 231   /// block (e.g. delete instructions after the unconditional branch).
 232   ///
 233   virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
 234                              MachineBasicBlock *&FBB,
 235                              SmallVectorImpl<MachineOperand> &Cond,
 236                              bool AllowModify = false) const {
 237     return true;
 238   }
 239
 240   /// RemoveBranch - Remove the branching code at the end of the specific MBB.
 241   /// This is only invoked in cases where AnalyzeBranch returns success. It
 242   /// returns the number of instructions that were removed.
 243   virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const {
 244     assert(0 && "Target didn't implement TargetInstrInfo::RemoveBranch!");
 245     return 0;
 246   }
 247
 248   /// InsertBranch - Insert branch code into the end of the specified
 249   /// MachineBasicBlock.  The operands to this method are the same as those
 250   /// returned by AnalyzeBranch.  This is only invoked in cases where
 251   /// AnalyzeBranch returns success. It returns the number of instructions
 252   /// inserted.
 253   ///
 254   /// It is also invoked by tail merging to add unconditional branches in
 255   /// cases where AnalyzeBranch doesn't apply because there was no original
 256   /// branch to analyze.  At least this much must be implemented, else tail
 257   /// merging needs to be disabled.
 258   virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
 259                             MachineBasicBlock *FBB,
 260                             const SmallVectorImpl<MachineOperand> &Cond) const {
 261     assert(0 && "Target didn't implement TargetInstrInfo::InsertBranch!");
 262     return 0;
 263   }
 264
 265   /// copyRegToReg - Emit instructions to copy between a pair of registers. It
 266   /// returns false if the target does not how to copy between the specified
 267   /// registers.
 268   virtual bool copyRegToReg(MachineBasicBlock &MBB,
 269                             MachineBasicBlock::iterator MI,
 270                             unsigned DestReg, unsigned SrcReg,
 271                             const TargetRegisterClass *DestRC,
 272                             const TargetRegisterClass *SrcRC) const {
 273     assert(0 && "Target didn't implement TargetInstrInfo::copyRegToReg!");
 274     return false;
 275   }
 276
 277   /// storeRegToStackSlot - Store the specified register of the given register
 278   /// class to the specified stack frame index. The store instruction is to be
 279   /// added to the given machine basic block before the specified machine
 280   /// instruction. If isKill is true, the register operand is the last use and
 281   /// must be marked kill.
 282   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 283                                    MachineBasicBlock::iterator MI,
 284                                    unsigned SrcReg, bool isKill, int FrameIndex,
 285                                    const TargetRegisterClass *RC) const {
 286     assert(0 && "Target didn't implement TargetInstrInfo::storeRegToStackSlot!");
 287   }
 288
 289   /// loadRegFromStackSlot - Load the specified register of the given register
 290   /// class from the specified stack frame index. The load instruction is to be
 291   /// added to the given machine basic block before the specified machine
 292   /// instruction.
 293   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 294                                     MachineBasicBlock::iterator MI,
 295                                     unsigned DestReg, int FrameIndex,
 296                                     const TargetRegisterClass *RC) const {
 297     assert(0 && "Target didn't implement TargetInstrInfo::loadRegFromStackSlot!");
 298   }
 299
 300   /// spillCalleeSavedRegisters - Issues instruction(s) to spill all callee
 301   /// saved registers and returns true if it isn't possible / profitable to do
 302   /// so by issuing a series of store instructions via
 303   /// storeRegToStackSlot(). Returns false otherwise.
 304   virtual bool spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 305                                          MachineBasicBlock::iterator MI,
 306                                 const std::vector<CalleeSavedInfo> &CSI) const {
 307     return false;
 308   }
 309
 310   /// restoreCalleeSavedRegisters - Issues instruction(s) to restore all callee
 311   /// saved registers and returns true if it isn't possible / profitable to do
 312   /// so by issuing a series of load instructions via loadRegToStackSlot().
 313   /// Returns false otherwise.
 314   virtual bool restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 315                                            MachineBasicBlock::iterator MI,
 316                                 const std::vector<CalleeSavedInfo> &CSI) const {
 317     return false;
 318   }
 319
 320   /// foldMemoryOperand - Attempt to fold a load or store of the specified stack
 321   /// slot into the specified machine instruction for the specified operand(s).
 322   /// If this is possible, a new instruction is returned with the specified
 323   /// operand folded, otherwise NULL is returned. The client is responsible for
 324   /// removing the old instruction and adding the new one in the instruction
 325   /// stream.
 326   MachineInstr* foldMemoryOperand(MachineFunction &MF,
 327                                   MachineInstr* MI,
 328                                   const SmallVectorImpl<unsigned> &Ops,
 329                                   int FrameIndex) const;
 330
 331   /// foldMemoryOperand - Same as the previous version except it allows folding
 332   /// of any load and store from / to any address, not just from a specific
 333   /// stack slot.
 334   MachineInstr* foldMemoryOperand(MachineFunction &MF,
 335                                   MachineInstr* MI,
 336                                   const SmallVectorImpl<unsigned> &Ops,
 337                                   MachineInstr* LoadMI) const;
 338
 339 protected:
 340   /// foldMemoryOperandImpl - Target-dependent implementation for
 341   /// foldMemoryOperand. Target-independent code in foldMemoryOperand will
 342   /// take care of adding a MachineMemOperand to the newly created instruction.
 343   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 344                                           MachineInstr* MI,
 345                                           const SmallVectorImpl<unsigned> &Ops,
 346                                           int FrameIndex) const {
 347     return 0;
 348   }
 349
 350   /// foldMemoryOperandImpl - Target-dependent implementation for
 351   /// foldMemoryOperand. Target-independent code in foldMemoryOperand will
 352   /// take care of adding a MachineMemOperand to the newly created instruction.
 353   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 354                                               MachineInstr* MI,
 355                                               const SmallVectorImpl<unsigned> &Ops,
 356                                               MachineInstr* LoadMI) const {
 357     return 0;
 358   }
 359
 360 public:
 361   /// canFoldMemoryOperand - Returns true for the specified load / store if
 362   /// folding is possible.
 363   virtual
 364   bool canFoldMemoryOperand(const MachineInstr *MI,
 365                             const SmallVectorImpl<unsigned> &Ops) const {
 366     return false;
 367   }
 368
 369   /// unfoldMemoryOperand - Separate a single instruction which folded a load or
 370   /// a store or a load and a store into two or more instruction. If this is
 371   /// possible, returns true as well as the new instructions by reference.
 372   virtual bool unfoldMemoryOperand(MachineFunction &MF, MachineInstr *MI,
 373                                 unsigned Reg, bool UnfoldLoad, bool UnfoldStore,
 374                                  SmallVectorImpl<MachineInstr*> &NewMIs) const{
 375     return false;
 376   }
 377
 378   virtual bool unfoldMemoryOperand(SelectionDAG &DAG, SDNode *N,
 379                                    SmallVectorImpl<SDNode*> &NewNodes) const {
 380     return false;
 381   }
 382
 383   /// getOpcodeAfterMemoryUnfold - Returns the opcode of the would be new
 384   /// instruction after load / store are unfolded from an instruction of the
 385   /// specified opcode. It returns zero if the specified unfolding is not
 386   /// possible.
 387   virtual unsigned getOpcodeAfterMemoryUnfold(unsigned Opc,
 388                                       bool UnfoldLoad, bool UnfoldStore) const {
 389     return 0;
 390   }
 391
 392   /// BlockHasNoFallThrough - Return true if the specified block does not
 393   /// fall-through into its successor block.  This is primarily used when a
 394   /// branch is unanalyzable.  It is useful for things like unconditional
 395   /// indirect branches (jump tables).
 396   virtual bool BlockHasNoFallThrough(const MachineBasicBlock &MBB) const {
 397     return false;
 398   }
 399
 400   /// ReverseBranchCondition - Reverses the branch condition of the specified
 401   /// condition list, returning false on success and true if it cannot be
 402   /// reversed.
 403   virtual
 404   bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const {
 405     return true;
 406   }
 407
 408   /// insertNoop - Insert a noop into the instruction stream at the specified
 409   /// point.
 410   virtual void insertNoop(MachineBasicBlock &MBB,
 411                           MachineBasicBlock::iterator MI) const;
 412
 413   /// isPredicated - Returns true if the instruction is already predicated.
 414   ///
 415   virtual bool isPredicated(const MachineInstr *MI) const {
 416     return false;
 417   }
 418
 419   /// isUnpredicatedTerminator - Returns true if the instruction is a
 420   /// terminator instruction that has not been predicated.
 421   virtual bool isUnpredicatedTerminator(const MachineInstr *MI) const;
 422
 423   /// PredicateInstruction - Convert the instruction into a predicated
 424   /// instruction. It returns true if the operation was successful.
 425   virtual
 426   bool PredicateInstruction(MachineInstr *MI,
 427                         const SmallVectorImpl<MachineOperand> &Pred) const = 0;
 428
 429   /// SubsumesPredicate - Returns true if the first specified predicate
 430   /// subsumes the second, e.g. GE subsumes GT.
 431   virtual
 432   bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
 433                          const SmallVectorImpl<MachineOperand> &Pred2) const {
 434     return false;
 435   }
 436
 437   /// DefinesPredicate - If the specified instruction defines any predicate
 438   /// or condition code register(s) used for predication, returns true as well
 439   /// as the definition predicate(s) by reference.
 440   virtual bool DefinesPredicate(MachineInstr *MI,
 441                                 std::vector<MachineOperand> &Pred) const {
 442     return false;
 443   }
 444
 445   /// isSafeToMoveRegClassDefs - Return true if it's safe to move a machine
 446   /// instruction that defines the specified register class.
 447   virtual bool isSafeToMoveRegClassDefs(const TargetRegisterClass *RC) const {
 448     return true;
 449   }
 450
 451   /// isDeadInstruction - Return true if the instruction is considered dead.
 452   /// This allows some late codegen passes to delete them.
 453   virtual bool isDeadInstruction(const MachineInstr *MI) const = 0;
 454
 455   /// GetInstSize - Returns the size of the specified Instruction.
 456   ///
 457   virtual unsigned GetInstSizeInBytes(const MachineInstr *MI) const {
 458     assert(0 && "Target didn't implement TargetInstrInfo::GetInstSize!");
 459     return 0;
 460   }
 461
 462   /// GetFunctionSizeInBytes - Returns the size of the specified
 463   /// MachineFunction.
 464   ///
 465   virtual unsigned GetFunctionSizeInBytes(const MachineFunction &MF) const = 0;
 466
 467   /// Measure the specified inline asm to determine an approximation of its
 468   /// length.
 469   virtual unsigned getInlineAsmLength(const char *Str,
 470                                       const MCAsmInfo &MAI) const;
 471 };
 472
 473 /// TargetInstrInfoImpl - This is the default implementation of
 474 /// TargetInstrInfo, which just provides a couple of default implementations
 475 /// for various methods.  This separated out because it is implemented in
 476 /// libcodegen, not in libtarget.
 477 class TargetInstrInfoImpl : public TargetInstrInfo {
 478 protected:
 479   TargetInstrInfoImpl(const TargetInstrDesc *desc, unsigned NumOpcodes)
 480   : TargetInstrInfo(desc, NumOpcodes) {}
 481 public:
 482   virtual MachineInstr *commuteInstruction(MachineInstr *MI,
 483                                            bool NewMI = false) const;
 484   virtual bool findCommutedOpIndices(MachineInstr *MI, unsigned &SrcOpIdx1,
 485                                      unsigned &SrcOpIdx2) const;
 486   virtual bool PredicateInstruction(MachineInstr *MI,
 487                             const SmallVectorImpl<MachineOperand> &Pred) const;
 488   virtual void reMaterialize(MachineBasicBlock &MBB,
 489                              MachineBasicBlock::iterator MI,
 490                              unsigned DestReg, unsigned SubReg,
 491                              const MachineInstr *Orig) const;
 492   virtual bool isDeadInstruction(const MachineInstr *MI) const;
 493
 494   virtual unsigned GetFunctionSizeInBytes(const MachineFunction &MF) const;
 495 };
 496
 497 } // End llvm namespace
 498
 499 #endif