Since ARM emits inline jump tables as part of the ConstantIsland pass,
[oota-llvm.git] / lib / Target / ARM / ARMISelLowering.h
1 //===-- ARMISelLowering.h - ARM DAG Lowering Interface ----------*- 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 defines the interfaces that ARM uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef ARMISELLOWERING_H
16 #define ARMISELLOWERING_H
17
18 #include "ARMSubtarget.h"
19 #include "llvm/Target/TargetLowering.h"
20 #include "llvm/CodeGen/SelectionDAG.h"
21 #include "llvm/CodeGen/CallingConvLower.h"
22 #include <vector>
23
24 namespace llvm {
25   class ARMConstantPoolValue;
26
27   namespace ARMISD {
28     // ARM Specific DAG Nodes
29     enum NodeType {
30       // Start the numbering where the builtin ops and target ops leave off.
31       FIRST_NUMBER = ISD::BUILTIN_OP_END,
32
33       Wrapper,      // Wrapper - A wrapper node for TargetConstantPool,
34                     // TargetExternalSymbol, and TargetGlobalAddress.
35       WrapperJT,    // WrapperJT - A wrapper node for TargetJumpTable
36
37       CALL,         // Function call.
38       CALL_PRED,    // Function call that's predicable.
39       CALL_NOLINK,  // Function call with branch not branch-and-link.
40       tCALL,        // Thumb function call.
41       BRCOND,       // Conditional branch.
42       BR_JT,        // Jumptable branch.
43       BR2_JT,       // Jumptable branch (2 level - jumptable entry is a jump).
44       RET_FLAG,     // Return with a flag operand.
45
46       PIC_ADD,      // Add with a PC operand and a PIC label.
47
48       CMP,          // ARM compare instructions.
49       CMPZ,         // ARM compare that sets only Z flag.
50       CMPFP,        // ARM VFP compare instruction, sets FPSCR.
51       CMPFPw0,      // ARM VFP compare against zero instruction, sets FPSCR.
52       FMSTAT,       // ARM fmstat instruction.
53       CMOV,         // ARM conditional move instructions.
54       CNEG,         // ARM conditional negate instructions.
55
56       BCC_i64,
57
58       RBIT,         // ARM bitreverse instruction
59
60       FTOSI,        // FP to sint within a FP register.
61       FTOUI,        // FP to uint within a FP register.
62       SITOF,        // sint to FP within a FP register.
63       UITOF,        // uint to FP within a FP register.
64
65       SRL_FLAG,     // V,Flag = srl_flag X -> srl X, 1 + save carry out.
66       SRA_FLAG,     // V,Flag = sra_flag X -> sra X, 1 + save carry out.
67       RRX,          // V = RRX X, Flag     -> srl X, 1 + shift in carry flag.
68
69       VMOVRRD,      // double to two gprs.
70       VMOVDRR,      // Two gprs to double.
71
72       EH_SJLJ_SETJMP,    // SjLj exception handling setjmp.
73       EH_SJLJ_LONGJMP,   // SjLj exception handling longjmp.
74
75       TC_RETURN,    // Tail call return pseudo.
76
77       THREAD_POINTER,
78
79       DYN_ALLOC,    // Dynamic allocation on the stack.
80
81       MEMBARRIER,   // Memory barrier
82       SYNCBARRIER,  // Memory sync barrier
83
84       VCEQ,         // Vector compare equal.
85       VCGE,         // Vector compare greater than or equal.
86       VCGEU,        // Vector compare unsigned greater than or equal.
87       VCGT,         // Vector compare greater than.
88       VCGTU,        // Vector compare unsigned greater than.
89       VTST,         // Vector test bits.
90
91       // Vector shift by immediate:
92       VSHL,         // ...left
93       VSHRs,        // ...right (signed)
94       VSHRu,        // ...right (unsigned)
95       VSHLLs,       // ...left long (signed)
96       VSHLLu,       // ...left long (unsigned)
97       VSHLLi,       // ...left long (with maximum shift count)
98       VSHRN,        // ...right narrow
99
100       // Vector rounding shift by immediate:
101       VRSHRs,       // ...right (signed)
102       VRSHRu,       // ...right (unsigned)
103       VRSHRN,       // ...right narrow
104
105       // Vector saturating shift by immediate:
106       VQSHLs,       // ...left (signed)
107       VQSHLu,       // ...left (unsigned)
108       VQSHLsu,      // ...left (signed to unsigned)
109       VQSHRNs,      // ...right narrow (signed)
110       VQSHRNu,      // ...right narrow (unsigned)
111       VQSHRNsu,     // ...right narrow (signed to unsigned)
112
113       // Vector saturating rounding shift by immediate:
114       VQRSHRNs,     // ...right narrow (signed)
115       VQRSHRNu,     // ...right narrow (unsigned)
116       VQRSHRNsu,    // ...right narrow (signed to unsigned)
117
118       // Vector shift and insert:
119       VSLI,         // ...left
120       VSRI,         // ...right
121
122       // Vector get lane (VMOV scalar to ARM core register)
123       // (These are used for 8- and 16-bit element types only.)
124       VGETLANEu,    // zero-extend vector extract element
125       VGETLANEs,    // sign-extend vector extract element
126
127       // Vector move immediate and move negated immediate:
128       VMOVIMM,
129       VMVNIMM,
130
131       // Vector duplicate:
132       VDUP,
133       VDUPLANE,
134
135       // Vector shuffles:
136       VEXT,         // extract
137       VREV64,       // reverse elements within 64-bit doublewords
138       VREV32,       // reverse elements within 32-bit words
139       VREV16,       // reverse elements within 16-bit halfwords
140       VZIP,         // zip (interleave)
141       VUZP,         // unzip (deinterleave)
142       VTRN,         // transpose
143
144       // Operands of the standard BUILD_VECTOR node are not legalized, which
145       // is fine if BUILD_VECTORs are always lowered to shuffles or other
146       // operations, but for ARM some BUILD_VECTORs are legal as-is and their
147       // operands need to be legalized.  Define an ARM-specific version of
148       // BUILD_VECTOR for this purpose.
149       BUILD_VECTOR,
150
151       // Floating-point max and min:
152       FMAX,
153       FMIN,
154
155       // Bit-field insert
156       BFI
157     };
158   }
159
160   /// Define some predicates that are used for node matching.
161   namespace ARM {
162     /// getVFPf32Imm / getVFPf64Imm - If the given fp immediate can be
163     /// materialized with a VMOV.f32 / VMOV.f64 (i.e. fconsts / fconstd)
164     /// instruction, returns its 8-bit integer representation. Otherwise,
165     /// returns -1.
166     int getVFPf32Imm(const APFloat &FPImm);
167     int getVFPf64Imm(const APFloat &FPImm);
168     bool isBitFieldInvertedMask(unsigned v);
169   }
170
171   //===--------------------------------------------------------------------===//
172   //  ARMTargetLowering - ARM Implementation of the TargetLowering interface
173
174   class ARMTargetLowering : public TargetLowering {
175   public:
176     explicit ARMTargetLowering(TargetMachine &TM);
177
178     virtual unsigned getJumpTableEncoding(void) const;
179
180     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG) const;
181
182     /// ReplaceNodeResults - Replace the results of node with an illegal result
183     /// type with new values built out of custom code.
184     ///
185     virtual void ReplaceNodeResults(SDNode *N, SmallVectorImpl<SDValue>&Results,
186                                     SelectionDAG &DAG) const;
187
188     virtual SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
189
190     virtual const char *getTargetNodeName(unsigned Opcode) const;
191
192     virtual MachineBasicBlock *
193       EmitInstrWithCustomInserter(MachineInstr *MI,
194                                   MachineBasicBlock *MBB) const;
195
196     /// allowsUnalignedMemoryAccesses - Returns true if the target allows
197     /// unaligned memory accesses. of the specified type.
198     /// FIXME: Add getOptimalMemOpType to implement memcpy with NEON?
199     virtual bool allowsUnalignedMemoryAccesses(EVT VT) const;
200
201     /// isLegalAddressingMode - Return true if the addressing mode represented
202     /// by AM is legal for this target, for a load/store of the specified type.
203     virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
204     bool isLegalT2ScaledAddressingMode(const AddrMode &AM, EVT VT) const;
205
206     /// isLegalICmpImmediate - Return true if the specified immediate is legal
207     /// icmp immediate, that is the target has icmp instructions which can
208     /// compare a register against the immediate without having to materialize
209     /// the immediate into a register.
210     virtual bool isLegalICmpImmediate(int64_t Imm) const;
211
212     /// getPreIndexedAddressParts - returns true by value, base pointer and
213     /// offset pointer and addressing mode by reference if the node's address
214     /// can be legally represented as pre-indexed load / store address.
215     virtual bool getPreIndexedAddressParts(SDNode *N, SDValue &Base,
216                                            SDValue &Offset,
217                                            ISD::MemIndexedMode &AM,
218                                            SelectionDAG &DAG) const;
219
220     /// getPostIndexedAddressParts - returns true by value, base pointer and
221     /// offset pointer and addressing mode by reference if this node can be
222     /// combined with a load / store to form a post-indexed load / store.
223     virtual bool getPostIndexedAddressParts(SDNode *N, SDNode *Op,
224                                             SDValue &Base, SDValue &Offset,
225                                             ISD::MemIndexedMode &AM,
226                                             SelectionDAG &DAG) const;
227
228     virtual void computeMaskedBitsForTargetNode(const SDValue Op,
229                                                 const APInt &Mask,
230                                                 APInt &KnownZero,
231                                                 APInt &KnownOne,
232                                                 const SelectionDAG &DAG,
233                                                 unsigned Depth) const;
234
235
236     ConstraintType getConstraintType(const std::string &Constraint) const;
237     std::pair<unsigned, const TargetRegisterClass*>
238       getRegForInlineAsmConstraint(const std::string &Constraint,
239                                    EVT VT) const;
240     std::vector<unsigned>
241     getRegClassForInlineAsmConstraint(const std::string &Constraint,
242                                       EVT VT) const;
243
244     /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
245     /// vector.  If it is invalid, don't add anything to Ops. If hasMemory is
246     /// true it means one of the asm constraint of the inline asm instruction
247     /// being processed is 'm'.
248     virtual void LowerAsmOperandForConstraint(SDValue Op,
249                                               char ConstraintLetter,
250                                               std::vector<SDValue> &Ops,
251                                               SelectionDAG &DAG) const;
252
253     const ARMSubtarget* getSubtarget() const {
254       return Subtarget;
255     }
256
257     /// getRegClassFor - Return the register class that should be used for the
258     /// specified value type.
259     virtual TargetRegisterClass *getRegClassFor(EVT VT) const;
260
261     /// getFunctionAlignment - Return the Log2 alignment of this function.
262     virtual unsigned getFunctionAlignment(const Function *F) const;
263
264     Sched::Preference getSchedulingPreference(SDNode *N) const;
265
266     bool isShuffleMaskLegal(const SmallVectorImpl<int> &M, EVT VT) const;
267     bool isOffsetFoldingLegal(const GlobalAddressSDNode *GA) const;
268
269     /// isFPImmLegal - Returns true if the target can instruction select the
270     /// specified FP immediate natively. If false, the legalizer will
271     /// materialize the FP immediate as a load from a constant pool.
272     virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const;
273
274   private:
275     /// Subtarget - Keep a pointer to the ARMSubtarget around so that we can
276     /// make the right decision when generating code for different targets.
277     const ARMSubtarget *Subtarget;
278
279     /// ARMPCLabelIndex - Keep track of the number of ARM PC labels created.
280     ///
281     unsigned ARMPCLabelIndex;
282
283     void addTypeForNEON(EVT VT, EVT PromotedLdStVT, EVT PromotedBitwiseVT);
284     void addDRTypeForNEON(EVT VT);
285     void addQRTypeForNEON(EVT VT);
286
287     typedef SmallVector<std::pair<unsigned, SDValue>, 8> RegsToPassVector;
288     void PassF64ArgInRegs(DebugLoc dl, SelectionDAG &DAG,
289                           SDValue Chain, SDValue &Arg,
290                           RegsToPassVector &RegsToPass,
291                           CCValAssign &VA, CCValAssign &NextVA,
292                           SDValue &StackPtr,
293                           SmallVector<SDValue, 8> &MemOpChains,
294                           ISD::ArgFlagsTy Flags) const;
295     SDValue GetF64FormalArgument(CCValAssign &VA, CCValAssign &NextVA,
296                                  SDValue &Root, SelectionDAG &DAG,
297                                  DebugLoc dl) const;
298
299     CCAssignFn *CCAssignFnForNode(CallingConv::ID CC, bool Return,
300                                   bool isVarArg) const;
301     SDValue LowerMemOpCallTo(SDValue Chain, SDValue StackPtr, SDValue Arg,
302                              DebugLoc dl, SelectionDAG &DAG,
303                              const CCValAssign &VA,
304                              ISD::ArgFlagsTy Flags) const;
305     SDValue LowerEH_SJLJ_SETJMP(SDValue Op, SelectionDAG &DAG) const;
306     SDValue LowerEH_SJLJ_LONGJMP(SDValue Op, SelectionDAG &DAG) const;
307     SDValue LowerINTRINSIC_WO_CHAIN(SDValue Op, SelectionDAG &DAG,
308                                     const ARMSubtarget *Subtarget) const;
309     SDValue LowerBlockAddress(SDValue Op, SelectionDAG &DAG) const;
310     SDValue LowerGlobalAddressDarwin(SDValue Op, SelectionDAG &DAG) const;
311     SDValue LowerGlobalAddressELF(SDValue Op, SelectionDAG &DAG) const;
312     SDValue LowerGlobalTLSAddress(SDValue Op, SelectionDAG &DAG) const;
313     SDValue LowerToTLSGeneralDynamicModel(GlobalAddressSDNode *GA,
314                                             SelectionDAG &DAG) const;
315     SDValue LowerToTLSExecModels(GlobalAddressSDNode *GA,
316                                    SelectionDAG &DAG) const;
317     SDValue LowerGLOBAL_OFFSET_TABLE(SDValue Op, SelectionDAG &DAG) const;
318     SDValue LowerBR_JT(SDValue Op, SelectionDAG &DAG) const;
319     SDValue LowerSELECT_CC(SDValue Op, SelectionDAG &DAG) const;
320     SDValue LowerBR_CC(SDValue Op, SelectionDAG &DAG) const;
321     SDValue LowerFCOPYSIGN(SDValue Op, SelectionDAG &DAG) const;
322     SDValue LowerRETURNADDR(SDValue Op, SelectionDAG &DAG) const;
323     SDValue LowerFRAMEADDR(SDValue Op, SelectionDAG &DAG) const;
324     SDValue LowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG) const;
325     SDValue LowerShiftRightParts(SDValue Op, SelectionDAG &DAG) const;
326     SDValue LowerShiftLeftParts(SDValue Op, SelectionDAG &DAG) const;
327
328     SDValue LowerCallResult(SDValue Chain, SDValue InFlag,
329                             CallingConv::ID CallConv, bool isVarArg,
330                             const SmallVectorImpl<ISD::InputArg> &Ins,
331                             DebugLoc dl, SelectionDAG &DAG,
332                             SmallVectorImpl<SDValue> &InVals) const;
333
334     virtual SDValue
335       LowerFormalArguments(SDValue Chain,
336                            CallingConv::ID CallConv, bool isVarArg,
337                            const SmallVectorImpl<ISD::InputArg> &Ins,
338                            DebugLoc dl, SelectionDAG &DAG,
339                            SmallVectorImpl<SDValue> &InVals) const;
340
341     virtual SDValue
342       LowerCall(SDValue Chain, SDValue Callee,
343                 CallingConv::ID CallConv, bool isVarArg,
344                 bool &isTailCall,
345                 const SmallVectorImpl<ISD::OutputArg> &Outs,
346                 const SmallVectorImpl<SDValue> &OutVals,
347                 const SmallVectorImpl<ISD::InputArg> &Ins,
348                 DebugLoc dl, SelectionDAG &DAG,
349                 SmallVectorImpl<SDValue> &InVals) const;
350
351     /// IsEligibleForTailCallOptimization - Check whether the call is eligible
352     /// for tail call optimization. Targets which want to do tail call
353     /// optimization should implement this function.
354     bool IsEligibleForTailCallOptimization(SDValue Callee,
355                                            CallingConv::ID CalleeCC,
356                                            bool isVarArg,
357                                            bool isCalleeStructRet,
358                                            bool isCallerStructRet,
359                                     const SmallVectorImpl<ISD::OutputArg> &Outs,
360                                     const SmallVectorImpl<SDValue> &OutVals,
361                                     const SmallVectorImpl<ISD::InputArg> &Ins,
362                                            SelectionDAG& DAG) const;
363     virtual SDValue
364       LowerReturn(SDValue Chain,
365                   CallingConv::ID CallConv, bool isVarArg,
366                   const SmallVectorImpl<ISD::OutputArg> &Outs,
367                   const SmallVectorImpl<SDValue> &OutVals,
368                   DebugLoc dl, SelectionDAG &DAG) const;
369
370     SDValue getARMCmp(SDValue LHS, SDValue RHS, ISD::CondCode CC,
371                       SDValue &ARMcc, SelectionDAG &DAG, DebugLoc dl) const;
372     SDValue getVFPCmp(SDValue LHS, SDValue RHS,
373                       SelectionDAG &DAG, DebugLoc dl) const;
374
375     SDValue OptimizeVFPBrcond(SDValue Op, SelectionDAG &DAG) const;
376
377     MachineBasicBlock *EmitAtomicCmpSwap(MachineInstr *MI,
378                                          MachineBasicBlock *BB,
379                                          unsigned Size) const;
380     MachineBasicBlock *EmitAtomicBinary(MachineInstr *MI,
381                                         MachineBasicBlock *BB,
382                                         unsigned Size,
383                                         unsigned BinOpcode) const;
384
385   };
386 }
387
388 #endif  // ARMISELLOWERING_H