ARMBaseInstrInfo.h revision 34dcc6fadca0a1117cdbd0e9b35c991a55b6e556 
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
22namespace llvm {
23
24/// ARMII - This namespace holds all of the target specific flags that
25/// instruction info tracks.
26///
27namespace ARMII {
28  enum {
29    //===------------------------------------------------------------------===//
30    // Instruction Flags.
31
32    //===------------------------------------------------------------------===//
33    // This four-bit field describes the addressing mode used.
34
35    AddrModeMask  = 0xf,
36    AddrModeNone    = 0,
37    AddrMode1       = 1,
38    AddrMode2       = 2,
39    AddrMode3       = 3,
40    AddrMode4       = 4,
41    AddrMode5       = 5,
42    AddrMode6       = 6,
43    AddrModeT1_1    = 7,
44    AddrModeT1_2    = 8,
45    AddrModeT1_4    = 9,
46    AddrModeT1_s    = 10, // i8 * 4 for pc and sp relative data
47    AddrModeT2_i12  = 11,
48    AddrModeT2_i8   = 12,
49    AddrModeT2_so   = 13,
50    AddrModeT2_pc   = 14, // +/- i12 for pc relative data
51    AddrModeT2_i8s4 = 15, // i8 * 4
52
53    // Size* - Flags to keep track of the size of an instruction.
54    SizeShift     = 4,
55    SizeMask      = 7 << SizeShift,
56    SizeSpecial   = 1,   // 0 byte pseudo or special case.
57    Size8Bytes    = 2,
58    Size4Bytes    = 3,
59    Size2Bytes    = 4,
60
61    // IndexMode - Unindex, pre-indexed, or post-indexed are valid for load
62    // and store ops only.  Generic "updating" flag is used for ld/st multiple.
63    IndexModeShift = 7,
64    IndexModeMask  = 3 << IndexModeShift,
65    IndexModePre   = 1,
66    IndexModePost  = 2,
67    IndexModeUpd   = 3,
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    LdStExFrm     = 11 << FormShift,
97
98    // Miscellaneous arithmetic instructions
99    ArithMiscFrm  = 12 << FormShift,
100
101    // Extend instructions
102    ExtFrm        = 13 << FormShift,
103
104    // VFP formats
105    VFPUnaryFrm   = 14 << FormShift,
106    VFPBinaryFrm  = 15 << FormShift,
107    VFPConv1Frm   = 16 << FormShift,
108    VFPConv2Frm   = 17 << FormShift,
109    VFPConv3Frm   = 18 << FormShift,
110    VFPConv4Frm   = 19 << FormShift,
111    VFPConv5Frm   = 20 << FormShift,
112    VFPLdStFrm    = 21 << FormShift,
113    VFPLdStMulFrm = 22 << FormShift,
114    VFPMiscFrm    = 23 << FormShift,
115
116    // Thumb format
117    ThumbFrm      = 24 << FormShift,
118
119    // NEON format
120    NEONFrm       = 25 << FormShift,
121    NEONGetLnFrm  = 26 << FormShift,
122    NEONSetLnFrm  = 27 << FormShift,
123    NEONDupFrm    = 28 << FormShift,
124
125    //===------------------------------------------------------------------===//
126    // Misc flags.
127
128    // UnaryDP - Indicates this is a unary data processing instruction, i.e.
129    // it doesn't have a Rn operand.
130    UnaryDP       = 1 << 15,
131
132    // Xform16Bit - Indicates this Thumb2 instruction may be transformed into
133    // a 16-bit Thumb instruction if certain conditions are met.
134    Xform16Bit    = 1 << 16,
135
136    //===------------------------------------------------------------------===//
137    // Code domain.
138    DomainShift   = 17,
139    DomainMask    = 3 << DomainShift,
140    DomainGeneral = 0 << DomainShift,
141    DomainVFP     = 1 << DomainShift,
142    DomainNEON    = 2 << DomainShift,
143
144    //===------------------------------------------------------------------===//
145    // Field shifts - such shifts are used to set field while generating
146    // machine instructions.
147    M_BitShift     = 5,
148    ShiftImmShift  = 5,
149    ShiftShift     = 7,
150    N_BitShift     = 7,
151    ImmHiShift     = 8,
152    SoRotImmShift  = 8,
153    RegRsShift     = 8,
154    ExtRotImmShift = 10,
155    RegRdLoShift   = 12,
156    RegRdShift     = 12,
157    RegRdHiShift   = 16,
158    RegRnShift     = 16,
159    S_BitShift     = 20,
160    W_BitShift     = 21,
161    AM3_I_BitShift = 22,
162    D_BitShift     = 22,
163    U_BitShift     = 23,
164    P_BitShift     = 24,
165    I_BitShift     = 25,
166    CondShift      = 28
167  };
168
169  /// Target Operand Flag enum.
170  enum TOF {
171    //===------------------------------------------------------------------===//
172    // ARM Specific MachineOperand flags.
173
174    MO_NO_FLAG,
175
176    /// MO_LO16 - On a symbol operand, this represents a relocation containing
177    /// lower 16 bit of the address. Used only via movw instruction.
178    MO_LO16,
179
180    /// MO_HI16 - On a symbol operand, this represents a relocation containing
181    /// higher 16 bit of the address. Used only via movt instruction.
182    MO_HI16
183  };
184}
185
186class ARMBaseInstrInfo : public TargetInstrInfoImpl {
187  const ARMSubtarget& Subtarget;
188protected:
189  // Can be only subclassed.
190  explicit ARMBaseInstrInfo(const ARMSubtarget &STI);
191public:
192  // Return the non-pre/post incrementing version of 'Opc'. Return 0
193  // if there is not such an opcode.
194  virtual unsigned getUnindexedOpcode(unsigned Opc) const =0;
195
196  virtual MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
197                                              MachineBasicBlock::iterator &MBBI,
198                                              LiveVariables *LV) const;
199
200  virtual const ARMBaseRegisterInfo &getRegisterInfo() const =0;
201  const ARMSubtarget &getSubtarget() const { return Subtarget; }
202
203  // Branch analysis.
204  virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
205                             MachineBasicBlock *&FBB,
206                             SmallVectorImpl<MachineOperand> &Cond,
207                             bool AllowModify) const;
208  virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const;
209  virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
210                                MachineBasicBlock *FBB,
211                            const SmallVectorImpl<MachineOperand> &Cond) const;
212
213  virtual
214  bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const;
215
216  // Predication support.
217  bool isPredicated(const MachineInstr *MI) const {
218    int PIdx = MI->findFirstPredOperandIdx();
219    return PIdx != -1 && MI->getOperand(PIdx).getImm() != ARMCC::AL;
220  }
221
222  ARMCC::CondCodes getPredicate(const MachineInstr *MI) const {
223    int PIdx = MI->findFirstPredOperandIdx();
224    return PIdx != -1 ? (ARMCC::CondCodes)MI->getOperand(PIdx).getImm()
225                      : ARMCC::AL;
226  }
227
228  virtual
229  bool PredicateInstruction(MachineInstr *MI,
230                            const SmallVectorImpl<MachineOperand> &Pred) const;
231
232  virtual
233  bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
234                         const SmallVectorImpl<MachineOperand> &Pred2) const;
235
236  virtual bool DefinesPredicate(MachineInstr *MI,
237                                std::vector<MachineOperand> &Pred) const;
238
239  virtual bool isPredicable(MachineInstr *MI) const;
240
241  /// GetInstSize - Returns the size of the specified MachineInstr.
242  ///
243  virtual unsigned GetInstSizeInBytes(const MachineInstr* MI) const;
244
245  /// Return true if the instruction is a register to register move and return
246  /// the source and dest operands and their sub-register indices by reference.
247  virtual bool isMoveInstr(const MachineInstr &MI,
248                           unsigned &SrcReg, unsigned &DstReg,
249                           unsigned &SrcSubIdx, unsigned &DstSubIdx) const;
250
251  virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
252                                       int &FrameIndex) const;
253  virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
254                                      int &FrameIndex) const;
255
256  virtual bool copyRegToReg(MachineBasicBlock &MBB,
257                            MachineBasicBlock::iterator I,
258                            unsigned DestReg, unsigned SrcReg,
259                            const TargetRegisterClass *DestRC,
260                            const TargetRegisterClass *SrcRC,
261                            DebugLoc DL) const;
262
263  virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
264                                   MachineBasicBlock::iterator MBBI,
265                                   unsigned SrcReg, bool isKill, int FrameIndex,
266                                   const TargetRegisterClass *RC,
267                                   const TargetRegisterInfo *TRI) const;
268
269  virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
270                                    MachineBasicBlock::iterator MBBI,
271                                    unsigned DestReg, int FrameIndex,
272                                    const TargetRegisterClass *RC,
273                                    const TargetRegisterInfo *TRI) const;
274
275  virtual MachineInstr *emitFrameIndexDebugValue(MachineFunction &MF,
276                                                 int FrameIx,
277                                                 uint64_t Offset,
278                                                 const MDNode *MDPtr,
279                                                 DebugLoc DL) const;
280
281  virtual bool canFoldMemoryOperand(const MachineInstr *MI,
282                                    const SmallVectorImpl<unsigned> &Ops) const;
283
284  virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
285                                              MachineInstr* MI,
286                                              const SmallVectorImpl<unsigned> &Ops,
287                                              int FrameIndex) const;
288
289  virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
290                                              MachineInstr* MI,
291                                           const SmallVectorImpl<unsigned> &Ops,
292                                              MachineInstr* LoadMI) const;
293
294  virtual void reMaterialize(MachineBasicBlock &MBB,
295                             MachineBasicBlock::iterator MI,
296                             unsigned DestReg, unsigned SubIdx,
297                             const MachineInstr *Orig,
298                             const TargetRegisterInfo *TRI) const;
299
300  MachineInstr *duplicate(MachineInstr *Orig, MachineFunction &MF) const;
301
302  virtual bool produceSameValue(const MachineInstr *MI0,
303                                const MachineInstr *MI1) const;
304};
305
306static inline
307const MachineInstrBuilder &AddDefaultPred(const MachineInstrBuilder &MIB) {
308  return MIB.addImm((int64_t)ARMCC::AL).addReg(0);
309}
310
311static inline
312const MachineInstrBuilder &AddDefaultCC(const MachineInstrBuilder &MIB) {
313  return MIB.addReg(0);
314}
315
316static inline
317const MachineInstrBuilder &AddDefaultT1CC(const MachineInstrBuilder &MIB,
318                                          bool isDead = false) {
319  return MIB.addReg(ARM::CPSR, getDefRegState(true) | getDeadRegState(isDead));
320}
321
322static inline
323const MachineInstrBuilder &AddNoT1CC(const MachineInstrBuilder &MIB) {
324  return MIB.addReg(0);
325}
326
327static inline
328bool isUncondBranchOpcode(int Opc) {
329  return Opc == ARM::B || Opc == ARM::tB || Opc == ARM::t2B;
330}
331
332static inline
333bool isCondBranchOpcode(int Opc) {
334  return Opc == ARM::Bcc || Opc == ARM::tBcc || Opc == ARM::t2Bcc;
335}
336
337static inline
338bool isJumpTableBranchOpcode(int Opc) {
339  return Opc == ARM::BR_JTr || Opc == ARM::BR_JTm || Opc == ARM::BR_JTadd ||
340    Opc == ARM::tBR_JTr || Opc == ARM::t2BR_JT;
341}
342
343static inline
344bool isIndirectBranchOpcode(int Opc) {
345  return Opc == ARM::BRIND || Opc == ARM::MOVPCRX || Opc == ARM::tBRIND;
346}
347
348/// getInstrPredicate - If instruction is predicated, returns its predicate
349/// condition, otherwise returns AL. It also returns the condition code
350/// register by reference.
351ARMCC::CondCodes getInstrPredicate(const MachineInstr *MI, unsigned &PredReg);
352
353int getMatchingCondBranchOpcode(int Opc);
354
355/// emitARMRegPlusImmediate / emitT2RegPlusImmediate - Emits a series of
356/// instructions to materializea destreg = basereg + immediate in ARM / Thumb2
357/// code.
358void emitARMRegPlusImmediate(MachineBasicBlock &MBB,
359                             MachineBasicBlock::iterator &MBBI, DebugLoc dl,
360                             unsigned DestReg, unsigned BaseReg, int NumBytes,
361                             ARMCC::CondCodes Pred, unsigned PredReg,
362                             const ARMBaseInstrInfo &TII);
363
364void emitT2RegPlusImmediate(MachineBasicBlock &MBB,
365                            MachineBasicBlock::iterator &MBBI, DebugLoc dl,
366                            unsigned DestReg, unsigned BaseReg, int NumBytes,
367                            ARMCC::CondCodes Pred, unsigned PredReg,
368                            const ARMBaseInstrInfo &TII);
369
370
371/// rewriteARMFrameIndex / rewriteT2FrameIndex -
372/// Rewrite MI to access 'Offset' bytes from the FP. Return false if the
373/// offset could not be handled directly in MI, and return the left-over
374/// portion by reference.
375bool rewriteARMFrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
376                          unsigned FrameReg, int &Offset,
377                          const ARMBaseInstrInfo &TII);
378
379bool rewriteT2FrameIndex(MachineInstr &MI, unsigned FrameRegIdx,
380                         unsigned FrameReg, int &Offset,
381                         const ARMBaseInstrInfo &TII);
382
383} // End llvm namespace
384
385#endif
386