Move isPredicated from .cpp to .h
[oota-llvm.git] / 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 "llvm/Target/TargetInstrInfo.h"
18 #include "ARMRegisterInfo.h"
19 #include "ARM.h"
20
21 namespace llvm {
22   class ARMSubtarget;
23
24 /// ARMII - This namespace holds all of the target specific flags that
25 /// instruction info tracks.
26 ///
27 namespace 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. Only valid for load
62     // and store ops
63     IndexModeShift = 7,
64     IndexModeMask  = 3 << IndexModeShift,
65     IndexModePre   = 1,
66     IndexModePost  = 2,
67
68     //===------------------------------------------------------------------===//
69     // Instruction encoding formats.
70     //
71     FormShift     = 9,
72     FormMask      = 0x3f << FormShift,
73
74     // Pseudo instructions
75     Pseudo        = 0  << FormShift,
76
77     // Multiply instructions
78     MulFrm        = 1  << FormShift,
79
80     // Branch instructions
81     BrFrm         = 2  << FormShift,
82     BrMiscFrm     = 3  << FormShift,
83
84     // Data Processing instructions
85     DPFrm         = 4  << FormShift,
86     DPSoRegFrm    = 5  << FormShift,
87
88     // Load and Store
89     LdFrm         = 6  << FormShift,
90     StFrm         = 7  << FormShift,
91     LdMiscFrm     = 8  << FormShift,
92     StMiscFrm     = 9  << FormShift,
93     LdStMulFrm    = 10 << FormShift,
94
95     // Miscellaneous arithmetic instructions
96     ArithMiscFrm  = 11 << FormShift,
97
98     // Extend instructions
99     ExtFrm        = 12 << FormShift,
100
101     // VFP formats
102     VFPUnaryFrm   = 13 << FormShift,
103     VFPBinaryFrm  = 14 << FormShift,
104     VFPConv1Frm   = 15 << FormShift,
105     VFPConv2Frm   = 16 << FormShift,
106     VFPConv3Frm   = 17 << FormShift,
107     VFPConv4Frm   = 18 << FormShift,
108     VFPConv5Frm   = 19 << FormShift,
109     VFPLdStFrm    = 20 << FormShift,
110     VFPLdStMulFrm = 21 << FormShift,
111     VFPMiscFrm    = 22 << FormShift,
112
113     // Thumb format
114     ThumbFrm      = 23 << FormShift,
115
116     // NEON format
117     NEONFrm       = 24 << FormShift,
118     NEONGetLnFrm  = 25 << FormShift,
119     NEONSetLnFrm  = 26 << FormShift,
120     NEONDupFrm    = 27 << FormShift,
121
122     //===------------------------------------------------------------------===//
123     // Misc flags.
124
125     // UnaryDP - Indicates this is a unary data processing instruction, i.e.
126     // it doesn't have a Rn operand.
127     UnaryDP       = 1 << 15,
128
129     // Xform16Bit - Indicates this Thumb2 instruction may be transformed into
130     // a 16-bit Thumb instruction if certain conditions are met.
131     Xform16Bit    = 1 << 16,
132
133     //===------------------------------------------------------------------===//
134     // Field shifts - such shifts are used to set field while generating
135     // machine instructions.
136     M_BitShift     = 5,
137     ShiftImmShift  = 5,
138     ShiftShift     = 7,
139     N_BitShift     = 7,
140     ImmHiShift     = 8,
141     SoRotImmShift  = 8,
142     RegRsShift     = 8,
143     ExtRotImmShift = 10,
144     RegRdLoShift   = 12,
145     RegRdShift     = 12,
146     RegRdHiShift   = 16,
147     RegRnShift     = 16,
148     S_BitShift     = 20,
149     W_BitShift     = 21,
150     AM3_I_BitShift = 22,
151     D_BitShift     = 22,
152     U_BitShift     = 23,
153     P_BitShift     = 24,
154     I_BitShift     = 25,
155     CondShift      = 28
156   };
157
158   /// ARMII::Op - Holds all of the instruction types required by
159   /// target specific instruction and register code.  ARMBaseInstrInfo
160   /// and subclasses should return a specific opcode that implements
161   /// the instruction type.
162   ///
163   enum Op {
164     ADDri,
165     ADDrs,
166     ADDrr,
167     B,
168     Bcc,
169     BR_JTr,
170     BR_JTm,
171     BR_JTadd,
172     BX_RET,
173     FCPYS,
174     FCPYD,
175     FLDD,
176     FLDS,
177     FSTD,
178     FSTS,
179     LDR,
180     MOVr,
181     STR,
182     SUBri,
183     SUBrs,
184     SUBrr,
185     VMOVD,
186     VMOVQ
187   };
188 }
189
190 class ARMBaseInstrInfo : public TargetInstrInfoImpl {
191 protected:
192   // Can be only subclassed.
193   explicit ARMBaseInstrInfo(const ARMSubtarget &STI);
194 public:
195   // Return the non-pre/post incrementing version of 'Opc'. Return 0
196   // if there is not such an opcode.
197   virtual unsigned getUnindexedOpcode(unsigned Opc) const =0;
198
199   // Return the opcode that implements 'Op', or 0 if no opcode
200   virtual unsigned getOpcode(ARMII::Op Op) const =0;
201
202   // Return true if the block does not fall through.
203   virtual bool BlockHasNoFallThrough(const MachineBasicBlock &MBB) const =0;
204
205   virtual MachineInstr *convertToThreeAddress(MachineFunction::iterator &MFI,
206                                               MachineBasicBlock::iterator &MBBI,
207                                               LiveVariables *LV) const;
208
209   virtual const ARMBaseRegisterInfo &getRegisterInfo() const =0;
210
211   // Branch analysis.
212   virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
213                              MachineBasicBlock *&FBB,
214                              SmallVectorImpl<MachineOperand> &Cond,
215                              bool AllowModify) const;
216   virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const;
217   virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
218                                 MachineBasicBlock *FBB,
219                             const SmallVectorImpl<MachineOperand> &Cond) const;
220
221   virtual
222   bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const;
223
224   // Predication support.
225   bool isPredicated(const MachineInstr *MI) const {
226     int PIdx = MI->findFirstPredOperandIdx();
227     return PIdx != -1 && MI->getOperand(PIdx).getImm() != ARMCC::AL;
228   }
229
230   ARMCC::CondCodes getPredicate(const MachineInstr *MI) const {
231     int PIdx = MI->findFirstPredOperandIdx();
232     return PIdx != -1 ? (ARMCC::CondCodes)MI->getOperand(PIdx).getImm()
233                       : ARMCC::AL;
234   }
235
236   virtual
237   bool PredicateInstruction(MachineInstr *MI,
238                             const SmallVectorImpl<MachineOperand> &Pred) const;
239
240   virtual
241   bool SubsumesPredicate(const SmallVectorImpl<MachineOperand> &Pred1,
242                          const SmallVectorImpl<MachineOperand> &Pred2) const;
243
244   virtual bool DefinesPredicate(MachineInstr *MI,
245                                 std::vector<MachineOperand> &Pred) const;
246
247   /// GetInstSize - Returns the size of the specified MachineInstr.
248   ///
249   virtual unsigned GetInstSizeInBytes(const MachineInstr* MI) const;
250
251   /// Return true if the instruction is a register to register move and return
252   /// the source and dest operands and their sub-register indices by reference.
253   virtual bool isMoveInstr(const MachineInstr &MI,
254                            unsigned &SrcReg, unsigned &DstReg,
255                            unsigned &SrcSubIdx, unsigned &DstSubIdx) const;
256
257   virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
258                                        int &FrameIndex) const;
259   virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
260                                       int &FrameIndex) const;
261
262   virtual bool copyRegToReg(MachineBasicBlock &MBB,
263                             MachineBasicBlock::iterator I,
264                             unsigned DestReg, unsigned SrcReg,
265                             const TargetRegisterClass *DestRC,
266                             const TargetRegisterClass *SrcRC) const;
267   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
268                                    MachineBasicBlock::iterator MBBI,
269                                    unsigned SrcReg, bool isKill, int FrameIndex,
270                                    const TargetRegisterClass *RC) const;
271
272   virtual void storeRegToAddr(MachineFunction &MF, unsigned SrcReg, bool isKill,
273                               SmallVectorImpl<MachineOperand> &Addr,
274                               const TargetRegisterClass *RC,
275                               SmallVectorImpl<MachineInstr*> &NewMIs) const;
276
277   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
278                                     MachineBasicBlock::iterator MBBI,
279                                     unsigned DestReg, int FrameIndex,
280                                     const TargetRegisterClass *RC) const;
281
282   virtual void loadRegFromAddr(MachineFunction &MF, unsigned DestReg,
283                                SmallVectorImpl<MachineOperand> &Addr,
284                                const TargetRegisterClass *RC,
285                                SmallVectorImpl<MachineInstr*> &NewMIs) const;
286
287   virtual bool canFoldMemoryOperand(const MachineInstr *MI,
288                                     const SmallVectorImpl<unsigned> &Ops) const;
289   
290   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
291                                               MachineInstr* MI,
292                                               const SmallVectorImpl<unsigned> &Ops,
293                                               int FrameIndex) const;
294
295   virtual MachineInstr* foldMemoryOperandImpl(MachineFunction &MF,
296                                               MachineInstr* MI,
297                                               const SmallVectorImpl<unsigned> &Ops,
298                                               MachineInstr* LoadMI) const;
299 };
300 }
301
302 #endif