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   /// ARMII::Op - Holds all of the instruction types required by
 160   /// target specific instruction and register code.  ARMBaseInstrInfo
 161   /// and subclasses should return a specific opcode that implements
 162   /// the instruction type.
 163   ///
 164   enum Op {
 165     ADDri,
 166     ADDrs,
 167     ADDrr,
 168     B,
 169     Bcc,
 170     BR_JTr,
 171     BR_JTm,
 172     BR_JTadd,
 173     BX_RET,
 174     LDRrr,
 175     LDRri,
 176     MOVr,
 177     STRrr,
 178     STRri,
 179     SUBri,
 180     SUBrs,
 181     SUBrr
 182   };
 183 }
 184
 185 static inline
 186 const MachineInstrBuilder &AddDefaultPred(const MachineInstrBuilder &MIB) {
 187   return MIB.addImm((int64_t)ARMCC::AL).addReg(0);
 188 }
 189
 190 static inline
 191 const MachineInstrBuilder &AddDefaultCC(const MachineInstrBuilder &MIB) {
 192   return MIB.addReg(0);
 193 }
 194
 195 static inline
 196 const MachineInstrBuilder &AddDefaultT1CC(const MachineInstrBuilder &MIB) {
 197   return MIB.addReg(ARM::CPSR);
 198 }
 199
 200 class ARMBaseInstrInfo : public TargetInstrInfoImpl {
 201 protected:
 202   // Can be only subclassed.
 203   explicit ARMBaseInstrInfo(const ARMSubtarget &STI);
 204 public:
 205   // Return the non-pre/post incrementing version of 'Opc'. Return 0
 206   // if there is not such an opcode.
 207   virtual unsigned getUnindexedOpcode(unsigned Opc) const =0;
 208
 209   // Return the opcode that implements 'Op', or 0 if no opcode
 210   virtual unsigned getOpcode(ARMII::Op Op) const =0;
 211
 212   // Return true if the block does not fall through.
 213   virtual bool BlockHasNoFallThrough(const MachineBasicBlock &MBB) const =0;
 214
 215   virtual MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
 216                                               MachineBasicBlock::iterator &MBBI,
 217                                               LiveVariables *LV) const;
 218
 219   virtual const ARMBaseRegisterInfo &getRegisterInfo() const =0;
 220
 221   // Branch analysis.
 222   virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
 223                              MachineBasicBlock *&FBB,
 224                              SmallVectorImpl<MachineOperand> &Cond,
 225                              bool AllowModify) const;
 226   virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const;
 227   virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
 228                                 MachineBasicBlock *FBB,
 229                             const SmallVectorImpl<MachineOperand> &Cond) const;
 230
 231   virtual
 232   bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const;
 233
 234   // Predication support.
 235   bool isPredicated(const MachineInstr *MI) const {
 236     int PIdx = MI->findFirstPredOperandIdx();
 237     return PIdx != -1 && MI->getOperand(PIdx).getImm() != ARMCC::AL;
 238   }
 239
 240   ARMCC::CondCodes getPredicate(const MachineInstr *MI) const {
 241     int PIdx = MI->findFirstPredOperandIdx();
 242     return PIdx != -1 ? (ARMCC::CondCodes)MI->getOperand(PIdx).getImm()
 243                       : ARMCC::AL;
 244   }
 245
 246   virtual
 247   bool PredicateInstruction(MachineInstr *MI,
 248                             const SmallVectorImpl<MachineOperand> &Pred) const;
 249
 250   virtual
 251   bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
 252                          const SmallVectorImpl<MachineOperand> &Pred2) const;
 253
 254   virtual bool DefinesPredicate(MachineInstr *MI,
 255                                 std::vector<MachineOperand> &Pred) const;
 256
 257   /// GetInstSize - Returns the size of the specified MachineInstr.
 258   ///
 259   virtual unsigned GetInstSizeInBytes(const MachineInstr* MI) const;
 260
 261   /// Return true if the instruction is a register to register move and return
 262   /// the source and dest operands and their sub-register indices by reference.
 263   virtual bool isMoveInstr(const MachineInstr &MI,
 264                            unsigned &SrcReg, unsigned &DstReg,
 265                            unsigned &SrcSubIdx, unsigned &DstSubIdx) const;
 266
 267   virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
 268                                        int &FrameIndex) const;
 269   virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
 270                                       int &FrameIndex) const;
 271
 272   virtual bool copyRegToReg(MachineBasicBlock &MBB,
 273                             MachineBasicBlock::iterator I,
 274                             unsigned DestReg, unsigned SrcReg,
 275                             const TargetRegisterClass *DestRC,
 276                             const TargetRegisterClass *SrcRC) const;
 277   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
 278                                    MachineBasicBlock::iterator MBBI,
 279                                    unsigned SrcReg, bool isKill, int FrameIndex,
 280                                    const TargetRegisterClass *RC) const;
 281
 282   virtual void storeRegToAddr(MachineFunction &MF, unsigned SrcReg, bool isKill,
 283                               SmallVectorImpl<MachineOperand> &Addr,
 284                               const TargetRegisterClass *RC,
 285                               SmallVectorImpl<MachineInstr*> &NewMIs) const;
 286
 287   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
 288                                     MachineBasicBlock::iterator MBBI,
 289                                     unsigned DestReg, int FrameIndex,
 290                                     const TargetRegisterClass *RC) const;
 291
 292   virtual void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
 293                                SmallVectorImpl<MachineOperand> &Addr,
 294                                const TargetRegisterClass *RC,
 295                                SmallVectorImpl<MachineInstr*> &NewMIs) const;
 296
 297   virtual bool canFoldMemoryOperand(const MachineInstr *MI,
 298                                     const SmallVectorImpl<unsigned> &Ops) const;
 299
 300   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 301                                               MachineInstr* MI,
 302                                               const SmallVectorImpl<unsigned> &Ops,
 303                                               int FrameIndex) const;
 304
 305   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
 306                                               MachineInstr* MI,
 307                                               const SmallVectorImpl<unsigned> &Ops,
 308                                               MachineInstr* LoadMI) const;
 309 };
 310 }
 311
 312 #endif