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