lib/Target/ARM/ARMBaseInstrInfo.h

   1 //===- ARMBaseInstrInfo.h - ARM Base 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 Base ARM implementation of the TargetInstrInfo class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef ARMBASEINSTRUCTIONINFO_H
  15 #define ARMBASEINSTRUCTIONINFO_H
  16
  17 #include "ARM.h"
  18 #include "ARMRegisterInfo.h"
  19 #include "llvm/CodeGen/MachineInstrBuilder.h"
  20 #include "llvm/Target/TargetInstrInfo.h"
  21
  22 namespace llvm {
  23   class ARMSubtarget;
  24
  25 /// ARMII - This namespace holds all of the target specific flags that
  26 /// instruction info tracks.
  27 ///
  28 namespace ARMII {
  29   enum {
  30     //===------------------------------------------------------------------===//
  31     // Instruction Flags.
  32
  33     //===------------------------------------------------------------------===//
  34     // This four-bit field describes the addressing mode used.
  35
  36     AddrModeMask  = 0xf,
  37     AddrModeNone    = 0,
  38     AddrMode1       = 1,
  39     AddrMode2       = 2,
  40     AddrMode3       = 3,
  41     AddrMode4       = 4,
  42     AddrMode5       = 5,
  43     AddrMode6       = 6,
  44     AddrModeT1_1    = 7,
  45     AddrModeT1_2    = 8,
  46     AddrModeT1_4    = 9,
  47     AddrModeT1_s    = 10, // i8 * 4 for pc and sp relative data
  48     AddrModeT2_i12  = 11,
  49     AddrModeT2_i8   = 12,
  50     AddrModeT2_so   = 13,
  51     AddrModeT2_pc   = 14, // +/- i12 for pc relative data
  52     AddrModeT2_i8s4 = 15, // i8 * 4
  53
  54     // Size* - Flags to keep track of the size of an instruction.
  55     SizeShift     = 4,
  56     SizeMask      = 7 << SizeShift,
  57     SizeSpecial   = 1,   // 0 byte pseudo or special case.
  58     Size8Bytes    = 2,
  59     Size4Bytes    = 3,
  60     Size2Bytes    = 4,
  61
  62     // IndexMode - Unindex, pre-indexed, or post-indexed. Only valid for load
  63     // and store ops
  64     IndexModeShift = 7,
  65     IndexModeMask  = 3 << IndexModeShift,
  66     IndexModePre   = 1,
  67     IndexModePost  = 2,
  68
  69     //===------------------------------------------------------------------===//
  70     // Instruction encoding formats.
  71     //
  72     FormShift     = 9,
  73     FormMask      = 0x3f << FormShift,
  74
  75     // Pseudo instructions
  76     Pseudo        = 0  << FormShift,
  77
  78     // Multiply instructions
  79     MulFrm        = 1  << FormShift,
  80
  81     // Branch instructions
  82     BrFrm         = 2  << FormShift,
  83     BrMiscFrm     = 3  << FormShift,
  84
  85     // Data Processing instructions
  86     DPFrm         = 4  << FormShift,
  87     DPSoRegFrm    = 5  << FormShift,
  88
  89     // Load and Store
  90     LdFrm         = 6  << FormShift,
  91     StFrm         = 7  << FormShift,
  92     LdMiscFrm     = 8  << FormShift,
  93     StMiscFrm     = 9  << FormShift,
  94     LdStMulFrm    = 10 << FormShift,
  95
  96     // Miscellaneous arithmetic instructions
  97     ArithMiscFrm  = 11 << FormShift,
  98
  99     // Extend instructions
 100     ExtFrm        = 12 << FormShift,
 101
 102     // VFP formats
 103     VFPUnaryFrm   = 13 << FormShift,
 104     VFPBinaryFrm  = 14 << FormShift,
 105     VFPConv1Frm   = 15 << FormShift,
 106     VFPConv2Frm   = 16 << FormShift,
 107     VFPConv3Frm   = 17 << FormShift,
 108     VFPConv4Frm   = 18 << FormShift,
 109     VFPConv5Frm   = 19 << FormShift,
 110     VFPLdStFrm    = 20 << FormShift,
 111     VFPLdStMulFrm = 21 << FormShift,
 112     VFPMiscFrm    = 22 << FormShift,
 113
 114     // Thumb format
 115     ThumbFrm      = 23 << FormShift,
 116
 117     // NEON format
 118     NEONFrm       = 24 << FormShift,
 119     NEONGetLnFrm  = 25 << FormShift,
 120     NEONSetLnFrm  = 26 << FormShift,
 121     NEONDupFrm    = 27 << FormShift,
 122
 123     //===------------------------------------------------------------------===//
 124     // Misc flags.
 125
 126     // UnaryDP - Indicates this is a unary data processing instruction, i.e.
 127     // it doesn't have a Rn operand.
 128     UnaryDP       = 1 << 15,
 129
 130     // Xform16Bit - Indicates this Thumb2 instruction may be transformed into
 131     // a 16-bit Thumb instruction if certain conditions are met.
 132     Xform16Bit    = 1 << 16,
 133
 134     //===------------------------------------------------------------------===//
 135     // Field shifts - such shifts are used to set field while generating
 136     // machine instructions.
 137     M_BitShift     = 5,
 138     ShiftImmShift  = 5,
 139     ShiftShift     = 7,
 140     N_BitShift     = 7,
 141     ImmHiShift     = 8,
 142     SoRotImmShift  = 8,
 143     RegRsShift     = 8,
 144     ExtRotImmShift = 10,
 145     RegRdLoShift   = 12,
 146     RegRdShift     = 12,
 147     RegRdHiShift   = 16,
 148     RegRnShift     = 16,
 149     S_BitShift     = 20,
 150     W_BitShift     = 21,
 151     AM3_I_BitShift = 22,
 152     D_BitShift     = 22,
 153     U_BitShift     = 23,
 154     P_BitShift     = 24,
 155     I_BitShift     = 25,
 156     CondShift      = 28
 157   };
 158 }
 159
 160 class ARMBaseInstrInfo : public TargetInstrInfoImpl {
 161 protected:
 162   // Can be only subclassed.
 163   explicit ARMBaseInstrInfo(const ARMSubtarget &sti);
 164 public:
 165   // Return the non-pre/post incrementing version of 'Opc'. Return 0
 166   // if there is not such an opcode.
 167   virtual unsigned getUnindexedOpcode(unsigned Opc) const =0;
 168
 169   // Return true if the block does not fall through.
 170   virtual bool BlockHasNoFallThrough(const MachineBasicBlock &MBB) const =0;
 171
 172   virtual MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
 173                                               MachineBasicBlock::iterator &MBBI,
 174                                               LiveVariables *LV) const;
 175
 176   virtual const ARMBaseRegisterInfo &getRegisterInfo() const =0;
 177
 178   // Branch analysis.
 179   virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
 180                              MachineBasicBlock *&FBB,
 181                              SmallVectorImpl<MachineOperand> &Cond,
 182                              bool AllowModify) const;
 183   virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const;
 184   virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
 185                                 MachineBasicBlock *FBB,
 186                             const SmallVectorImpl<MachineOperand> &Cond) const;
 187
 188   virtual
 189   bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const;
 190
 191   // Predication support.
 192   bool isPredicated(const MachineInstr *MI) const {
 193     int PIdx = MI->findFirstPredOperandIdx();
 194     return PIdx != -1 && MI->getOperand(PIdx).getImm() != ARMCC::AL;
 195   }
 196
 197   ARMCC::CondCodes getPredicate(const MachineInstr *MI) const {
 198     int PIdx = MI->findFirstPredOperandIdx();
 199     return PIdx != -1 ? (ARMCC::CondCodes)MI->getOperand(PIdx).getImm()
 200                       : ARMCC::AL;
 201   }
 202
 203   virtual
 204   bool PredicateInstruction(MachineInstr *MI,
 205                             const SmallVectorImpl<MachineOperand> &Pred) const;
 206
 207   virtual
 208   bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
 209                          const SmallVectorImpl<MachineOperand> &Pred2) const;
 210
 211   virtual bool DefinesPredicate(MachineInstr *MI,
 212                                 std::vector<MachineOperand> &Pred) const;
 213
 214   /// GetInstSize - Returns the size of the specified MachineInstr.
 215   ///
 216   virtual unsigned GetInstSizeInBytes(const MachineInstr* MI) const;
 217
 218   /// Return true if the instruction is a register to register move and return
 219   /// the source and dest operands and their sub-register indices by reference.
 220   virtual bool isMoveInstr(const MachineInstr &MI,
 221                            unsigned &SrcReg, unsigned &DstReg,
 222                            unsigned &SrcSubIdx, unsigned &DstSubIdx) const;
 223
 224   virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
 225                                        int &FrameIndex) const;
 226   virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
 227                                       int &FrameIndex) const;
 228
 229   virtual bool copyRegToReg(MachineBasicBlock &MBB,
 230                             MachineBasicBlock::iterator I,
 231                             unsigned DestReg, unsigned SrcReg,
 232                             const TargetRegisterClass *DestRC,
 233                             const TargetRegisterClass *SrcRC) const;
 234
 235   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 236                                    MachineBasicBlock::iterator MBBI,
 237                                    unsigned SrcReg, bool isKill, int FrameIndex,
 238                                    const TargetRegisterClass *RC) const;
 239
 240   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 241                                     MachineBasicBlock::iterator MBBI,
 242                                     unsigned DestReg, int FrameIndex,
 243                                     const TargetRegisterClass *RC) const;
 244
 245   virtual bool canFoldMemoryOperand(const MachineInstr *MI,
 246                                     const SmallVectorImpl<unsigned> &Ops) const;
 247
 248   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 249                                               MachineInstr* MI,
 250                                               const SmallVectorImpl<unsigned> &Ops,
 251                                               int FrameIndex) const;
 252
 253   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 254                                               MachineInstr* MI,
 255                                               const SmallVectorImpl<unsigned> &Ops,
 256                                               MachineInstr* LoadMI) const;
 257
 258 };
 259
 260 static inline
 261 const MachineInstrBuilder &AddDefaultPred(const MachineInstrBuilder &MIB) {
 262   return MIB.addImm((int64_t)ARMCC::AL).addReg(0);
 263 }
 264
 265 static inline
 266 const MachineInstrBuilder &AddDefaultCC(const MachineInstrBuilder &MIB) {
 267   return MIB.addReg(0);
 268 }
 269
 270 static inline
 271 const MachineInstrBuilder &AddDefaultT1CC(const MachineInstrBuilder &MIB) {
 272   return MIB.addReg(ARM::CPSR);
 273 }
 274
 275 static inline
 276 bool isUncondBranchOpcode(int Opc) {
 277   return Opc == ARM::B || Opc == ARM::tB || Opc == ARM::t2B;
 278 }
 279
 280 static inline
 281 bool isCondBranchOpcode(int Opc) {
 282   return Opc == ARM::Bcc || Opc == ARM::tBcc || Opc == ARM::t2Bcc;
 283 }
 284
 285 static inline
 286 bool isJumpTableBranchOpcode(int Opc) {
 287   return Opc == ARM::BR_JTr || Opc == ARM::BR_JTm || Opc == ARM::BR_JTadd ||
 288     Opc == ARM::tBR_JTr || Opc == ARM::t2BR_JT;
 289 }
 290
 291 int getMatchingCondBranchOpcode(int Opc);
 292
 293 /// emitARMRegPlusImmediate / emitT2RegPlusImmediate - Emits a series of
 294 /// instructions to materializea destreg = basereg + immediate in ARM / Thumb2
 295 /// code.
 296 void emitARMRegPlusImmediate(MachineBasicBlock &MBB,
 297                              MachineBasicBlock::iterator &MBBI, DebugLoc dl,
 298                              unsigned DestReg, unsigned BaseReg, int NumBytes,
 299                              ARMCC::CondCodes Pred, unsigned PredReg,
 300                              const ARMBaseInstrInfo &TII);
 301
 302 void emitT2RegPlusImmediate(MachineBasicBlock &MBB,
 303                             MachineBasicBlock::iterator &MBBI, DebugLoc dl,
 304                             unsigned DestReg, unsigned BaseReg, int NumBytes,
 305                             ARMCC::CondCodes Pred, unsigned PredReg,
 306                             const ARMBaseInstrInfo &TII);
 307
 308
 309 /// rewriteARMFrameIndex / rewriteT2FrameIndex -
 310 /// Rewrite MI to access 'Offset' bytes from the FP. Return the offset that
 311 /// could not be handled directly in MI.
 312 int rewriteARMFrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
 313                                unsigned FrameReg, int Offset,
 314                                const ARMBaseInstrInfo &TII);
 315
 316 int rewriteT2FrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
 317                         unsigned FrameReg, int Offset,
 318                         const ARMBaseInstrInfo &TII);
 319
 320 } // End llvm namespace
 321
 322 #endif